Thread (1 message) 1 message, 1 author, 2023-11-10

Re: [PATCH] Documentation: Document the Netlink spec

From: Donald Hunter <donald.hunter@gmail.com>
Date: 2023-11-10 09:24:58
Also in: linux-doc

Jakub Kicinski [off-list ref] writes:
On Wed, 08 Nov 2023 13:27:28 -0700 Jonathan Corbet wrote:
quoted
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.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help