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 Wed, Jun 23, 2021 at 07:26:21PM +0200, Pablo Neira Ayuso wrote:

[...]
>
> 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.

I'm fine with *html* being optional:

  --enable-html      build HTML documentation [default=no]

ATM `make install` doesn't do anything with the html dir. With --enable-html, I
guess it should install html/ where --htmldir points [DOCDIR].

But I think not having man pages in the past was a serious deficiency which we
can now address.

Think of it from a (Linux) Distributor's point of view. Man pages take up very
little space in the distribution medium: symlinks are removed and the remaining
pages compressed. Man pages stay compressed on installation and the symlinks are
re-created by the postinstall script (and now as .gz or whatever files).

Typical end-users of the distribution won't have source, so the *need*
documentation.

Personally I'm happy if the build depends on doxygen and fails if it's not
installed.

If you inmsist on only printing a warning when doxygen is not installed then in
that event .configure could output:

> libmnl configuration:
>   doxygen:          no
> man pages:          no

with no "man pages" line when doxygen is installed.

What do you think?

Cheers ... Duncan.



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

  Powered by Linux