Re: [PATCH libnetfilter_queue v2] build: doc: Fix NAME entry in man pages

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

 



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@xxxxxxxxxxxxxxx>
> > ---
> > 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.



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

  Powered by Linux