doc: test linkgit macros for well-formedness and existence of target

Some readers of man pages have reported that they found malformed linkgit
macros in the documentation. This commit adds a test to check that all links
to other man pages are made with the linkgit macro, and that the target of
the linkgit macro exists.

Signed-off-by: Jean-Noël Avila <[email protected]>

Author: jnavila

Documentation/gitweb.conf.adoc

@@ -178,7 +178,7 @@ $export_ok::
 	Show repository only if this file exists (in repository).  Only
 	effective if this variable evaluates to true.  Can be set when
 	building gitweb by setting `GITWEB_EXPORT_OK`.  This path is
-	relative to `GIT_DIR`.  git-daemon[1] uses 'git-daemon-export-ok',
+	relative to `GIT_DIR`.  linkgit:git-daemon[1] uses 'git-daemon-export-ok',
 	unless started with `--export-all`.  By default this variable is
 	not set, which means that this feature is turned off.
 

t/meson.build

@@ -152,6 +152,7 @@ integration_tests = [
   't0410-partial-clone.sh',
   't0411-clone-from-partial.sh',
   't0450-txt-doc-vs-help.sh',
+  't0451-well-formed-doc.sh',
   't0500-progress-display.sh',
   't0600-reffiles-backend.sh',
   't0601-reffiles-pack-refs.sh',

t/t0451-well-formed-doc.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+test_description='basic doc format sanity check'
+
+. ./test-lib.sh
+
+test_expect_success 'linkgit macros are well formed' '
+	(cd $GIT_BUILD_DIR && git grep -r '\''git[-a-z]*\[[0-9]'\'' -- '\''Documentation/**.adoc'\'') | sed -e '\''/linkgit:git/ d'\'' > out &&
+	test_must_be_empty out
+'
+
+test_expect_success 'linkgit macros point to existing files' '
+	for f in $(cd $GIT_BUILD_DIR && git grep -Ero '\''(linkgit:)[-a-z0-9{}]*'\'' -- '\''Documentation/**.adoc'\'' | cut -f3 -d:| sed -e '\''s/{litdd}/--/g'\'')
+	do
+		test_path_is_file $GIT_BUILD_DIR/Documentation/${f}.adoc || return 1
+	done
+'
+
+test_done