2 # (c) 2017, Jonathan Corbet <corbet@lwn.net>
3 # sayli karnik <karniksayli1995@gmail.com>
5 # This script detects files with kernel-doc comments for exported functions
6 # that are not included in documentation.
8 # usage: Run 'scripts/find-unused-docs.sh directory' from top level of kernel
11 # example: $scripts/find-unused-docs.sh drivers/scsi
13 # Licensed under the terms of the GNU GPL License
15 if ! [ -d "Documentation" ]; then
16 echo "Run from top level of kernel tree"
20 if [ "$#" -ne 1 ]; then
21 echo "Usage: scripts/find-unused-docs.sh directory"
25 if ! [ -d "$1" ]; then
26 echo "Directory $1 doesn't exist"
30 cd "$( dirname "${BASH_SOURCE[0]}" )"
35 echo "The following files contain kerneldoc comments for exported functions \
36 that are not used in the formatted documentation"
40 files_included=($(grep -rHR ".. kernel-doc" --include \*.rst | cut -d " " -f 3))
42 declare -A FILES_INCLUDED
44 for each in "${files_included[@]}"; do
45 FILES_INCLUDED[$each]="$each"
52 for file in `find $1 -name '*.c'`; do
54 if [[ ${FILES_INCLUDED[$file]+_} ]]; then
57 str=$(scripts/kernel-doc -export "$file" 2>/dev/null)
58 if [[ -n "$str" ]]; then