mirror of
https://github.com/raspberrypi/linux.git
synced 2025-12-07 02:19:54 +00:00
docs: kdoc: trim __cacheline_group_* with the other annotations
The special case for __cacheline_group_begin/end() can be handled by just adding another pattern to the struct_prefixes, eliminating the need for a special case in push_parameter(). One change is that these annotations no longer appear in the rendered output, just like all the other annotations that we clean out. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
@@ -90,6 +90,7 @@ struct_prefixes = [
|
||||
(KernRe(r'\s*CRYPTO_MINALIGN_ATTR', re.S), ' '),
|
||||
(KernRe(r'\s*____cacheline_aligned_in_smp', re.S), ' '),
|
||||
(KernRe(r'\s*____cacheline_aligned', re.S), ' '),
|
||||
(KernRe(r'\s*__cacheline_group_(begin|end)\([^\)]+\);'), ''),
|
||||
#
|
||||
# Unwrap struct_group macros based on this definition:
|
||||
# __struct_group(TAG, NAME, ATTRS, MEMBERS...)
|
||||
@@ -447,12 +448,6 @@ class KernelDoc:
|
||||
self.entry.parameterdescs[param] = "anonymous\n"
|
||||
self.entry.anon_struct_union = True
|
||||
|
||||
# Handle cache group enforcing variables: they do not need
|
||||
# to be described in header files
|
||||
elif "__cacheline_group" in param:
|
||||
# Ignore __cacheline_group_begin and __cacheline_group_end
|
||||
return
|
||||
|
||||
# Warn if parameter has no description
|
||||
# (but ignore ones starting with # as these are not parameters
|
||||
# but inline preprocessor statements)
|
||||
|
||||
Reference in New Issue
Block a user