| # (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 |
| # 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" |
| echo "Usage: scripts/find-unused-docs.sh directory" |
| echo "Directory $1 doesn't exist" |
| cd "$( dirname "${BASH_SOURCE[0]}" )" |
| echo "The following files contain kerneldoc comments for exported functions \ |
| that are not used in the formatted documentation" |
| 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" |
| for file in `find $1 -name '*.c'`; do |
| if [[ ${FILES_INCLUDED[$file]+_} ]]; then |
| str=$(scripts/kernel-doc -text -export "$file" 2>/dev/null) |