diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2019-01-11 12:31:39 -0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2019-01-16 15:04:01 -0700 |
| commit | be5cd20c9b491504dfb9105404913de25c47c580 (patch) | |
| tree | a2ed7f73bcfebe0e8eb99556ca1304c34a98c49f | |
| parent | 959b49687838c9eae38f19cb19d504ba880b6cd0 (diff) | |
| download | linux-be5cd20c9b491504dfb9105404913de25c47c580.tar.bz2 | |
kernel-doc: suppress 'not described' warnings for embedded struct fields
The ability to add kerneldoc comments for fields in embedded structures is
useful, but it brought along a whole bunch of warnings for fields that
could not be described before. In many cases, there's little value in
adding docs for these nested fields, and in cases like:
struct a {
struct b {
int c;
} d, e;
};
"c" would have to be described twice (as d.c and e.c) to make the warnings
go away.
We can no doubt do something smarter, but simply suppressing the warnings
for this case removes about 70 warnings from the docs build, freeing us to
focus on the ones that matter more. So make kerneldoc be silent about
missing descriptions for any field containing a ".".
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rwxr-xr-x | scripts/kernel-doc | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index c5333d251985..3350e498b4ce 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -1474,7 +1474,7 @@ sub push_parameter($$$$) { if (!defined $parameterdescs{$param} && $param !~ /^#/) { $parameterdescs{$param} = $undescribed; - if (show_warnings($type, $declaration_name)) { + if (show_warnings($type, $declaration_name) && $param !~ /\./) { print STDERR "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; ++$warnings; |