path: root/Documentation/Makefile
diff options
authorJani Nikula <>2017-10-09 18:26:15 +0300
committerJonathan Corbet <>2017-10-12 11:07:42 -0600
commite8939222dced668fc5cae02b0b601af069801107 (patch)
tree96a0758ef47ea1a5f876a87abf28b0849780a656 /Documentation/Makefile
parent8d73c512e648bee83b912733876b9b4071353265 (diff)
Documentation: add script and build target to check for broken file references
Add a simple script and build target to do a treewide grep for references to files under Documentation, and report the non-existing file in stderr. It tries to take into account punctuation not part of the filename, and wildcards, but there are bound to be false positives too. Mostly seems accurate though. We've moved files around enough to make having this worthwhile. Signed-off-by: Jani Nikula <> Signed-off-by: Jonathan Corbet <>
Diffstat (limited to 'Documentation/Makefile')
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 5e65fa5c6ab7..2ca77ad0f238 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -97,6 +97,9 @@ endif # HAVE_SPHINX
# The following targets are independent of HAVE_SPHINX, and the rules should
# work or silently pass without Sphinx.
+ $(Q)cd $(srctree);scripts/documentation-file-ref-check
$(Q)rm -rf $(BUILDDIR)
$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean
@@ -109,6 +112,7 @@ dochelp:
@echo ' epubdocs - EPUB'
@echo ' xmldocs - XML'
@echo ' linkcheckdocs - check for broken external links (will connect to external hosts)'
+ @echo ' refcheckdocs - check for references to non-existing files under Documentation'
@echo ' cleandocs - clean all generated files'
@echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'