All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: parse_headers.pl ?
Date: Fri, 17 Oct 2025 05:47:51 -0300	[thread overview]
Message-ID: <20251017054731.54fe573a@sal.lan> (raw)
In-Reply-To: <87ikge6gts.fsf@trenco.lwn.net>

Em Thu, 16 Oct 2025 08:50:55 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Randy Dunlap <rdunlap@infradead.org> writes:
> 
> > Hi,
> >
> > Documentation/doc-guide/parse-headers.rst talks about some
> > parse_headers.pl file but I cannot find such a file.
> >
> > Is there a replacement for this documentation?
> > What should it be?  

Good catch!

> Mauro deleted it in aebcc3009ed5; clearly there's some docs work that
> needs to be done to finish the job.

Yes, it was replaced with:

	tools/docs/parse-headers.py

And its library:
	tools/docs/lib/parse_data_structs.py

The command line options changed a little bit: 
- it doesn't have anymore a --usage
- it gained a --toc option.

While it still does what it is documented there, it received some 
improvements during the conversion, and has gained --toc.

I updated its documentation at the source code on both the library,
with is about the same content of the .rst file.

Some of those changes are on a patch series not merged yet:
	https://lore.kernel.org/linux-doc/cover.1759329363.git.mchehab+huawei@kernel.org/

I'll seek for some time to update parse-headers.rst to reflect such
changes.

Regards,
Mauro

  reply	other threads:[~2025-10-17  8:48 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-15 21:49 parse_headers.pl ? Randy Dunlap
2025-10-16 14:50 ` Jonathan Corbet
2025-10-17  8:47   ` Mauro Carvalho Chehab [this message]
2025-10-17 17:27     ` Randy Dunlap

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=20251017054731.54fe573a@sal.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=rdunlap@infradead.org \
    /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.