parse_headers.pl ?

parse_headers.pl ?

[Randy Dunlap]

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?

thanks.
-- 
~Randy

Re: parse_headers.pl ?

[Jonathan Corbet]

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?

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

jon

Re: parse_headers.pl ?

[Mauro Carvalho Chehab]

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

Re: parse_headers.pl ?

[Randy Dunlap]

On 10/17/25 1:47 AM, Mauro Carvalho Chehab wrote:
> 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.

Great. Thank you.

-- 
~Randy