All of lore.kernel.org
 help / color / mirror / Atom feed
From: Donald Hunter <donald.hunter@gmail.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	 Jonathan Corbet <corbet@lwn.net>,
	 "Akira Yokosawa" <akiyks@gmail.com>,
	 "Breno Leitao" <leitao@debian.org>,
	 "David S. Miller" <davem@davemloft.net>,
	 "Eric Dumazet" <edumazet@google.com>,
	 "Ignacio Encinas Rubio" <ignacio@iencinas.com>,
	 "Jan Stancek" <jstancek@redhat.com>,
	 "Marco Elver" <elver@google.com>,
	 "Paolo Abeni" <pabeni@redhat.com>,
	 "Randy Dunlap" <rdunlap@infradead.org>,
	 "Ruben Wauters" <rubenru09@aol.com>,
	"Shuah Khan" <skhan@linuxfoundation.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: Re: [PATCH v8 06/13] docs: use parser_yaml extension to handle Netlink specs
Date: Fri, 27 Jun 2025 11:28:40 +0100	[thread overview]
Message-ID: <m2wm8x8omf.fsf@gmail.com> (raw)
In-Reply-To: <34e491393347ca1ba6fd65e73a468752b1436a80.1750925410.git.mchehab+huawei@kernel.org>

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> 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 <mchehab+huawei@kernel.org>
> Reviewed-by: Donald Hunter <donald.hunter@gmail.com>

This patch doesn't currently merge in the net-next tree because it
depends on a series in docs-next.

> diff --git a/Documentation/sphinx/parser_yaml.py b/Documentation/sphinx/parser_yaml.py
> index 585a7ec81ba0..fa2e6da17617 100755
> --- a/Documentation/sphinx/parser_yaml.py
> +++ b/Documentation/sphinx/parser_yaml.py
> @@ -18,9 +18,9 @@ from sphinx.util import logging
>  from sphinx.parsers import Parser
>  
>  srctree = os.path.abspath(os.environ["srctree"])
> -sys.path.insert(0, os.path.join(srctree, "tools/net/ynl/pyynl"))
> +sys.path.insert(0, os.path.join(srctree, "tools/net/ynl/pyynl/lib"))
>  
> -from netlink_yml_parser import YnlDocGenerator        # pylint: disable=C0413
> +from doc_generator import YnlDocGenerator        # pylint: disable=C0413

Please fix up patch 5 so that this diff can be dropped.

  reply	other threads:[~2025-06-27 11:04 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-26  8:12 [PATCH v8 00/13] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-06-26  8:12 ` [PATCH v8 01/13] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-06-26  8:12 ` [PATCH v8 02/13] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-06-27 10:29   ` Donald Hunter
2025-06-26  8:12 ` [PATCH v8 03/13] docs: netlink: index.rst: add a netlink index file Mauro Carvalho Chehab
2025-06-26  8:13 ` [PATCH v8 04/13] tools: ynl_gen_rst.py: cleanup coding style Mauro Carvalho Chehab
2025-06-27 10:41   ` Donald Hunter
2025-06-26  8:13 ` [PATCH v8 05/13] docs: sphinx: add a parser for yaml files for Netlink specs Mauro Carvalho Chehab
2025-06-27 10:25   ` Donald Hunter
2025-06-26  8:13 ` [PATCH v8 06/13] docs: use parser_yaml extension to handle " Mauro Carvalho Chehab
2025-06-27 10:28   ` Donald Hunter [this message]
2025-07-09 15:25     ` Mauro Carvalho Chehab
2025-06-26  8:13 ` [PATCH v8 07/13] docs: uapi: netlink: update netlink specs link Mauro Carvalho Chehab
2025-06-26  8:13 ` [PATCH v8 08/13] tools: ynl_gen_rst.py: drop support for generating index files Mauro Carvalho Chehab
2025-06-27 10:49   ` Donald Hunter
2025-06-26  8:13 ` [PATCH v8 09/13] docs: netlink: remove obsolete .gitignore from unused directory Mauro Carvalho Chehab
2025-06-26  8:13 ` [PATCH v8 10/13] MAINTAINERS: add netlink_yml_parser.py to linux-doc Mauro Carvalho Chehab
2025-06-27 10:50   ` Donald Hunter
2025-06-26  8:13 ` [PATCH v8 11/13] tools: netlink_yml_parser.py: add line numbers to parsed data Mauro Carvalho Chehab
2025-06-27 11:03   ` Donald Hunter
2025-07-09 15:44     ` Mauro Carvalho Chehab
2025-06-26  8:13 ` [PATCH v8 12/13] docs: parser_yaml.py: add support for line numbers from the parser Mauro Carvalho Chehab
2025-06-26  8:13 ` [PATCH v8 13/13] docs: parser_yaml.py: fix backward compatibility with old docutils Mauro Carvalho Chehab
2025-06-26 23:59   ` Akira Yokosawa
2025-06-27  6:48     ` Mauro Carvalho Chehab
2025-06-27  8:37       ` Akira Yokosawa
2025-07-09 15:16         ` Mauro Carvalho Chehab

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=m2wm8x8omf.fsf@gmail.com \
    --to=donald.hunter@gmail.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --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=mchehab+huawei@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=peterz@infradead.org \
    --cc=rdunlap@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.