From: Pablo Neira Ayuso <pablo@netfilter.org>
To: Duncan Roe <duncan_roe@optusnet.com.au>
Cc: netfilter-devel@vger.kernel.org
Subject: Re: [PATCH libmnl 1/1] build: doc: "make" builds & installs a full set of man pages
Date: Wed, 23 Jun 2021 19:26:21 +0200 [thread overview]
Message-ID: <20210623172621.GA25266@salvia> (raw)
In-Reply-To: <20210622041933.25654-2-duncan_roe@optusnet.com.au>
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.
next prev parent reply other threads:[~2021-06-23 17:26 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-22 4:19 [PATCH libmnl 0/1] build: doc: "make" builds & installs a full set of man pages Duncan Roe
2021-06-22 4:19 ` [PATCH libmnl 1/1] " Duncan Roe
2021-06-23 17:26 ` Pablo Neira Ayuso [this message]
2021-06-27 4:30 ` Duncan Roe
2021-06-27 4:42 ` Duncan Roe
2021-06-29 9:38 ` Pablo Neira Ayuso
2021-07-02 4:16 ` Duncan Roe
2021-07-07 2:19 ` Duncan Roe
2021-07-17 2:53 ` Duncan Roe
2021-07-17 2:53 ` [PATCH RFC libnetfilter_queue 1/1] src: doc: supply missing SYNOPSIS in pktbuff " Duncan Roe
2021-07-22 17:10 ` Pablo Neira Ayuso
2021-07-24 3:49 ` Duncan Roe
2021-07-24 8:56 ` Pablo Neira Ayuso
2021-08-09 8:22 ` Duncan Roe
2021-08-09 8:32 ` Duncan Roe
2021-07-17 3:27 ` [PATCH libmnl 1/1] build: doc: "make" builds & installs a full set of " Duncan Roe
2021-07-17 5:47 ` Duncan Roe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210623172621.GA25266@salvia \
--to=pablo@netfilter.org \
--cc=duncan_roe@optusnet.com.au \
--cc=netfilter-devel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).