diff options
author | sayli karnik <karniksayli1995@gmail.com> | 2017-09-09 18:56:18 +0200 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2017-10-23 16:01:37 +0200 |
commit | 45653c845b0c670b7a194acc6a90bc70aa049252 (patch) | |
tree | 947f35eeb45edd1d95a5432f4f0128b8020c36f3 /scripts/find-unused-docs.sh | |
parent | samples: Convert timers to use timer_setup() (diff) | |
download | linux-45653c845b0c670b7a194acc6a90bc70aa049252.tar.xz linux-45653c845b0c670b7a194acc6a90bc70aa049252.zip |
scripts: Add a script to find unused documentation
Add a script that finds files with kernel-doc comments for imported functions
that are not included anywhere in documentation.
Signed-off-by: sayli karnik <karniksayli1995@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/find-unused-docs.sh')
-rwxr-xr-x | scripts/find-unused-docs.sh | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh new file mode 100755 index 000000000000..3f46f8977dc4 --- /dev/null +++ b/scripts/find-unused-docs.sh @@ -0,0 +1,62 @@ +#!/bin/bash +# (c) 2017, Jonathan Corbet <corbet@lwn.net> +# sayli karnik <karniksayli1995@gmail.com> +# +# This script detects files with kernel-doc comments for exported functions +# that are not included in documentation. +# +# usage: Run 'scripts/find-unused-docs.sh directory' from top level of kernel +# tree. +# +# example: $scripts/find-unused-docs.sh drivers/scsi +# +# Licensed under the terms of the GNU GPL License + +if ! [ -d "Documentation" ]; then + echo "Run from top level of kernel tree" + exit 1 +fi + +if [ "$#" -ne 1 ]; then + echo "Usage: scripts/find-unused-docs.sh directory" + exit 1 +fi + +if ! [ -d "$1" ]; then + echo "Directory $1 doesn't exist" + exit 1 +fi + +cd "$( dirname "${BASH_SOURCE[0]}" )" +cd .. + +cd Documentation/ + +echo "The following files contain kerneldoc comments for exported functions \ +that are not used in the formatted documentation" + +# FILES INCLUDED + +files_included=($(grep -rHR ".. kernel-doc" --include \*.rst | cut -d " " -f 3)) + +declare -A FILES_INCLUDED + +for each in "${files_included[@]}"; do + FILES_INCLUDED[$each]="$each" + done + +cd .. + +# FILES NOT INCLUDED + +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) + if [[ -n "$str" ]]; then + echo "$file" + fi + done + |