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
8ifneq ($(MAKECMDGOALS),cleandocs)8ifneq ($(MAKECMDGOALS),cleandocs)
9# Check for broken documentation file references9# Check for broken documentation file references
10ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)10ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
11$(shell $(srctree)/scripts/documentation-file-ref-check --warn)11$(shell $(srctree)/tools/docs/documentation-file-ref-check --warn)
12endif12endif
13 13
14# Check for broken ABI files14# Check for broken ABI files
@@ -78,7 +78,7 @@ htmldocs-redirects: $(srctree)/Documentation/.renames.txt · 63 unmodified lines
78 @tools/docs/gen-redirects.py --output $(BUILDDIR) < $<78 @tools/docs/gen-redirects.py --output $(BUILDDIR) < $<
79 79
80refcheckdocs:80refcheckdocs:
81 $(Q)cd $(srctree);scripts/documentation-file-ref-check81 $(Q)cd $(srctree); tools/docs/documentation-file-ref-check
82 82
83cleandocs:83cleandocs:
84 $(Q)rm -rf $(BUILDDIR)84 $(Q)rm -rf $(BUILDDIR)
MAINTAINERS+0−2
@@ -7411,7 +7411,6 @@ S: Maintained · 7410 unmodified lines
7411P: Documentation/doc-guide/maintainer-profile.rst7411P: Documentation/doc-guide/maintainer-profile.rst
7412T: git git://git.lwn.net/linux.git docs-next7412T: git git://git.lwn.net/linux.git docs-next
7413F: Documentation/7413F: Documentation/
7414F: scripts/documentation-file-ref-check
7415F: scripts/get_abi.py7414F: scripts/get_abi.py
7416F: scripts/kernel-doc*7415F: scripts/kernel-doc*
7417F: scripts/lib/abi/*7416F: scripts/lib/abi/*
@@ -7451,7 +7450,6 @@ M: Mauro Carvalho Chehab <mchehab@kernel.org> · 33 unmodified lines
7451L: linux-doc@vger.kernel.org7450L: linux-doc@vger.kernel.org
7452S: Maintained7451S: Maintained
7453F: Documentation/sphinx/parse-headers.pl7452F: Documentation/sphinx/parse-headers.pl
7454F: scripts/documentation-file-ref-check
7455F: tools/docs/sphinx-pre-install7453F: tools/docs/sphinx-pre-install
7456 7454
7457DOCUMENTATION/ITALIAN7455DOCUMENTATION/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
17);17);
18 18
19my $scriptname = $0;19my $scriptname = $0;
20$scriptname =~ s,.*/([^/]+/),$1,;20$scriptname =~ s,tools/docs/([^/]+/),$1,;
21 21
22# Parse arguments22# Parse arguments
23my $help = 0;23my $help = 0;
tools/docs/sphinx-pre-install+1−1
@@ -313,7 +313,7 @@ class MissingCheckers(AncillaryMethods): · 312 unmodified lines
313 Right now, we still need Perl for doc build, as it is required313 Right now, we still need Perl for doc build, as it is required
314 by some tools called at docs or kernel build time, like:314 by some tools called at docs or kernel build time, like:
315 315
316 scripts/documentation-file-ref-check316 tools/docs/documentation-file-ref-check
317 317
318 Also, checkpatch is on Perl.318 Also, checkpatch is on Perl.
319 """319 """