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 29, 2021 at 11:38:37AM +0200, Pablo Neira Ayuso wrote:
> On Sun, Jun 27, 2021 at 02:30:55PM +1000, Duncan Roe wrote:
> > 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).
>
> We are not Linux distributors, it's up to them to decide what they are
> shipping in their packages, this debate is out of our scope. Assuming
> that enabling this by default will not make them include this.

Not sure about that. It seems to me, most distros build the default
configuration and remove stuff. F.I. if there is a "-devel" package variant then
the base package will have neither man pages nor header files. Yet we always
distribute header files. Man pages are a little bigger, but less than twice the
size of headers for libmnl & libnfq (i.e. compressed pages with symlinks).
>
> Most users rely on libmnl because they use some utility that pulls in
> this dependency, most of them are not developers.

So they won't install the -devel package.

[...]

Will address your other points in a future email,

Cheers ... Duncan.



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

  Powered by Linux