From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CFAD02E5B1E; Fri, 24 Oct 2025 20:08:53 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=45.79.88.28 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336535; cv=none; b=g4kdCgmgsF9SrveKcjATE1gJbPnWKZSFPgQOteCE2zb3AMEJsY2C5RB5lcbrn9lV9TCuozc8EIza7f82aYoq1bB0T/YyBSuLJ4G1jkW2MZkS8X+3To5n6ECpyYMe3E2oKwZILfb5sH1uPoDLWohIE6LlVpAJDrHKdnrVJb7Md8E= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336535; c=relaxed/simple; bh=DkmdZD03tEDIYPmuNfn8kM14uyxWg/1xf0rJpDrJAZE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=NnZwE31ZaPo5s9Y5lu3ETRm6eML+Ip+BdxwKvFi65c9lmJDxkbOlxvHfESE2Ile/343E5TIWOEPT6UqHHRbOXn6wf5mo26cOKZvRNK0qFNL8e1hHsW2u8gwnD3knH+bVEVGqNJtqLWSYqFE7+bEGX5pblniS0tndhmtTwg+Wx0g= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net; spf=pass smtp.mailfrom=lwn.net; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b=swkkFI9P; arc=none smtp.client-ip=45.79.88.28 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="swkkFI9P" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 04FC440C2F DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336530; bh=SLXXvISie5635KSpolRaPdQrJTUSoEUf5MVXYGYQ9bg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=swkkFI9PgR7iDm1m/zsmRbv8CrrY+JnJ9YybXTy4nUVVU63SdUC0gWl4GY2tfsif0 /6rZYMd7lGnionuxYX2COxgbJDMsBOh/IBzRmwLb1CvQiIu4Tuh3BKm94yqyGh837s o1zQfrcj1Zfmt4McfrTcPMmuxQobo2/sPjdhDrnO0vxpcUu/x+2hysyrCDFIC6gh4O nLnHF09J1UD81o8QP9xUIJbeHeqdNS1WIEFlpSLni3rtgpsrYRZyNzvo3NaY8EgiC4 7UYDvXDKLPP9q/QXPR9mf4w8PkO8L8PPwoJkhYHYllU8MQ4d0QJ3waaIZhiYKnRUPI E2orZjmfUkQYQ== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 04FC440C2F; Fri, 24 Oct 2025 20:08:49 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 7/8] docs: move find-unused-docs.sh to tools/docs Date: Fri, 24 Oct 2025 14:08:28 -0600 Message-ID: <20251024200834.20644-8-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-1-corbet@lwn.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ...and update references accordingly. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet --- Documentation/doc-guide/contributing.rst | 2 +- Documentation/translations/zh_CN/doc-guide/contributing.rst | 2 +- {scripts => tools/docs}/find-unused-docs.sh | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) rename {scripts => tools/docs}/find-unused-docs.sh (85%) diff --git a/Documentation/doc-guide/contributing.rst b/Documentation/doc-guide/contributing.rst index 662c7a840cd5..f8047e633113 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/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 diff --git a/Documentation/translations/zh_CN/doc-guide/contributing.rst b/Documentation/translations/zh_CN/doc-guide/contributing.rst index 394a13b438b0..b0c8ba782b16 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/docs/find-unused-docs.sh`` 工具可以用来找到这些被忽略的评论。 请注意，将导出的函数和数据结构引入文档是最有价值的。许多子系统还具有供内部 使用的kernel-doc注释；除非这些注释放在专门针对相关子系统开发人员的文档中， diff --git a/scripts/find-unused-docs.sh b/tools/docs/find-unused-docs.sh similarity index 85% rename from scripts/find-unused-docs.sh rename to tools/docs/find-unused-docs.sh index 1fb265a0ffd0..2f2195a77c60 100755 --- a/scripts/find-unused-docs.sh +++ b/tools/docs/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/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 -- 2.51.0