linux-kernel - Re: [PATCH 12/13] docs: move find-unused-docs.sh to tools/doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250814015040.09db5b0c@foz.lan>
Date: Thu, 14 Aug 2025 01:50:40 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Akira Yokosawa
 <akiyks@...il.com>, Randy Dunlap <rdunlap@...radead.org>
Subject: Re: [PATCH 12/13] docs: move find-unused-docs.sh to tools/doc

Em Wed, 13 Aug 2025 15:32:11 -0600
Jonathan Corbet <corbet@....net> escreveu:

> ...and update references accordingly.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

> 
> Signed-off-by: Jonathan Corbet <corbet@....net>
> ---
>  Documentation/doc-guide/contributing.rst                    | 2 +-
>  Documentation/translations/zh_CN/doc-guide/contributing.rst | 2 +-
>  {scripts => tools/doc}/find-unused-docs.sh                  | 6 +++---
>  3 files changed, 5 insertions(+), 5 deletions(-)
>  rename {scripts => tools/doc}/find-unused-docs.sh (85%)
> 
> diff --git a/Documentation/doc-guide/contributing.rst b/Documentation/doc-guide/contributing.rst
> index 662c7a840cd5..81633c6c6c11 100644
> --- a/Documentation/doc-guide/contributing.rst
> +++ b/Documentation/doc-guide/contributing.rst
> @@ -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/doc/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
> diff --git a/Documentation/translations/zh_CN/doc-guide/contributing.rst b/Documentation/translations/zh_CN/doc-guide/contributing.rst
> index 394a13b438b0..d205f8ed9fce 100644
> --- a/Documentation/translations/zh_CN/doc-guide/contributing.rst
> +++ b/Documentation/translations/zh_CN/doc-guide/contributing.rst
> @@ -124,7 +124,7 @@ C代码编译器发出的警告常常会被视为误报，从而导致出现了
>  这使得这些信息更难找到，例如使Sphinx无法生成指向该文档的链接。将 ``kernel-doc``
>  指令添加到文档中以引入这些注释可以帮助社区获得为编写注释所做工作的全部价值。
>  
> -``scripts/find-unused-docs.sh`` 工具可以用来找到这些被忽略的评论。
> +``tools/doc/find-unused-docs.sh`` 工具可以用来找到这些被忽略的评论。
>  
>  请注意，将导出的函数和数据结构引入文档是最有价值的。许多子系统还具有供内部
>  使用的kernel-doc注释；除非这些注释放在专门针对相关子系统开发人员的文档中，
> diff --git a/scripts/find-unused-docs.sh b/tools/doc/find-unused-docs.sh
> similarity index 85%
> rename from scripts/find-unused-docs.sh
> rename to tools/doc/find-unused-docs.sh
> index 0ae445dec2e4..a64389a15f09 100755
> --- a/scripts/find-unused-docs.sh
> +++ b/tools/doc/find-unused-docs.sh
> @@ -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/doc/find-unused-docs.sh directory' from top level of kernel
>  # 	 tree.
>  #
> -# example: $scripts/find-unused-docs.sh drivers/scsi
> +# example: $tools/doc/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/doc/find-unused-docs.sh directory"
>  	exit 1
>  fi
>  



Thanks,
Mauro