Commit eaae0ad9 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

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



Add this script to the growing collection of documentation tools.

Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent d37366ca

Documentation/Makefile

+2 −2
Original line number Diff line number Diff line
@@ -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)

MAINTAINERS

+0 −2
Original line number Diff line number Diff line
@@ -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
































scripts/documentation-file-ref-check→tools/docs/documentation-file-ref-check



+1
−1






























Original line number
Diff line number
Diff line







@@ -17,7 +17,7 @@ my %false_positives = (







);



















my $scriptname = $0;









$scriptname =~ s,.*/([^/]+/),$1,;









$scriptname =~ s,tools/docs/([^/]+/),$1,;



















# Parse arguments









my $help = 0;
































tools/docs/sphinx-pre-install



+1
−1






























Original line number
Diff line number
Diff line







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









        """