On Tue, Aug 29, 2023 at 11:28:01AM +0200, Thomas Monjalon wrote:
> 3/08/2023, Bruce Richardson:
> > +#set up common doxygen configuration
>
> A space is missing here
>
Ack
> > +man_cdata.set('FULL_PATH_NAMES', 'NO')
>
> Why it has to be disabled? Maybe add a comment?
>
Sure, will add comment. It's so that the man pages don't include
full paths to the headers, but are just e.g. "rte_eal.h".
> > + meson.add_install_script(mandb)
>
> When is it executed exactly?
> Will it update the database in case we install in a staging directory,
> when preparing a package for later deploying on another machine?
Yes, it will. Unfortunately, I can't find any way to just call mandb if we
are installing in a system manpage location on the local machine. Therefore,
I had two options:
1. don't update the manpage database. In this case, the user won't be able to
actually get the newly install manpages
2. always update the local manpage database. In this case, the user
installing the docs will find them, but anyone installing to staging will
experience a slight delay while their local mandb is updated.
I went for #2 on the basis that the delay in the staging case is pretty
harmless, while not actually finding the manpages is more serious.
However, I'm open to other suggestions on how to work this?
>
> > +.. code-block:: console
> > +
> > + export MANPATH=:/path/to/build/doc/api/man
>
> Styling consideration: I think we should indent with 3 spaces
> so it is aligned with "code-block".
>
Ack.
