In my ongoing effort to truly understand our new kernel-doc, I continue to
make changes to improve the code, and to try to make the understanding task
easier for the next person.  These patches focus on dump_struct() in
particular, which starts out at nearly 300 lines long - to much to fit into
my little brain anyway.  Hopefully the result is easier to manage.

There are no changes in the rendered docs.

Changes in v2:

 - Reduce the regex backslash removal to keep them in place for
   {}()[] even when not required.

 - Restore some of the single-use variables set from regex matches

Mauro, I have applied your Reviewed-by to everything except patch 10,
hopefully it is more to your liking now.

[Helpful hint for the future: if you are going to make a bunch of
subtle changes to regexes used throughout a patch series, do it at
the end...you'll go through far less rebasing pain that way when you
have to change them... :) ]

Jonathan Corbet (12):
  docs: kdoc: consolidate the stripping of private struct/union members
  docs: kdoc: Move a regex line in dump_struct()
  docs: kdoc: backslashectomy in kdoc_parser
  docs: kdoc: move the prefix transforms out of dump_struct()
  docs: kdoc: split top-level prototype parsing out of dump_struct()
  docs: kdoc: split struct-member rewriting out of dump_struct()
  docs: kdoc: rework the rewrite_struct_members() main loop
  docs: kdoc: remove an extraneous strip() call
  docs: kdoc: Some rewrite_struct_members() commenting
  docs: kdoc: further rewrite_struct_members() cleanup
  docs: kdoc: extract output formatting from dump_struct()
  docs: kdoc: a few final dump_struct() touches

 scripts/lib/kdoc/kdoc_parser.py | 497 +++++++++++++++++---------------
 1 file changed, 258 insertions(+), 239 deletions(-)

-- 
2.50.1

Em Thu,  7 Aug 2025 15:16:27 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> In my ongoing effort to truly understand our new kernel-doc, I continue to
> make changes to improve the code, and to try to make the understanding task
> easier for the next person.  These patches focus on dump_struct() in
> particular, which starts out at nearly 300 lines long - to much to fit into
> my little brain anyway.  Hopefully the result is easier to manage.
> 
> There are no changes in the rendered docs.
> 
> Changes in v2:
> 
>  - Reduce the regex backslash removal to keep them in place for
>    {}()[] even when not required.
> 
>  - Restore some of the single-use variables set from regex matches
> 
> Mauro, I have applied your Reviewed-by to everything except patch 10,
> hopefully it is more to your liking now.

All looks good to me now. Thanks!

I sent a suggestion for a further improvement on patch 10/12 together
with my R-B.

> [Helpful hint for the future: if you are going to make a bunch of
> subtle changes to regexes used throughout a patch series, do it at
> the end...you'll go through far less rebasing pain that way when you
> have to change them... :) ]

Sorry for that! Yet, IMO, the code looks a lot nicer with the regex
changes you did over the past version.

Regards,
Mauro