[PATCH] scripts/find-unused-docs: Fix massive false positives

[PATCH] scripts/find-unused-docs: Fix massive false positives

[Geert Uytterhoeven]

scripts/find-unused-docs.sh invokes scripts/kernel-doc to find out if a
source file contains kerneldoc or not.

However, as it passes the no longer supported "-text" option to
scripts/kernel-doc, the latter prints out its help text, causing all
files to be considered containing kerneldoc.

Get rid of these false positives by removing the no longer supported
"-text" option from the scripts/kernel-doc invocation.

Fixes: b05142675310d2ac ("scripts: kernel-doc: get rid of unused output formats")
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
Triggered by https://lwn.net/Articles/810404/

 scripts/find-unused-docs.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh
index 3f46f8977dc4dc88..ee6a50e33aba805d 100755
--- a/scripts/find-unused-docs.sh
+++ b/scripts/find-unused-docs.sh
@@ -54,7 +54,7 @@ for file in `find $1 -name '*.c'`; do
 	if [[ ${FILES_INCLUDED[$file]+_} ]]; then
 	continue;
 	fi
-	str=$(scripts/kernel-doc -text -export "$file" 2>/dev/null)
+	str=$(scripts/kernel-doc -export "$file" 2>/dev/null)
 	if [[ -n "$str" ]]; then
 	echo "$file"
 	fi
-- 
2.17.1

Re: [PATCH] scripts/find-unused-docs: Fix massive false positives

[Jonathan Corbet]

On Mon, 27 Jan 2020 10:31:07 +0100
Geert Uytterhoeven <geert+renesas@glider.be> wrote:

> scripts/find-unused-docs.sh invokes scripts/kernel-doc to find out if a
> source file contains kerneldoc or not.
> 
> However, as it passes the no longer supported "-text" option to
> scripts/kernel-doc, the latter prints out its help text, causing all
> files to be considered containing kerneldoc.
> 
> Get rid of these false positives by removing the no longer supported
> "-text" option from the scripts/kernel-doc invocation.
> 
> Fixes: b05142675310d2ac ("scripts: kernel-doc: get rid of unused output formats")
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Sigh, I guess I should have tried that script before telling people to use
it.  Thanks for the fix; I've applied it with a CC: stable tag.

jon