public inbox for lkmm@lists.linux.dev
 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>,
	 "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 v7 04/17] tools: ynl_gen_rst.py: Split library from command line tool
Date: Thu, 19 Jun 2025 13:01:14 +0100	[thread overview]
Message-ID: <m2plf0ey9h.fsf@gmail.com> (raw)
In-Reply-To: <4e26583ad1d8a05ba40cada4213c95120bd45efc.1750315578.git.mchehab+huawei@kernel.org>

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> +
> +    def generate_main_index_rst(self, output: str, index_dir: str) -> None:
> +        """Generate the `networking_spec/index` content and write to the file"""
> +        lines = []
> +
> +        lines.append(self.fmt.rst_header())
> +        lines.append(self.fmt.rst_label("specs"))
> +        lines.append(self.fmt.rst_title("Netlink Family Specifications"))
> +        lines.append(self.fmt.rst_toctree(1))
> +
> +        index_fname = os.path.basename(output)
> +        base, ext = os.path.splitext(index_fname)
> +
> +        if not index_dir:
> +            index_dir = os.path.dirname(output)
> +
> +        logging.debug(f"Looking for {ext} files in %s", index_dir)
> +        for filename in sorted(os.listdir(index_dir)):
> +            if not filename.endswith(ext) or filename == index_fname:
> +                continue
> +            base, ext = os.path.splitext(filename)
> +            lines.append(f"   {base}\n")
> +
> +        logging.debug("Writing an index file at %s", output)
> +
> +        return "".join(lines)

Did you miss my comment on v5 to not move this from ynl_gen_rst.py,
since it is not needed and gets removed in a later patch.

> @@ -411,7 +65,6 @@ def write_to_rstfile(content: str, filename: str) -> None:
>  
>  def generate_main_index_rst(output: str) -> None:
>      """Generate the `networking_spec/index` content and write to the file"""
> -    lines = []
>  
>      lines.append(rst_header())
>      lines.append(rst_label("specs"))
> @@ -426,7 +79,7 @@ def generate_main_index_rst(output: str) -> None:
>          lines.append(f"   {filename.replace('.rst', '')}\n")
>  
>      logging.debug("Writing an index file at %s", output)
> -    write_to_rstfile("".join(lines), output)
> +    write_to_rstfile(msg, output)

The changes leave this function broken. Bot lines and msg never get
defined.

  reply	other threads:[~2025-06-19 12:20 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-19  6:48 [PATCH v7 00/17] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-06-19  6:48 ` [PATCH v7 01/17] docs: conf.py: properly handle include and exclude patterns Mauro Carvalho Chehab
2025-06-19  6:48 ` [PATCH v7 02/17] docs: Makefile: disable check rules on make cleandocs Mauro Carvalho Chehab
2025-06-19  6:48 ` [PATCH v7 03/17] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-06-19  8:57   ` Donald Hunter
2025-06-19  6:48 ` [PATCH v7 04/17] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-06-19 12:01   ` Donald Hunter [this message]
2025-06-20 10:58     ` Mauro Carvalho Chehab
2025-06-19  6:48 ` [PATCH v7 05/17] docs: netlink: index.rst: add a netlink index file Mauro Carvalho Chehab
2025-06-19  6:48 ` [PATCH v7 06/17] tools: ynl_gen_rst.py: cleanup coding style Mauro Carvalho Chehab
2025-06-19 12:04   ` Donald Hunter
2025-06-19  6:49 ` [PATCH v7 07/17] docs: sphinx: add a parser for yaml files for Netlink specs Mauro Carvalho Chehab
2025-06-19 12:08   ` Donald Hunter
2025-06-19  6:49 ` [PATCH v7 08/17] docs: use parser_yaml extension to handle " Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 09/17] docs: uapi: netlink: update netlink specs link Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 10/17] tools: ynl_gen_rst.py: drop support for generating index files Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 11/17] docs: netlink: remove obsolete .gitignore from unused directory Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 12/17] MAINTAINERS: add netlink_yml_parser.py to linux-doc Mauro Carvalho Chehab
2025-06-19 12:10   ` Donald Hunter
2025-06-19  6:49 ` [PATCH v7 13/17] tools: netlink_yml_parser.py: add line numbers to parsed data Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 14/17] docs: parser_yaml.py: add support for line numbers from the parser Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 15/17] docs: sphinx: add a file with the requirements for lowest version Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 16/17] docs: conf.py: several coding style fixes Mauro Carvalho Chehab
2025-06-19  6:49 ` [PATCH v7 17/17] docs: conf.py: Check Sphinx and docutils version Mauro Carvalho Chehab
2025-06-19  8:29 ` [PATCH v7 00/17] Don't generate netlink .rst files inside $(srctree) Donald Hunter
2025-06-20 10:33   ` 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=m2plf0ey9h.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=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