Re: what should install-world do when docs are not available?

From: Justin Pryzby <pryzby(at)telsasoft(dot)com>
To: Andres Freund <andres(at)anarazel(dot)de>
Cc: Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>, pgsql-hackers(at)postgresql(dot)org
Subject: Re: what should install-world do when docs are not available?
Date: 2023-03-29 22:51:01
Message-ID: ZCTA1Tu+3vRUGUBU@telsasoft.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> + Enables the building of documentation in <acronym>HTML</acronym> and
> + <acronym>man</acronym> format. It defaults to auto.
> +
> + Enables the building of documentation in <acronym>PDF</acronym>
> + format. It defaults to auto.

These sound awkward. Recommend:

Enables building the documentation in <acronym>PDF</acronym>
format. It defaults to auto.

> + <varlistentry id="configure-docs-html-style">
> + <term><option>-Ddocs_html_style={ simple | website }</option></term>
> + <listitem>
> + <para>
> + Influences which <acronym>CSS</acronym> stylesheet is used. If
> + <literal>website</literal>, instead of the default
> + <literal>simple</literal>, is used, HTML documentation will use the
> + stylesheet used on <ulink
> + url="https://www.postgresql.org/docs/current/">postgresql.org</ulink>.

s/Influences/Controls/

I think the default should be given separately from the description of
the other option.

Controls which <acronym>CSS</acronym> stylesheet is used.
The default is <literal>simple</literal>.
If set to <literal>website</literal>, the HTML documentation will use the
same stylesheet used on <ulink
url="https://www.postgresql.org/docs/current/">postgresql.org</ulink>.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Yurii Rashkovskii 2023-03-29 23:37:48 Re: [PATCH] Allow Postgres to pick an unused port to listen
Previous Message Andres Freund 2023-03-29 22:41:32 Re: what should install-world do when docs are not available?