netfilter-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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 libmnl 1/1] build: doc: "make" builds & installs a full set of man pages
Date: Sat, 17 Jul 2021 13:27:29 +1000	[thread overview]
Message-ID: <YPJOIYVbWCYFB2eW@slk1.local.net> (raw)
In-Reply-To: <20210629093837.GA23185@salvia>

Hi Pablo,

On Tue, Jun 29, 2021 at 11:38:37AM +0200, Pablo Neira Ayuso wrote:
> > On Wed, Jun 23, 2021 at 07:26:21PM +0200, Pablo Neira Ayuso wrote:
> > >
[...]
> > > I'd prefer if documentation is not enabled by default, ie. users have
> > > to explicitly specify --with-doxygen=yes to build documentation, so
> > > users explicitly picks what they needs.
[...]
> I'd really prefer to retain the existing default that has been in
> place for many years.
>
Agreed that was a sensible default for many years.

The man pages had obscure names and were prone to clash with other man pages,
e.g. `man tcp` got you the libnfq page instead of tcp(7) and IIRC there was even
a clash between libnfq and libmnl.

At libnfq 1.0.5 there were no such clashes, and `man {any nfq function}` got you
the documentation for that function. However, having man pages on by default
broke `make distcheck`, so it was still sensible to have them off.

Now `make distcheck` passes with man pages on by default.

So I strongly suggest it is no longer sensible to have man page creation off by
default.

For the embedded guys, let's definitely keep --with-doxygen[=yes]. They can
always say no. Or not have it installed in the first place. More of that in an
email to come,

Cheers ... Duncan.

  parent reply	other threads:[~2021-07-17  3:27 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-22  4:19 [PATCH libmnl 0/1] build: doc: "make" builds & installs a full set of man pages Duncan Roe
2021-06-22  4:19 ` [PATCH libmnl 1/1] " Duncan Roe
2021-06-23 17:26   ` Pablo Neira Ayuso
2021-06-27  4:30     ` Duncan Roe
2021-06-27  4:42       ` Duncan Roe
2021-06-29  9:38       ` Pablo Neira Ayuso
2021-07-02  4:16         ` Duncan Roe
2021-07-07  2:19         ` Duncan Roe
2021-07-17  2:53         ` Duncan Roe
2021-07-17  2:53         ` [PATCH RFC libnetfilter_queue 1/1] src: doc: supply missing SYNOPSIS in pktbuff " Duncan Roe
2021-07-22 17:10           ` Pablo Neira Ayuso
2021-07-24  3:49             ` Duncan Roe
2021-07-24  8:56               ` Pablo Neira Ayuso
2021-08-09  8:22                 ` Duncan Roe
2021-08-09  8:32                   ` Duncan Roe
2021-07-17  3:27         ` Duncan Roe [this message]
2021-07-17  5:47           ` [PATCH libmnl 1/1] build: doc: "make" builds & installs a full set of " 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=YPJOIYVbWCYFB2eW@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).