netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Donald Hunter <donald.hunter@gmail.com>
To: Jakub Kicinski <kuba@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	 Breno Leitao <leitao@debian.org>,
	linux-doc@vger.kernel.org,  netdev@vger.kernel.org,
	 pabeni@redhat.com, edumazet@google.com
Subject: Re: [PATCH] Documentation: Document the Netlink spec
Date: Fri, 10 Nov 2023 09:23:50 +0000	[thread overview]
Message-ID: <m27cmq3qs9.fsf@gmail.com> (raw)
In-Reply-To: <20231108174306.47a64bda@kernel.org> (Jakub Kicinski's message of "Wed, 8 Nov 2023 17:43:06 -0800")

Jakub Kicinski <kuba@kernel.org> writes:

> On Wed, 08 Nov 2023 13:27:28 -0700 Jonathan Corbet wrote:
>> I do have to wonder, though, whether a sphinx extension is the right way
>> to solve this problem.  You're essentially implementing a filter that
>> turns one YAML file into one RST file; might it be better to keep that
>> outside of sphinx as a standalone script, invoked by the Makefile?
>
> If we're considering other ways of generating the files - I'd also like
> to voice a weak preference towards removing the need for the "stub"
> files.
>
> Get all the docs rendered under Documentation/netlink/ with an
> auto-generated index.

FWIW the index could use a toctree glob pattern like we do in
Documentation/bpf/maps.rst then it wouldn't need to be auto-generated.

> This way newcomers won't have to remember to add a stub to get the doc
> rendered. One fewer thing to worry about during review.

  reply	other threads:[~2023-11-10  9:24 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-03 13:56 [PATCH] Documentation: Document the Netlink spec Breno Leitao
2023-11-06 22:51 ` Jakub Kicinski
2023-11-08 14:03 ` Donald Hunter
2023-11-08 14:08   ` Donald Hunter
2023-11-09 18:28   ` Breno Leitao
2023-11-08 20:27 ` Jonathan Corbet
2023-11-09  1:43   ` Jakub Kicinski
2023-11-10  9:23     ` Donald Hunter [this message]
2023-11-09 11:22   ` Donald Hunter
2023-11-09 14:12     ` Jonathan Corbet
2023-11-09 15:16       ` Jakub Kicinski
2023-11-09 15:20       ` Breno Leitao

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=m27cmq3qs9.fsf@gmail.com \
    --to=donald.hunter@gmail.com \
    --cc=corbet@lwn.net \
    --cc=edumazet@google.com \
    --cc=kuba@kernel.org \
    --cc=leitao@debian.org \
    --cc=linux-doc@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).