aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorCoco Li <lixiaoyan@google.com>2023-11-29 07:27:53 +0000
committerDavid S. Miller <davem@davemloft.net>2023-12-02 22:24:36 +0000
commitaeb9ce058d7c6193dc41e06b3a5b29d22c446b14 (patch)
tree3047cfd71da52b78f77f397ae3fbad4abee7267f /scripts/kernel-doc
parentDocumentations: Analyze heavily used Networking related structs (diff)
downloadwireguard-linux-aeb9ce058d7c6193dc41e06b3a5b29d22c446b14.tar.xz
wireguard-linux-aeb9ce058d7c6193dc41e06b3a5b29d22c446b14.zip
cache: enforce cache groups
Set up build time warnings to safeguard against future header changes of organized structs. Warning includes: 1) whether all variables are still in the same cache group 2) whether all the cache groups have the sum of the members size (in the maximum condition, including all members defined in configs) The __cache_group* variables are ignored in kernel-doc check in the various header files they appear in to enforce the cache groups. Suggested-by: Daniel Borkmann <daniel@iogearbox.net> Acked-by: Daniel Borkmann <daniel@iogearbox.net> Signed-off-by: Coco Li <lixiaoyan@google.com> Reviewed-by: Eric Dumazet <edumazet@google.com> Reviewed-by: Shakeel Butt <shakeelb@google.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc5
1 files changed, 5 insertions, 0 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 08a3e603db19..0a890fe4d22b 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1592,6 +1592,11 @@ sub push_parameter($$$$$) {
$parameterdescs{$param} = "anonymous\n";
$anon_struct_union = 1;
}
+ elsif ($param =~ "__cacheline_group" )
+ # handle cache group enforcing variables: they do not need be described in header files
+ {
+ return; # ignore __cacheline_group_begin and __cacheline_group_end
+ }
# warn if parameter has no description
# (but ignore ones starting with # as these are not parameters