Commit 184414c6 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

docs: move find-unused-docs.sh to tools/docs 



...and update references accordingly.

Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f1c2db1f

Documentation/doc-guide/contributing.rst

+1 −1
Original line number Diff line number Diff line
@@ -152,7 +152,7 @@ generate links to that documentation. Adding ``kernel-doc`` directives to 
the documentation to bring those comments in can help the community derive

the full value of the work that has gone into creating them.



The ``scripts/find-unused-docs.sh`` tool can be used to find these

The ``tools/docs/find-unused-docs.sh`` tool can be used to find these

overlooked comments.



Note that the most value comes from pulling in the documentation for

Documentation/translations/zh_CN/doc-guide/contributing.rst

+1 −1
Original line number Diff line number Diff line
@@ -124,7 +124,7 @@ C代码编译器发出的警告常常会被视为误报，从而导致出现了 
这使得这些信息更难找到，例如使Sphinx无法生成指向该文档的链接。将 ``kernel-doc``

指令添加到文档中以引入这些注释可以帮助社区获得为编写注释所做工作的全部价值。



``scripts/find-unused-docs.sh`` 工具可以用来找到这些被忽略的评论。

``tools/docs/find-unused-docs.sh`` 工具可以用来找到这些被忽略的评论。



请注意，将导出的函数和数据结构引入文档是最有价值的。许多子系统还具有供内部

使用的kernel-doc注释；除非这些注释放在专门针对相关子系统开发人员的文档中，

scripts/find-unused-docs.sh→tools/docs/find-unused-docs.sh

+3 −3
Original line number Diff line number Diff line
@@ -5,10 +5,10 @@ 
# 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

# usage: Run 'tools/docs/find-unused-docs.sh directory' from top level of kernel

# 	 tree.

#

# example: $scripts/find-unused-docs.sh drivers/scsi

# example: $tools/docs/find-unused-docs.sh drivers/scsi

#

# Licensed under the terms of the GNU GPL License
@@ -18,7 +18,7 @@ if ! [ -d "Documentation" ]; then 
fi



if [ "$#" -ne 1 ]; then

	echo "Usage: scripts/find-unused-docs.sh directory"

	echo "Usage: tools/docs/find-unused-docs.sh directory"

	exit 1

fi