From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Akira Yokosawa" <akiyks@gmail.com>,
"Breno Leitao" <leitao@debian.org>,
"David S. Miller" <davem@davemloft.net>,
"Donald Hunter" <donald.hunter@gmail.com>,
"Eric Dumazet" <edumazet@google.com>,
"Ignacio Encinas Rubio" <ignacio@iencinas.com>,
"Jan Stancek" <jstancek@redhat.com>,
"Marco Elver" <elver@google.com>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Paolo Abeni" <pabeni@redhat.com>,
"Ruben Wauters" <rubenru09@aol.com>,
"Shuah Khan" <skhan@linuxfoundation.org>,
Jakub Kicinski <mchehab+huawei@kernel.org>,
Simon Horman <mchehab+huawei@kernel.org>,
joel@joelfernandes.org, linux-kernel-mentees@lists.linux.dev,
linux-kernel@vger.kernel.org, lkmm@lists.linux.dev,
netdev@vger.kernel.org, peterz@infradead.org,
stern@rowland.harvard.edu
Subject: [PATCH v2 01/12] tools: ynl_gen_rst.py: create a top-level reference
Date: Thu, 12 Jun 2025 12:31:53 +0200 [thread overview]
Message-ID: <ed66166bec8051df75465f9821671b21011fbda4.1749723671.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1749723671.git.mchehab+huawei@kernel.org>
Currently, rt documents are referred with:
Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`rt-link<../../networking/netlink_spec/rt-link>`
Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`tc<../../networking/netlink_spec/tc>`
Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`tc<../../networking/netlink_spec/tc>`
that's hard to maintain, and may break if we change the way
rst files are generated from yaml. Better to use instead a
reference for the netlink family.
So, add a netlink-<foo> reference to all generated docs.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
tools/net/ynl/pyynl/ynl_gen_rst.py | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/tools/net/ynl/pyynl/ynl_gen_rst.py b/tools/net/ynl/pyynl/ynl_gen_rst.py
index 0cb6348e28d3..7bfb8ceeeefc 100755
--- a/tools/net/ynl/pyynl/ynl_gen_rst.py
+++ b/tools/net/ynl/pyynl/ynl_gen_rst.py
@@ -314,10 +314,11 @@ def parse_yaml(obj: Dict[str, Any]) -> str:
# Main header
- lines.append(rst_header())
-
family = obj['name']
+ lines.append(rst_header())
+ lines.append(rst_label("netlink-" + family))
+
title = f"Family ``{family}`` netlink specification"
lines.append(rst_title(title))
lines.append(rst_paragraph(".. contents:: :depth: 3\n"))
--
2.49.0
next prev parent reply other threads:[~2025-06-12 10:32 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-12 10:31 [PATCH v2 00/12] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-06-12 10:31 ` Mauro Carvalho Chehab [this message]
2025-06-12 10:31 ` [PATCH v2 02/12] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-06-12 10:31 ` [PATCH v2 03/12] docs: netlink: don't ignore generated rst files Mauro Carvalho Chehab
2025-06-12 10:31 ` [PATCH v2 04/12] tools: ynl_gen_rst.py: make the index parser more generic Mauro Carvalho Chehab
2025-06-12 10:31 ` [PATCH v2 05/12] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-06-13 11:13 ` Donald Hunter
2025-06-13 12:17 ` Mauro Carvalho Chehab
2025-06-14 13:34 ` Donald Hunter
2025-06-14 15:01 ` Mauro Carvalho Chehab
2025-06-12 10:31 ` [PATCH v2 06/12] scripts: lib: netlink_yml_parser.py: use classes Mauro Carvalho Chehab
2025-06-13 11:20 ` Donald Hunter
2025-06-13 12:40 ` Mauro Carvalho Chehab
2025-06-13 12:53 ` Donald Hunter
2025-06-12 10:31 ` [PATCH v2 07/12] tools: ynl_gen_rst.py: do some coding style cleanups Mauro Carvalho Chehab
2025-06-12 10:32 ` [PATCH v2 08/12] scripts: netlink_yml_parser.py: improve index.rst generation Mauro Carvalho Chehab
2025-06-12 10:32 ` [PATCH v2 09/12] docs: sphinx: add a parser template for yaml files Mauro Carvalho Chehab
2025-06-13 11:29 ` Donald Hunter
2025-06-13 12:26 ` Mauro Carvalho Chehab
2025-06-13 15:42 ` Mauro Carvalho Chehab
2025-06-12 10:32 ` [PATCH v2 10/12] docs: sphinx: parser_yaml.py: add Netlink specs parser Mauro Carvalho Chehab
2025-06-13 11:45 ` Donald Hunter
2025-06-13 12:27 ` Mauro Carvalho Chehab
2025-06-12 10:32 ` [PATCH v2 11/12] docs: use parser_yaml extension to handle Netlink specs Mauro Carvalho Chehab
2025-06-13 11:50 ` Donald Hunter
2025-06-13 12:29 ` Mauro Carvalho Chehab
2025-06-12 10:32 ` [PATCH v2 12/12] docs: conf.py: don't handle yaml files outside " Mauro Carvalho Chehab
2025-06-13 11:52 ` Donald Hunter
2025-06-13 12:30 ` Mauro Carvalho Chehab
2025-06-13 11:05 ` [PATCH v2 00/12] Don't generate netlink .rst files inside $(srctree) Donald Hunter
2025-06-13 12:13 ` Mauro Carvalho Chehab
2025-06-14 13:29 ` Donald Hunter
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=ed66166bec8051df75465f9821671b21011fbda4.1749723671.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=donald.hunter@gmail.com \
--cc=edumazet@google.com \
--cc=elver@google.com \
--cc=ignacio@iencinas.com \
--cc=joel@joelfernandes.org \
--cc=jstancek@redhat.com \
--cc=leitao@debian.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=lkmm@lists.linux.dev \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=peterz@infradead.org \
--cc=rubenru09@aol.com \
--cc=skhan@linuxfoundation.org \
--cc=stern@rowland.harvard.edu \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).