public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Kory Maincent <kory.maincent@bootlin.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Message-ID :" <cover.1752076293.git.mchehab+huawei@kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.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>,
	"Jakub Kicinski" <kuba@kernel.org>,
	"Jan Stancek" <jstancek@redhat.com>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"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>,
	"Simon Horman" <horms@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: Re: [PATCH v10 06/14] docs: use parser_yaml extension to handle Netlink specs
Date: Thu, 28 Aug 2025 19:02:43 +0200	[thread overview]
Message-ID: <20250828190243.0d3f74f6@kmaincent-XPS-13-7390> (raw)
In-Reply-To: <20250828185037.07873d04@kmaincent-XPS-13-7390>

Le Thu, 28 Aug 2025 18:50:37 +0200,
Kory Maincent <kory.maincent@bootlin.com> a écrit :

> Le Mon, 28 Jul 2025 18:01:59 +0200,
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> a écrit :
> 
> > 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.  
> 
> ...
> 
> > 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  
> 
> Faced a doc build warning that say netlink_spec/index.rst is not used.
> 
> $ git grep netlink_spec
> Documentation/networking/mptcp.rst:netlink_spec/mptcp_pm.rst.
> Documentation/translations/zh_CN/networking/index.rst:*   netlink_spec/index
> 
> I think we can remove the whole directory and change these, right?

Oops just saw that is was some local leftover. This first warning get removed
with a clean tree.
 
> Also got a doc build warning that says netlink/specs/index is not existing
> even if it exists. Maybe a sphinx parsing issue ?!


> 
> Regards,



-- 
Köry Maincent, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com

  reply	other threads:[~2025-08-28 17:03 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-28 16:01 [PATCH v10 00/14] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-07-28 16:01 ` [PATCH v10 01/14] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-07-28 16:01 ` [PATCH v10 02/14] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-07-28 16:01 ` [PATCH v10 03/14] docs: netlink: index.rst: add a netlink index file Mauro Carvalho Chehab
2025-07-28 16:01 ` [PATCH v10 04/14] tools: ynl_gen_rst.py: cleanup coding style Mauro Carvalho Chehab
2025-07-28 16:01 ` [PATCH v10 05/14] docs: sphinx: add a parser for yaml files for Netlink specs Mauro Carvalho Chehab
2025-07-28 16:01 ` [PATCH v10 06/14] docs: use parser_yaml extension to handle " Mauro Carvalho Chehab
2025-08-28 16:50   ` Kory Maincent
2025-08-28 17:02     ` Kory Maincent [this message]
2025-07-28 16:02 ` [PATCH v10 07/14] docs: uapi: netlink: update netlink specs link Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 08/14] tools: ynl_gen_rst.py: drop support for generating index files Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 09/14] docs: netlink: remove obsolete .gitignore from unused directory Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 10/14] MAINTAINERS: add netlink_yml_parser.py to linux-doc Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 11/14] tools: netlink_yml_parser.py: add line numbers to parsed data Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 12/14] docs: parser_yaml.py: add support for line numbers from the parser Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 13/14] docs: parser_yaml.py: fix backward compatibility with old docutils Mauro Carvalho Chehab
2025-07-28 16:02 ` [PATCH v10 14/14] sphinx: parser_yaml.py: fix line numbers information Mauro Carvalho Chehab
2025-08-11 17:28 ` [PATCH v10 00/14] Don't generate netlink .rst files inside $(srctree) Jonathan Corbet
2025-08-12  0:56   ` Jakub Kicinski
2025-08-12  9:29     ` 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=20250828190243.0d3f74f6@kmaincent-XPS-13-7390 \
    --to=kory.maincent@bootlin.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cover.1752076293.git.mchehab+huawei@kernel.org \
    --cc=davem@davemloft.net \
    --cc=donald.hunter@gmail.com \
    --cc=edumazet@google.com \
    --cc=elver@google.com \
    --cc=horms@kernel.org \
    --cc=ignacio@iencinas.com \
    --cc=joel@joelfernandes.org \
    --cc=jstancek@redhat.com \
    --cc=kuba@kernel.org \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox