netfilter-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Pablo Neira Ayuso <pablo@netfilter.org>
To: Jan Engelhardt <ej@inai.de>
Cc: Netfilter Development <netfilter-devel@vger.kernel.org>
Subject: Re: [PATCH libmnl] build: do not build documentation automatically
Date: Mon, 14 Oct 2024 13:20:27 +0200	[thread overview]
Message-ID: <Zwz-e5ef9uyTG6Yv@calendula> (raw)
In-Reply-To: <n4r27125-61q3-r7p2-ns82-77334r0oo3s3@vanv.qr>

On Mon, Oct 14, 2024 at 01:12:02PM +0200, Jan Engelhardt wrote:
[...]
> Having worked extensively with wxWidgets (also doxygenated) in the past 
> however, I found that when the API is large, needs frequent lookup, 
> documentation has many pages, and online retrieval latency becomes a 
> factor, I prefer a local copy as a quality-of-live improvement.

For reference, there is one online available at:

https://www.netfilter.org/projects/libmnl/doxygen/html/

for the current release.

[...]
> Removals are a powerful action that is seldomly undone at the distro
> levels, so it can be regarded as the final say (well, in "95% of
> cases").
[...]
> Hiding stuff behind a configure knob is not a removal though,
> so it is not too big a deal.

Exactly.

> >Moreover, documentation is specifically designed for developers who
> >are engaged in the technical aspects. Most users of this software are
> >building it because it is a dependency for their software.
>                                             ^^^^^^^^^^^^^^
> 
> The way it's phrased makes those users users of the libmnl API (i.e.
> developers), and documentation is warranted.
> 
> (The following statement would be more accurate:
> 
> >Most users of this software are
> >building it because it is a dependency for someone else's software
> >they want to utilize.

That sounds more precise, yes.

  reply	other threads:[~2024-10-14 11:20 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-12 17:15 [PATCH libmnl] build: do not build documentation automatically Pablo Neira Ayuso
2024-10-12 19:54 ` Phil Sutter
2024-10-12 21:26   ` Pablo Neira Ayuso
2024-10-12 23:03     ` Phil Sutter
2024-10-13  8:21       ` Pablo Neira Ayuso
2024-10-14  7:55 ` Duncan Roe
2024-10-14  8:09   ` Pablo Neira Ayuso
2024-10-14 11:12     ` Jan Engelhardt
2024-10-14 11:20       ` Pablo Neira Ayuso [this message]
     [not found]         ` <Zw8UOCbpwSOupUcf@slk15.local.net>
     [not found]           ` <Zw9qbppRAtX4VbIv@calendula>
2024-10-16  7:26             ` [PATCH libmnl v2] " Pablo Neira Ayuso
2024-10-17 23:59               ` 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=Zwz-e5ef9uyTG6Yv@calendula \
    --to=pablo@netfilter.org \
    --cc=ej@inai.de \
    --cc=netfilter-devel@vger.kernel.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).