Re: [PATCH RFC libnetfilter_queue 1/1] src: doc: supply missing SYNOPSIS in pktbuff man pages

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


On Sat, Jul 24, 2021 at 10:56:33AM +0200, Pablo Neira Ayuso wrote:
> On Sat, Jul 24, 2021 at 01:49:41PM +1000, Duncan Roe wrote:
> > On Thu, Jul 22, 2021 at 07:10:15PM +0200, Pablo Neira Ayuso wrote:
> > > The existing autogenerated manpages are still a bit distant to usual
> > > Linux Programmer's Manual manpages at quick glance.
> >
> > I guess doxygen-generated man pages will always be a little bit "distinctive".
> >
> > Looking carefully, I see a number of doxygen artefacts that can be
> > post-processed away.
> I mean: If you can achieve this via standard features available in
> doxygen to keep this maintainable along time, such as \manonly or
> such, then that's good.
> Otherwise, extending doxygen should be the way to keep it simple.
> I understand doxygen might generate a little but "distintive" output,
> that's OK. I'd rather not to add more dependencies on this.
> Thanks.

Fine with not adding more dependencies.

Using only standard shell tools, I went ahead with post-processing man pages
because there are no standard features available in doxygen to do what I wanted.

I've attached a sample of what I hope you'll see on applying my 2 new patches
"Insert SYNOPSIS sections for man pages" and "Fix NAME entry in man pages".
The sample was made by doxygen-1.9.1, earlier versions e.g. doxygen-
generate a few extra blank lines.

To view, save attachment and in another window `man ./pktb_alloc.3.gz`.

Cheers ... Duncan.

Attachment: pktb_alloc.3.gz
Description: application/gunzip

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

  Powered by Linux