mirror of
https://github.com/torvalds/linux.git
synced 2025-11-04 10:40:15 +02:00
5c5c32d7ab
As reported by Andy, kernel-doc.py is creating a __pycache__ directory at build time. Disable creation of __pycache__ for the libraries used by kernel-doc.py, when excecuted via the build system or via scripts/find-unused-docs.sh. Reported-by: Andy Shevchenko <andriy.shevchenko@intel.com> Closes: https://lore.kernel.org/linux-doc/Z_zYXAJcTD-c3xTe@black.fi.intel.com/ Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Tested-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <158b962ed7cd104f7bbfe69f499ec1cc378864db.1745453655.git.mchehab+huawei@kernel.org>
62 lines
1.3 KiB
Bash
Executable file
62 lines
1.3 KiB
Bash
Executable file
#!/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=$(PYTHONDONTWRITEBYTECODE=1 scripts/kernel-doc -export "$file" 2>/dev/null)
|
|
if [[ -n "$str" ]]; then
|
|
echo "$file"
|
|
fi
|
|
done
|
|
|