Horton

Re: meson documentation build open issues

Andres Freund <andres@anarazel.de>

View thread View on postgr.es
From: Andres Freund <andres@anarazel.de>
To: pgsql-hackers@lists.postgresql.org, Peter Eisentraut <peter@eisentraut.org>, Christoph Berg <myon@debian.org>, Andrew Dunstan <andrew@dunslane.net>, Tom Lane <tgl@sss.pgh.pa.us>, pgsql-hackers <pgsql-hackers@postgresql.org>
Date: 2023-11-07T16:08:29Z
Lists: pgsql-hackers 
Hi, 

On November 7, 2023 7:55:37 AM PST, Peter Eisentraut <peter@eisentraut.org> wrote:
>On 03.11.23 19:19, Christoph Berg wrote:
>>>>> You can control this with the "docs" option for meson, as of recently.
>>>> I've been looking into switching the Debian PG 17 build to meson, but
>>>> I'm running into several problems.
>>>> 
>>>> * The docs are still not built by default, and -Ddocs=enabled doesn't
>>>>    change that
>>> Maybe I am missing something - they aren't built by default in autoconf
>>> either?
>> True, but the documentation (and this thread) reads like it should. Or
>> at least it should, when I explicitly say -Ddocs=enabled.
>> 
>> What would also help is when the tail of the meson output had a list
>> of features that are enabled. There's the list of "External libraries"
>> which is quite helpful at figuring out what's still missing, but
>> perhaps this could be extended:
>> 
>>    Features
>>      LLVM     : YES (/usr/bin/llvm-config-16)
>>      DOCS     : YES (html pdf texinfo)
>> 
>> Atm it's hidden in the long initial blurb of "Checking for.." and the
>> "NO" in there don't really stand out as much, since some of them are
>> normal.
>
>I don't feel like we have fully worked out how the docs options should fit together.
>
>With the make build system, there is a canonical sequence of
>
>make world
>make check-world
>make install-world
>
>that encompasses everything.
>
>Now with meson to handle the documentation one needs to remember a variety of additional targets.  (There is a risk that once this gets more widespread, more people will submit broken documentation.)

install-world with meson also installs docs.


>I would like to have some set of options that enables it so that the standard documentation targets become part of "meson compile" and "meson install".

-0.5 - it's just too painfully slow. For all scripted uses you can just as well use install-world...

Andres
-- 
Sent from my Android device with K-9 Mail. Please excuse my brevity.

Commits

  1. docs: meson: Change what 'docs' target builds

  2. meson: Add 'world' target

  3. meson: Document build targets, add 'help' target

  4. meson: docs: Add {html,man} targets, rename install-doc-*

  5. docs: Document --with-selinux/-Dselinux options centrally

  6. meson: Change default of 'selinux' feature option to auto

  7. meson: Fix doc installation path computation

  8. meson: Install missing example files

  9. meson: docs: Install all manpages, not just ones in man1

  10. meson: docs: Allow configuring simple/website style

  11. docs: html: load stylesheet via custom.css.source

  12. docs: html: copy images to output as part of xslt build

  13. meson: docs: Preparatory cleanups

  14. docs: Remove support for 'htmlhelp' format

  15. meson: add install-{docs,doc-html,doc-man} targets

  16. meson: add install-{quiet, world} targets

  17. meson: make install_test_files more generic, rename to install_files

  18. meson: rename html_help target to htmlhelp