mirrors/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-12-27 11:06:41 -05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Jonathan Corbet
2025-08-13 11:16:28 -06:00
parent d37366cac4
commit eaae0ad972
4 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/Makefile
View File

@@ -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)

2
MAINTAINERS
View File

@@ -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

2
scripts/documentation-file-ref-check → tools/docs/documentation-file-ref-check
View File

@@ -17,7 +17,7 @@ my %false_positives = (
);
my $scriptname = $0;
$scriptname =~ s,.*/([^/]+/),$1,;
$scriptname =~ s,tools/docs/([^/]+/),$1,;
# Parse arguments
my $help = 0;

2
tools/docs/sphinx-pre-install
View File

@@ -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.
"""