docs: move scripts/documentation-file-ref-check to tools/docs

Add this script to the growing collection of documentation tools.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 65d184eab739479a05770b32054ed9376656deaa..1476aa1701ce8993c976d1a59440c9bece77fa34 100644 (file)
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -8,7 +8,7 @@ subdir- := devicetree/bindings
 ifneq ($(MAKECMDGOALS),cleandocs)
 # Check for broken documentation file references
 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
-$(shell $(srctree)/scripts/documentation-file-ref-check --warn)
+$(shell $(srctree)/tools/docs/documentation-file-ref-check --warn)
 endif
 
 # Check for broken ABI files
@@ -78,7 +78,7 @@ htmldocs-redirects: $(srctree)/Documentation/.renames.txt
        @tools/docs/gen-redirects.py --output $(BUILDDIR) < $<
 
 refcheckdocs:
-       $(Q)cd $(srctree);scripts/documentation-file-ref-check
+       $(Q)cd $(srctree); tools/docs/documentation-file-ref-check
 
 cleandocs:
        $(Q)rm -rf $(BUILDDIR)

diff --git a/MAINTAINERS b/MAINTAINERS
index cd187b9f1dc2c68ebd64a09d01ebe7d67b428524..fc1da52433b6afd0bd153306040ca3a5d1307175 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7411,7 +7411,6 @@ S:        Maintained
 P:     Documentation/doc-guide/maintainer-profile.rst
 T:     git git://git.lwn.net/linux.git docs-next
 F:     Documentation/
-F:     scripts/documentation-file-ref-check
 F:     scripts/get_abi.py
 F:     scripts/kernel-doc*
 F:     scripts/lib/abi/*
@@ -7451,7 +7450,6 @@ M:        Mauro Carvalho Chehab <mchehab@kernel.org>
 L:     linux-doc@vger.kernel.org
 S:     Maintained
 F:     Documentation/sphinx/parse-headers.pl
-F:     scripts/documentation-file-ref-check
 F:     tools/docs/sphinx-pre-install
 
 DOCUMENTATION/ITALIAN

diff --git a/scripts/documentation-file-ref-check b/tools/docs/documentation-file-ref-check
similarity index 99%
rename from scripts/documentation-file-ref-check
rename to tools/docs/documentation-file-ref-check
index 408b1dbe78841e2a076eacd09e42ac4bc0a0a04e..0cad42f6943b9c014976918a6da0f22119b5dc06 100755 (executable)
--- a/scripts/documentation-file-ref-check
+++ b/tools/docs/documentation-file-ref-check
@@ -17,7 +17,7 @@ my %false_positives = (
 );
 
 my $scriptname = $0;
-$scriptname =~ s,.*/([^/]+/),$1,;
+$scriptname =~ s,tools/docs/([^/]+/),$1,;
 
 # Parse arguments
 my $help = 0;

diff --git a/tools/docs/sphinx-pre-install b/tools/docs/sphinx-pre-install
index 698989584b6af91959bcdeb4401462485384b6bb..647e1f60357f1e6ad256d71be2d82fbe45ffb3a6 100755 (executable)
--- a/tools/docs/sphinx-pre-install
+++ b/tools/docs/sphinx-pre-install
@@ -313,7 +313,7 @@ class MissingCheckers(AncillaryMethods):
         Right now, we still need Perl for doc build, as it is required
         by some tools called at docs or kernel build time, like:
 
-            scripts/documentation-file-ref-check
+            tools/docs/documentation-file-ref-check
 
         Also, checkpatch is on Perl.
         """