[PATCH 0/8] Yet another set of kerneldoc simplifications

Jonathan Corbet posted 8 patches 3 months, 1 week ago
scripts/lib/kdoc/kdoc_parser.py | 170 +++++++++++++-------------------
1 file changed, 67 insertions(+), 103 deletions(-)
[PATCH 0/8] Yet another set of kerneldoc simplifications
Posted by Jonathan Corbet 3 months, 1 week ago
As I continue to work through our shiny new kerneldoc, I keep finding ways
to make it (IMO) shinier.  This set covers these basic areas:

- Remove some unused fields from the KernelEntry class, and encapsulate the
  handling of the section contentions therein.

- Clean up and optimize the EXPORT_SYMBOL processing slightly.

- Rework the handling of inline comments by getting rid of the substate
  design and separating out the processing of the states that remain.

The series results in no changes in the generated output.

Jonathan Corbet (8):
  docs: kdoc: remove KernelEntry::in_doc_sect
  docs: kdoc: Move content handling into KernelEntry
  docs: kdoc: remove a bit of dead code
  docs: kdoc: remove KernelEntry::function
  docs: kdoc: rework process_export() slightly
  docs: kdoc: remove the INLINE_END state
  docs: kdoc: remove the inline states-within-a-state
  docs: kdoc: split the processing of the two remaining inline states

 scripts/lib/kdoc/kdoc_parser.py | 170 +++++++++++++-------------------
 1 file changed, 67 insertions(+), 103 deletions(-)

-- 
2.49.0
Re: [PATCH 0/8] Yet another set of kerneldoc simplifications
Posted by Mauro Carvalho Chehab 3 months, 1 week ago
Em Fri, 27 Jun 2025 12:39:52 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> As I continue to work through our shiny new kerneldoc, I keep finding ways
> to make it (IMO) shinier.  This set covers these basic areas:
> 
> - Remove some unused fields from the KernelEntry class, and encapsulate the
>   handling of the section contentions therein.
> 
> - Clean up and optimize the EXPORT_SYMBOL processing slightly.
> 
> - Rework the handling of inline comments by getting rid of the substate
>   design and separating out the processing of the states that remain.
> 
> The series results in no changes in the generated output.

I looked the entire series, although I didn't test. On a visual
inspection, all changes look good to me.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> 
> Jonathan Corbet (8):
>   docs: kdoc: remove KernelEntry::in_doc_sect
>   docs: kdoc: Move content handling into KernelEntry
>   docs: kdoc: remove a bit of dead code
>   docs: kdoc: remove KernelEntry::function
>   docs: kdoc: rework process_export() slightly
>   docs: kdoc: remove the INLINE_END state
>   docs: kdoc: remove the inline states-within-a-state
>   docs: kdoc: split the processing of the two remaining inline states
> 
>  scripts/lib/kdoc/kdoc_parser.py | 170 +++++++++++++-------------------
>  1 file changed, 67 insertions(+), 103 deletions(-)
> 



Thanks,
Mauro