netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Breno Leitao <leitao@debian.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Jani Nikula <jani.nikula@linux.intel.com>,
	kuba@kernel.org, "David S. Miller" <davem@davemloft.net>,
	linux-doc@vger.kernel.org, netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org, pabeni@redhat.com,
	edumazet@google.com
Subject: Re: [PATCH v3] Documentation: Document each netlink family
Date: Tue, 30 Jan 2024 08:06:04 -0800	[thread overview]
Message-ID: <ZbkebMW+xLqNhsoB@gmail.com> (raw)
In-Reply-To: <87jznqewa7.fsf@meer.lwn.net>

On Tue, Jan 30, 2024 at 07:22:08AM -0700, Jonathan Corbet wrote:
> Jani Nikula <jani.nikula@linux.intel.com> writes:
> 
> > On Tue, 21 Nov 2023, Breno Leitao <leitao@debian.org> wrote:
> >> This is a simple script that parses the Netlink YAML spec files
> >> (Documentation/netlink/specs/), and generates RST files to be rendered
> >> in the Network -> Netlink Specification documentation page.
> >
> > First of all, my boilerplate complaint: All extra processing for Sphinx
> > should really be done using Sphinx extensions instead of adding Makefile
> > hacks. I don't think it's sustainable to keep adding this stuff. We
> > chose Sphinx because it is extensible, and to avoid the Rube Goldberg
> > machine that the previous documentation build system was.
> 
> So I feel like we've (me included) have kind of sent Breno around in
> circles on this one.  This *was* implemented as an extension once:
> 
>   https://lore.kernel.org/netdev/20231103135622.250314-1-leitao@debian.org/
> 
> At that time it seemed too complex, and I thought that an external
> script would lead to a simpler implementation overall.  Perhaps I was
> wrong.

I think you are correct. I personally _think_ that the external script
is better, mainly because it is self contained, thus, easier to
maintain.

  parent reply	other threads:[~2024-01-30 16:06 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-21 11:48 [PATCH v3] Documentation: Document each netlink family Breno Leitao
2023-11-21 16:15 ` Jakub Kicinski
2023-11-24  1:20 ` patchwork-bot+netdevbpf
2024-01-30  9:43 ` Jani Nikula
2024-01-30 14:22   ` Jonathan Corbet
2024-01-30 15:03     ` Jani Nikula
2024-01-30 16:06     ` Breno Leitao [this message]
2024-01-30 16:23       ` Vegard Nossum
2024-01-30 17:29         ` Breno Leitao
2024-02-09 14:47         ` Vegard Nossum
2024-02-09 23:20           ` Akira Yokosawa

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=ZbkebMW+xLqNhsoB@gmail.com \
    --to=leitao@debian.org \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=jani.nikula@linux.intel.com \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    /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).