All of lore.kernel.org
 help / color / mirror / Atom feed
From: Florian Westphal <fw@strlen.de>
To: Pablo Neira Ayuso <pablo@netfilter.org>, g@breakpoint.cc
Cc: Florian Westphal <fw@strlen.de>,
	Duncan Roe <duncan_roe@optusnet.com.au>,
	netfilter-devel@vger.kernel.org
Subject: Re: [PATCH libnetfilter_queue] build: doc: "make" builds & installs a full set of man pages
Date: Sun, 23 Feb 2020 23:54:19 +0100	[thread overview]
Message-ID: <20200223225419.GB19559@breakpoint.cc> (raw)
In-Reply-To: <20200223223706.543ya6xumtuk3l7b@salvia>

Pablo Neira Ayuso <pablo@netfilter.org> wrote:
> On Sun, Feb 23, 2020 at 11:35:14PM +0100, Florian Westphal wrote:
> > Pablo Neira Ayuso <pablo@netfilter.org> 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.

  reply	other threads:[~2020-02-23 22:54 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-08  1:28 [PATCH libnetfilter_queue] build: doc: "make" builds & installs a full set of man pages Duncan Roe
2020-02-23 22:27 ` Pablo Neira Ayuso
2020-02-23 22:35   ` Florian Westphal
2020-02-23 22:37     ` Pablo Neira Ayuso
2020-02-23 22:54       ` Florian Westphal [this message]
2020-02-23 23:15         ` Pablo Neira Ayuso

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=20200223225419.GB19559@breakpoint.cc \
    --to=fw@strlen.de \
    --cc=duncan_roe@optusnet.com.au \
    --cc=g@breakpoint.cc \
    --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.