[PATCH v4] doc: build manpages as well as html output
Thomas Monjalon
thomas at monjalon.net
Thu Aug 31 12:12:15 CEST 2023
31/08/2023 11:49, Bruce Richardson:
> Doxygen can produce manpage output as well as html output for the DPDK
> APIs. However, we need to do this as a separate task as the manpage
> output needs to be placed in a different location post-install to the
> html output (/usr/local/share/man vs /usr/local/share/doc/).
>
> Changes required are:
> * Add configurable options for manpage output and html output to the
> doxygen config template. (Remove option for html output path as it's
> always "html")
> * Modify API meson.build file to configure two separate doxygen config
> files, for HTML and manpages respectively.
> * Change doxygen wrapper script to have separate output log files for
> the manpage and HTML jobs, to avoid conflicts
> * Add "custom_targets" to meson.build file to build the HTML pages and
> the manpages, with individual install locations for each.
> * Where supported by meson version, call "mandb" post-install to update
> the man database to ensure the new manpages can be found. If the
> manpages are not installed in system location i.e. one not in MANPATH,
> then this update will have no effect, as only system locations are
> scanned.
>
> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> Reviewed-by: David Marchand <david.marchand at redhat.com>
Acked-by: Thomas Monjalon <thomas at monjalon.net>
More information about the dev
mailing list