History

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

Add this script to the growing collection of documentation tools.

Jonathan Corbet committed 1 year ago

Commit eaae0ad1 parent d37366c4 files · +4 −6Browse files

Unified · Split

4 files
  1. Documentation/Makefile +2 −2
  2. MAINTAINERS +0 −2
  3. tools/docs/documentation-file-ref-check +1 −1
  4. tools/docs/sphinx-pre-install +1 −1
Documentation/Makefile+2−2
@@ -8,7 +8,7 @@ subdir- := devicetree/bindings · 7 unmodified lines
88 ifneq ($(MAKECMDGOALS),cleandocs)
99 # Check for broken documentation file references
1010 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
11−$(shell $(srctree)/scripts/documentation-file-ref-check --warn)
11+$(shell $(srctree)/tools/docs/documentation-file-ref-check --warn)
1212 endif
1313
1414 # Check for broken ABI files
@@ -78,7 +78,7 @@ htmldocs-redirects: $(srctree)/Documentation/.renames.txt · 63 unmodified lines
7878 @tools/docs/gen-redirects.py --output $(BUILDDIR) < $<
7979
8080 refcheckdocs:
81− $(Q)cd $(srctree);scripts/documentation-file-ref-check
81+ $(Q)cd $(srctree); tools/docs/documentation-file-ref-check
8282
8383 cleandocs:
8484 $(Q)rm -rf $(BUILDDIR)
MAINTAINERS+0−2
@@ -7411,7 +7411,6 @@ S: Maintained · 7410 unmodified lines
74117411 P: Documentation/doc-guide/maintainer-profile.rst
74127412 T: git git://git.lwn.net/linux.git docs-next
74137413 F: Documentation/
7414−F: scripts/documentation-file-ref-check
74157414 F: scripts/get_abi.py
74167415 F: scripts/kernel-doc*
74177416 F: scripts/lib/abi/*
@@ -7451,7 +7450,6 @@ M: Mauro Carvalho Chehab <mchehab@kernel.org> · 33 unmodified lines
74517450 L: linux-doc@vger.kernel.org
74527451 S: Maintained
74537452 F: Documentation/sphinx/parse-headers.pl
7454−F: scripts/documentation-file-ref-check
74557453 F: tools/docs/sphinx-pre-install
74567454
74577455 DOCUMENTATION/ITALIAN
tools/docs/documentation-file-ref-checkrenamed from scripts/documentation-file-ref-check+1−1
@@ -17,7 +17,7 @@ my %false_positives = ( · 16 unmodified lines
1717 );
1818
1919 my $scriptname = $0;
20−$scriptname =~ s,.*/([^/]+/),$1,;
20+$scriptname =~ s,tools/docs/([^/]+/),$1,;
2121
2222 # Parse arguments
2323 my $help = 0;
tools/docs/sphinx-pre-install+1−1
@@ -313,7 +313,7 @@ class MissingCheckers(AncillaryMethods): · 312 unmodified lines
313313 Right now, we still need Perl for doc build, as it is required
314314 by some tools called at docs or kernel build time, like:
315315
316− scripts/documentation-file-ref-check
316+ tools/docs/documentation-file-ref-check
317317
318318 Also, checkpatch is on Perl.
319319 """