kernel-doc: suppress 'not described' warnings for embedded struct fields
authorJonathan Corbet <corbet@lwn.net>
Fri, 11 Jan 2019 19:31:39 +0000 (12:31 -0700)
committerJonathan Corbet <corbet@lwn.net>
Wed, 16 Jan 2019 22:04:01 +0000 (15:04 -0700)
commitbe5cd20c9b491504dfb9105404913de25c47c580
treea2ed7f73bcfebe0e8eb99556ca1304c34a98c49f
parent959b49687838c9eae38f19cb19d504ba880b6cd0
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>
scripts/kernel-doc