Add this script to the growing collection of documentation tools.
Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
---
Documentation/Makefile | 4 ++--
MAINTAINERS | 3 +--
scripts/sphinx-pre-install | 2 +-
{scripts => tools/doc}/documentation-file-ref-check | 2 +-
4 files changed, 5 insertions(+), 6 deletions(-)
rename {scripts => tools/doc}/documentation-file-ref-check (99%)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 70095465dce1..f7b8342f9666 100644
--- 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/doc/documentation-file-ref-check --warn)
endif
# Check for broken ABI files
@@ -167,7 +167,7 @@ endif # HAVE_SPHINX
# work or silently pass without Sphinx.
refcheckdocs:
- $(Q)cd $(srctree);scripts/documentation-file-ref-check
+ $(Q)cd $(srctree); tools/doc/documentation-file-ref-check
cleandocs:
$(Q)rm -rf $(BUILDDIR)
diff --git a/MAINTAINERS b/MAINTAINERS
index ca4c7992369d..ec9872642597 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7302,7 +7302,6 @@ P: Documentation/doc-guide/maintainer-profile.rst
T: git git://git.lwn.net/linux.git docs-next
F: Documentation/
F: tools/doc/
-F: scripts/documentation-file-ref-check
F: scripts/get_abi.py
F: scripts/kernel-doc*
F: scripts/lib/abi/*
@@ -7342,7 +7341,7 @@ M: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
L: linux-doc@xxxxxxxxxxxxxxx
S: Maintained
F: Documentation/sphinx/parse-headers.pl
-F: scripts/documentation-file-ref-check
+F: tools/doc/
F: scripts/sphinx-pre-install
DOCUMENTATION/ITALIAN
diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
index b8474848df4e..5d006a037428 100755
--- a/scripts/sphinx-pre-install
+++ b/scripts/sphinx-pre-install
@@ -406,7 +406,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/doc/documentation-file-ref-check
Also, checkpatch is on Perl.
"""
diff --git a/scripts/documentation-file-ref-check b/tools/doc/documentation-file-ref-check
similarity index 99%
rename from scripts/documentation-file-ref-check
rename to tools/doc/documentation-file-ref-check
index 408b1dbe7884..2dc53f5661b1 100755
--- a/scripts/documentation-file-ref-check
+++ b/tools/doc/documentation-file-ref-check
@@ -17,7 +17,7 @@ my %false_positives = (
);
my $scriptname = $0;
-$scriptname =~ s,.*/([^/]+/),$1,;
+$scriptname =~ s,tools/doc/([^/]+/),$1,;
# Parse arguments
my $help = 0;
--
2.50.1
