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

From: Andres Freund <andres(at)anarazel(dot)de>
To: Justin Pryzby <pryzby(at)telsasoft(dot)com>
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-04-05 04:46:11
Message-ID: 20230405044611.kmnqndcrjjedtwtm@awork3.anarazel.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

On 2023-03-29 17:51:01 -0500, Justin Pryzby wrote:
> > + 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>.

Your alternatives are indeed better. Except that "the same" seems a bit
misleading to me, sounding like it could just be a copy. I changed to "will
reference the stylesheet for ...".

Pushed the changes.

Greetings,

Andres Freund

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Andres Freund 2023-04-05 04:57:32 Re: what should install-world do when docs are not available?
Previous Message Pavel Stehule 2023-04-05 04:43:16 Re: proposal: psql: show current user in prompt