]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commit - scripts/kernel-doc
scripts/kernel-doc: Don't fail with status != 0 if error encountered with -none
authorWill Deacon <will.deacon@arm.com>
Wed, 29 Nov 2017 15:20:03 +0000 (15:20 +0000)
committerJonathan Corbet <corbet@lwn.net>
Sat, 2 Dec 2017 15:32:04 +0000 (08:32 -0700)
commite814bccbafece52a24e152d2395b5d49eef55841
treef486e77f2e538fbed725309e297f8cb0a1da5790
parent4fbd8d194f06c8a3fd2af1ce560ddb31f7ec8323
scripts/kernel-doc: Don't fail with status != 0 if error encountered with -none

My bisect scripts starting running into build failures when trying to
compile 4.15-rc1 with the builds failing with things like:

drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c:2078: error: Cannot parse struct or union!

The line in question is actually just a #define, but after some digging
it turns out that my scripts pass W=1 and since commit 3a025e1d1c2ea
("Add optional check for bad kernel-doc comments") that results in
kernel-doc running on each source file. The file in question has a
badly formatted comment immediately before the #define:

/**
 * struct brcmf_skbuff_cb reserves first two bytes in sk_buff::cb for
 * bus layer usage.
 */

which causes the regex in dump_struct to fail (lack of braces following
struct declaration) and kernel-doc returns 1, which causes the build
to fail.

Fix the issue by always returning 0 from kernel-doc when invoked with
-none. It successfully generates no documentation, and prints out any
issues.

Cc: Matthew Wilcox <mawilcox@microsoft.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Will Deacon <will.deacon@arm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc