wireguard-linux/scripts/lib/kdoc, branch stableWireGuard for the Linux kernelhttps://git.zx2c4.com/wireguard-linux/atom/scripts/lib/kdoc?h=stable2025-09-18T16:19:54Zdocs: kdoc: a few more dump_typedef() tweaks2025-09-18T16:19:54ZJonathan Corbetcorbet@lwn.net2025-09-08T23:12:14Zurn:sha1:c01878437739f86851da76235f394346c6bd8ce3
Merge "typedef" into the typedef_type pattern rather than repeating it
later, and add some comments.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove redundant comment stripping in dump_typedef()2025-09-18T16:19:54ZJonathan Corbetcorbet@lwn.net2025-09-08T22:49:58Zurn:sha1:00fa9bc4e93cb336575a5f2c1da90d2443ff14c8
By the time we get here, comments have long since been stripped out; there
is no need to do it again.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove some dead code in dump_typedef()2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-08T22:32:10Zurn:sha1:999a642d7e7d4241cc7dba942a13c67d0685284b
The regex in this block of code makes no sense, and a quick test shows that
it never matches anything; simply delete the code.
No output changes.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: final dump_function() cleanups2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-08T22:21:28Zurn:sha1:3dff54410e56ddee2dad8824ea77e60cd5b16d5b
Add some more comments to dump_function(), add some comments, and trim out
an unneeded duplicate output_declaration() call.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: consolidate some of the macro-processing logic2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-08T22:01:15Zurn:sha1:370f430527ecd35938ad94167e45fc784f6e4d95
The logic to handle macros is split in dump_function(); bring it all
together into a single place and add a comment saying what's going on.
Remove the unneeded is_define_proto variable, and tighten up the code
a bit.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: Simplify the dump_function() prototype regexes2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-08T19:22:42Zurn:sha1:ff1f2af341b72bd5b6b5d432da55faf2f6d24cfe
The regexes for the parsing of function prototypes were more complicated
than they needed to be and difficult to understand -- at least, I spent a
fair amount of time bashing my head against them. Simplify them, and add
some documentation comments as well.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove a useless empty capture group2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-05T22:30:48Zurn:sha1:08b5228cf455d46a23bfb341766563d1a48e3c8f
The is_define_proto case in dump_function() uses a regex with an empty
capture group - () - that has no use; just take it out.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove a couple of spurious regex characters2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-05T21:53:05Zurn:sha1:fee63c8f10c2fe77f618f9955c2f5521ff9cc622
The "name" regex in dump_function() includes both the tilde and colon
characters, but neither has any place in function prototypes. Remove the
characters, after which the regex simplifies to "\w+"
No output changes.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
doc: kdoc: unify transform handling2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-04T22:49:52Zurn:sha1:a2752f8c631201e189f501fc4d320354efa3e72e
Both functions and structs are passed through a set of regex-based
transforms, but the two were structured differently, despite being the same
thing. Create a utility function to apply transformations and use it in
both cases.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: move the function transform patterns out of dump_function()2025-09-18T16:19:53ZJonathan Corbetcorbet@lwn.net2025-09-04T22:40:49Zurn:sha1:4c232a81b0831e7bfa7518968e431d5db29b2cac
Move these definitions to file level, where they are executed once, and
don't clutter the function itself.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>