Thread (8 messages) 8 messages, 6 authors, 2025-08-15

Re: [GIT PULL for v6.17-rc2] add a generic yaml parser integrated with Netlink specs generation

From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: 2025-08-12 19:24:07
Also in: linux-doc, linux-edac, linux-kernel-mentees, lkml
Subsystem: documentation, networking [general], the rest · Maintainers: Jonathan Corbet, "David S. Miller", Eric Dumazet, Jakub Kicinski, Paolo Abeni, Linus Torvalds

On Tue, 12 Aug 2025 11:41:58 -0700
Randy Dunlap [off-list ref] wrote:
On 8/12/25 11:31 AM, Jonathan Corbet wrote:
quoted
Mauro Carvalho Chehab [off-list ref] writes:
  
quoted
Hi Jon/Jakub,

In case you both prefer to merge from a stable tag, please pull from:

	git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-docs.git docs/v6.17-1

For:

- An YAML parser Sphinx plugin, integrated with Netlink YAML doc
  parser.  
OK, I have done that.  I will note that it adds a warning:
  
quoted
Documentation/networking/netlink_spec/index.rst: WARNING: document isn't included in any toctree  
...it might be nice to get that straightened out.  
I see it, at least in linux-next. However, its format is
"different," so that may have confused whatever printed
that message:

from Documentation/networking/index.rst:

   filter
   generic-hdlc
   generic_netlink
   netlink_spec/index
   gen_stats
   gtp
   ila
Maybe some merge conflict/merge issue, as this was renamed:

$ git show 1ce4da3dd99e98bd4a8b396c291041080e0fe85e Documentation/networking/index.rst
commit 1ce4da3dd99e98bd4a8b396c291041080e0fe85e
Author: Mauro Carvalho Chehab [off-list ref]
Date:   Thu Jun 12 10:34:30 2025 +0200

    docs: use parser_yaml extension to handle Netlink specs
    
    Instead of manually calling ynl_gen_rst.py, use a Sphinx extension.
    This way, no .rst files would be written to the Kernel source
    directories.
    
    We are using here a toctree with :glob: property. This way, there
    is no need to touch the netlink/specs/index.rst file every time
    a new Netlink spec is added/renamed/removed.
    
    Signed-off-by: Mauro Carvalho Chehab [off-list ref]
    Reviewed-by: Donald Hunter [off-list ref]
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index ac90b82f3ce9..b7a4969e9bc9 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -57,7 +57,7 @@ Contents:
    filter
    generic-hdlc
    generic_netlink
-   netlink_spec/index
+   ../netlink/specs/index
    gen_stats
    gtp
    ila
Thanks,
Mauro
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help