Re: what should install-world do when docs are not available? - Mailing list pgsql-hackers

From Andres Freund
Subject Re: what should install-world do when docs are not available?
Date
Msg-id 20230405044611.kmnqndcrjjedtwtm@awork3.anarazel.de
Whole thread Raw
In response to Re: what should install-world do when docs are not available?  (Justin Pryzby <pryzby@telsasoft.com>)
Responses Re: what should install-world do when docs are not available?  (Andres Freund <andres@anarazel.de>)
List 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



pgsql-hackers by date:

Previous
From: Pavel Stehule
Date:
Subject: Re: proposal: psql: show current user in prompt
Next
From: Andres Freund
Date:
Subject: Re: what should install-world do when docs are not available?