Feedback-ID: ie0a040ee:Fastmail
Message-ID: <13ffaa6d-37fc-4e8e-83b8-caea2b7b388f@eisentraut.org>
Date: Thu, 9 Nov 2023 15:39:32 +0100
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: meson documentation build open issues
Content-Language: en-US
To: Andres Freund <andres@anarazel.de>, Christoph Berg <myon@debian.org>,
 Andrew Dunstan <andrew@dunslane.net>, Tom Lane <tgl@sss.pgh.pa.us>,
 pgsql-hackers <pgsql-hackers@postgresql.org>
References: <c3e12a10-5824-f9c7-ad09-c66720df7b2d@dunslane.net>
 <b2437a6f-b083-5abe-6bdf-f5968a666992@enterprisedb.com>
 <ZUUC_T52xTbaXRys@msg.df7cb.de>
 <20231103163848.26egkh5qdgw3vmil@awork3.anarazel.de>
 <ZUU5pRQO6ZUeBsi6@msg.df7cb.de>
 <20231103185344.zhfzturwdbp4d4s5@awork3.anarazel.de>
 <ZUVHttJNHalXcUNx@msg.df7cb.de>
 <20231103211601.bgqx3cfq6pz2lmjw@awork3.anarazel.de>
 <ZUi1ty-o4dihr3oa@msg.df7cb.de>
 <20231107170011.vv4dnzshl7m5rcya@awork3.anarazel.de>
 <20231108232121.ww542mt6lfo6f26f@awork3.anarazel.de>
From: Peter Eisentraut <peter@eisentraut.org>
In-Reply-To: <20231108232121.ww542mt6lfo6f26f@awork3.anarazel.de>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Archived-At: 
 <https://www.postgresql.org/message-id/13ffaa6d-37fc-4e8e-83b8-caea2b7b388f%40eisentraut.org>
Precedence: bulk

On 09.11.23 00:21, Andres Freund wrote:
> Example output:

This is very nice!

> $ ninja help
> [0/1 1   0%] Running external command help (wrapped by meson to set env)
> Code Targets:
>    all                          Build everything other than documentation
>    backend                      Build backend and related modules
>    bin                          Build frontend binaries
>    contrib                      Build contrib modules
>    pl                           Build procedual languages

ok

> Documentation Targets:
>    docs                         Build documentation in multi-page HTML format
>    doc-html                     Build documentation in multi-page HTML format
>    doc-man                      Build documentation in man page format
>    doc/src/sgml/postgres-A4.pdf Build documentation in PDF format, with A4 pages
>    doc/src/sgml/postgres-US.pdf Build documentation in PDF format, with US letter pages
>    doc/src/sgml/postgres.html   Build documentation in single-page HTML format
>    alldocs                      Build documentation in all supported formats
> 
> Installation Targets:
>    install                      Install postgres, excluding documentation

This should probably read "Install everything other than documentation", 
to mirror "all" above.  (Otherwise one might think it installs just the 
backend.)

>    install-doc-html             Install documentation in multi-page HTML format
>    install-doc-man              Install documentation in man page format
>    install-docs                 Install documentation in multi-page HTML and man page formats

There is a mismatch between "docs" and "install-docs".  (As was 
previously discussed, I'm in the camp that "docs" should be html + man.)

>    install-quiet                Like "install", but installed files are not displayed
>    install-world                Install postgres, including multi-page HTML and man page documentation

Suggest "Install everything, including documentation" (matches "world").

>    uninstall                    Remove installed files
> 
> Other Targets:
>    clean                        Remove all build products
>    test                         Run all enabled tests (including contrib)
>    world                        Build everything, including documentation

Shouldn't that be under "Code Targets"?

>    help                         List important targets