From: Duncan Roe <duncan_roe@optusnet.com.au>
To: Pablo Neira Ayuso <pablo@netfilter.org>
Cc: Netfilter Development <netfilter-devel@vger.kernel.org>
Subject: Re: [PATCH libnetfilter_queue v2] build: doc: Fix NAME entry in man pages
Date: Mon, 16 Aug 2021 14:22:55 +1000 [thread overview]
Message-ID: <YRnoH6nkSh8HI5lT@slk1.local.net> (raw)
In-Reply-To: <20210815121509.GA9606@salvia>
On Sun, Aug 15, 2021 at 02:15:09PM +0200, Pablo Neira Ayuso wrote:
> On Tue, Aug 10, 2021 at 12:40:01PM +1000, Duncan Roe wrote:
> > Make the NAME line list the functions defined, like other man pages do.
> > Also:
> > - If there is a "Modules" section, delete it
> > - If "Detailed Description" is empty, delete "Detailed Description" line
> > - Reposition SYNOPSIS (with headers that we inserted) to start of page,
> > integrating with defined functions to look like other man pages
> > - Delete all "Definition at line nnn" lines
> > - Delete lines that make older versions of man o/p an unwanted blank line
> > - Insert spacers and comments so Makefile.am is more readable
> >
> > Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au>
> > ---
> > v2: Delete lines that make older versions of man o/p an unwanted blank line
> > doxygen/Makefile.am | 172 ++++++++++++++++++++++++++++++++++++++++++++
>
> Time to add this to an independent fixup shell script for
> doxygen-based manpages that Makefile.am could call instead?
>
> This script could be imported by other libraries too, so it only needs to
> be downloaded from somewhere to be refreshed to keep it in sync with
> latest.
>
> The git tree could cache a copy of this script.
>
> Could you have a look into this?
>
> Thanks.
At the moment, libmnl and libnetfilter_queue share an identical
doxygen/Makefile.am.
So, you could declare libnetfilter_queue to be the master and copy from there.
The files' staying identical will depend at least on configure.ac in other libs
tracking libnfq. Currently configure.ac supplies HAVE_DOXYGEN but I am working
on a patch where there will also be BUILD_HTML and BUILD_MAN.
I had to move fixmanpages.sh inside Makefile.am to get `make distcheck` to
pass. So I'll need to be careful about introducing new files (e.g. to include).
Will keep investigating,
Cheers ... Duncan.
next prev parent reply other threads:[~2021-08-16 4:23 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-10 2:40 [PATCH libnetfilter_queue v2] build: doc: Fix NAME entry in man pages Duncan Roe
2021-08-15 12:15 ` Pablo Neira Ayuso
2021-08-16 4:22 ` Duncan Roe [this message]
2021-08-24 1:43 ` Duncan Roe
2021-08-27 20:01 ` Duncan Roe
2021-08-28 9:23 ` Pablo Neira Ayuso
2021-08-28 9:43 ` Pablo Neira Ayuso
2021-09-01 3:23 ` Duncan Roe
2021-09-01 3:50 ` 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=YRnoH6nkSh8HI5lT@slk1.local.net \
--to=duncan_roe@optusnet.com.au \
--cc=netfilter-devel@vger.kernel.org \
--cc=pablo@netfilter.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.