Re: [PATCH libnetfilter_queue] build: doc: "make" builds & installs a full set of man pages

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

 



Hi Florian,

On Sun, Feb 23, 2020 at 11:54:19PM +0100, Florian Westphal wrote:
> Pablo Neira Ayuso <pablo@xxxxxxxxxxxxx> wrote:
> > On Sun, Feb 23, 2020 at 11:35:14PM +0100, Florian Westphal wrote:
> > > Pablo Neira Ayuso <pablo@xxxxxxxxxxxxx> wrote:
> > > > On Sat, Feb 08, 2020 at 12:28:44PM +1100, Duncan Roe wrote:
> > > > > This enables one to enter "man <any nfq function>" and get the appropriate
> > > > > group man page created by doxygen.
> > > > > 
> > > > >  - New makefile in doxygen directory. Rebuilds documentation if any sources
> > > > >    change that contain doxygen comments, or if fixmanpages.sh changes
> > > > >  - New shell script fixmanpages.sh which
> > > > >    - Renames each group man page to the first function listed therein
> > > > >    - Creates symlinks for subsequently listed functions (if any)
> > > > >    - Deletes _* temp files
> > > > >  - Update top-level makefile to visit new subdir doxygen
> > > > >  - Update top-level configure to only build documentation if doxygen installed
> > > > 
> > > > I'd prefer people to keep this infrastructure out of tree. Thanks.
> > > 
> > > Hmm, why?
> > 
> > Would you like to allow to generate manpage per function in the
> > library? We never had this so far.
> > 
> > Probably a single manpage in the style of libnftables(3)?
> 
> I like it.  I mean, its up to distros to package this, I guess
> most of them will place this into some extra doc sub-package.
> 
> $ man 3 ssl-<tab>
> zsh: do you wish to see all 416 possibilities (70 lines)?
> 
> ... so there are libraries that do this.
> Also, from what I understand, there is not a single man-page per
> function, the extra ones are just aliases.

I was not familiar with this fine-grain manpage approach, thanks for
explaining.

Please, go ahead and apply this patch.

Thanks.



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

  Powered by Linux