Re: [PATCH libmnl 1/1] build: doc: "make" builds & installs a full set of man pages

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Jun 22, 2021 at 02:19:33PM +1000, Duncan Roe wrote:
> Repeat what we did for libnetfilter_queue:
>  - New makefile in doxygen directory. Rebuilds documentation if any sources
>    change that contain doxygen comments:
>    - Renames each group man page to the first function listed therein
>    - Creates symlinks for subsequently listed functions
>    - Deletes _* temp files and moves sctruct-describing man pages to man7
>  - Update top-level makefile to visit new subdir doxygen
>  - Update top-level configure to only build documentation if doxygen installed
>  - Add --with/without-doxygen switch
>  - Check whether dot is available when configuring doxygen
>  - Reduce size of doxygen.cfg and doxygen build o/p
>  - `make distcheck` passes with doxygen enabled
> Aditionally, exclude opaque structs mnl_nlmsg_batch & mnl_socket

Applied, thanks.

One thing that needs a fix (both libnetfilter_queue and libmnl).

If doxygen is not installed...

configure: WARNING: Doxygen not found - continuing without Doxygen support

it warns that it is missing...

checking that generated files are newer than configure... done
configure: creating ./config.status
config.status: creating Makefile
config.status: creating src/Makefile
config.status: creating include/Makefile
config.status: creating include/libmnl/Makefile
config.status: creating include/linux/Makefile
config.status: creating include/linux/netfilter/Makefile
config.status: creating examples/Makefile
config.status: creating examples/genl/Makefile
config.status: creating examples/kobject/Makefile
config.status: creating examples/netfilter/Makefile
config.status: creating examples/rtnl/Makefile
config.status: creating libmnl.pc
config.status: creating doxygen.cfg
config.status: creating doxygen/Makefile
config.status: creating config.h
config.status: config.h is unchanged
config.status: executing depfiles commands
config.status: executing libtool commands

libmnl configuration:
  doxygen:          yes

but it says yes here.

I'd prefer if documentation is not enabled by default, ie. users have
to explicitly specify --with-doxygen=yes to build documentation, so
users explicitly picks what they needs.

Please, follow up with a few patches, thanks.



[Index of Archives]     [Netfitler Users]     [Berkeley Packet Filter]     [LARTC]     [Bugtraq]     [Yosemite Forum]

  Powered by Linux