public inbox for lkmm@lists.linux.dev
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Donald Hunter <donald.hunter@gmail.com>
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>,
	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 v5 10/15] docs: sphinx: add a parser for yaml files for Netlink specs
Date: Wed, 18 Jun 2025 10:21:05 +0200	[thread overview]
Message-ID: <20250618102105.66ce01f0@foz.lan> (raw)
In-Reply-To: <CAD4GDZzWMoxnatNXYbKOphzVZ4NyedD5FtjxF7cgB1ad-wDFWg@mail.gmail.com>

Em Tue, 17 Jun 2025 18:23:22 +0100
Donald Hunter <donald.hunter@gmail.com> escreveu:

> On Tue, 17 Jun 2025 at 17:00, Mauro Carvalho Chehab
> <mchehab+huawei@kernel.org> wrote:
> > >
> > > (2) is cleaner and faster, but (1) is easier to implement on an
> > > already-existing code.  
> >
> > The logic below implements (1). This seems to be the easiest way for
> > pyyaml. I will submit as 2 separate patches at the end of the next
> > version.
> >
> > Please notice that I didn't check yet for the "quality" of the
> > line numbers. Some tweaks could be needed later on.  
> 
> Thanks for working on this. I suppose we might be able to work on an
> evolution from (1) to (2) in a followup piece of work?

Yes, it shouldn't be hard for you to migrate to (2) in the future. 

Currently, the parser is stateless, but, as there's now a class,
IMO the best would be to store the lines as an array of tuples
inside the YnlDocGenerator class, like this:

	self.lines = [
		(line_number1, message_string1),
		(line_number2, message_string2),
		(line_number3, message_string3),
		(line_number4, message_string4),
		...
	]

This way, the parse_yaml_file() method would just return self.lines.

Thanks,
Mauro

  reply	other threads:[~2025-06-18  8:21 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-17  8:01 [PATCH v5 00/15] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-06-17  8:01 ` [PATCH v5 01/15] docs: conf.py: properly handle include and exclude patterns Mauro Carvalho Chehab
2025-06-17 10:38   ` Donald Hunter
2025-06-18  6:59     ` Mauro Carvalho Chehab
2025-06-18  2:42   ` Akira Yokosawa
2025-06-18 11:44     ` Mauro Carvalho Chehab
2025-06-17  8:01 ` [PATCH v5 02/15] docs: Makefile: disable check rules on make cleandocs Mauro Carvalho Chehab
2025-06-17  9:53   ` Breno Leitao
2025-06-17 10:38   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 03/15] tools: ynl_gen_rst.py: create a top-level reference Mauro Carvalho Chehab
2025-06-17 10:40   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 04/15] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-06-17  8:02 ` [PATCH v5 05/15] tools: ynl_gen_rst.py: make the index parser more generic Mauro Carvalho Chehab
2025-06-17 10:55   ` Donald Hunter
2025-06-17 11:59   ` Simon Horman
2025-06-18  6:57     ` Mauro Carvalho Chehab
2025-06-18 12:40       ` Simon Horman
2025-06-17  8:02 ` [PATCH v5 06/15] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-06-17 11:08   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 07/15] scripts: lib: netlink_yml_parser.py: use classes Mauro Carvalho Chehab
2025-06-17  8:02 ` [PATCH v5 08/15] docs: netlink: index.rst: add a netlink index file Mauro Carvalho Chehab
2025-06-17 10:43   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 09/15] tools: ynl_gen_rst.py: clanup coding style Mauro Carvalho Chehab
2025-06-17  9:49   ` Breno Leitao
2025-06-17  9:50   ` Breno Leitao
2025-06-17 11:12   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 10/15] docs: sphinx: add a parser for yaml files for Netlink specs Mauro Carvalho Chehab
2025-06-17 12:35   ` Donald Hunter
2025-06-17 13:40     ` Mauro Carvalho Chehab
2025-06-17 16:00       ` Mauro Carvalho Chehab
2025-06-17 17:23         ` Donald Hunter
2025-06-18  8:21           ` Mauro Carvalho Chehab [this message]
2025-06-17  8:02 ` [PATCH v5 11/15] docs: use parser_yaml extension to handle " Mauro Carvalho Chehab
2025-06-17 12:45   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 12/15] docs: uapi: netlink: update netlink specs link Mauro Carvalho Chehab
2025-06-17 12:46   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 13/15] tools: ynl_gen_rst.py: drop support for generating index files Mauro Carvalho Chehab
2025-06-17  8:02 ` [PATCH v5 14/15] docs: netlink: remove obsolete .gitignore from unused directory Mauro Carvalho Chehab
2025-06-17 12:38   ` Donald Hunter
2025-06-17  8:02 ` [PATCH v5 15/15] MAINTAINERS: add netlink_yml_parser.py to linux-doc Mauro Carvalho Chehab
2025-06-17  9:50   ` Breno Leitao
2025-06-17 12:58 ` [PATCH v5 00/15] Don't generate netlink .rst files inside $(srctree) 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=20250618102105.66ce01f0@foz.lan \
    --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