docs: Automatically link fuzzer/minitest README.md files.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
mithro · Apr 4, 2019 · 6451f6e · 6451f6e
1 parent bab4c6a
commit 6451f6e
Show file tree

Hide file tree

Showing 30 changed files with 41 additions and 29 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1 +1,3 @@
 _build
+db_dev_process/fuzzers/*.md
+db_dev_process/minitests/*.md
diff --git a/docs/Makefile b/docs/Makefile
@@ -18,7 +18,45 @@ livehtml:
 
 .PHONY: help livereload Makefile
 
+# Update fuzzer / minitest markdown links.
+fuzzers-links:
+	@cd db_dev_process/fuzzers; rm -f *.md
+	@cd db_dev_process/fuzzers; \
+		for i in ../../../fuzzers/*; do \
+			if [ ! -d $$i ]; then \
+				continue; \
+			fi; \
+			if [ -e $$i/README.md ]; then \
+				echo "Linking $$i/README.md"; \
+				ln -s $$i/README.md $$(basename $$i).md; \
+			else \
+				echo "Missing $$i/README.md"; \
+				echo -e "# $$(basename $$i)\n\nMissing README.md!" > $$(basename $$i).md; \
+			fi; \
+		done
+
+minitests-links:
+	@cd db_dev_process/minitests; rm -f *.md
+	@cd db_dev_process/minitests; \
+		for i in ../../../minitests/*; do \
+			if [ ! -d $$i ]; then \
+				continue; \
+			fi; \
+			if [ -e $$i/README.md ]; then \
+				echo "Linking $$i/README.md"; \
+				ln -s $$i/README.md $$(basename $$i).md; \
+			else \
+				echo "Missing $$i/README.md"; \
+				echo -e "# $$(basename $$i)\n\nMissing README.md!" > $$(basename $$i).md; \
+			fi; \
+		done
+
+links: fuzzers-links minitests-links
+	@true
+
+.PHONY: fuzzers-links minitests-links links
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: Makefile links
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/db_dev_process/fuzzers/011-ffconfig.md b/docs/db_dev_process/fuzzers/011-ffconfig.md
diff --git a/docs/db_dev_process/fuzzers/012-clbn5ffmux.md b/docs/db_dev_process/fuzzers/012-clbn5ffmux.md
diff --git a/docs/db_dev_process/fuzzers/013-clbncy0.md b/docs/db_dev_process/fuzzers/013-clbncy0.md
diff --git a/docs/db_dev_process/fuzzers/014-ffsrcemux.md b/docs/db_dev_process/fuzzers/014-ffsrcemux.md
diff --git a/docs/db_dev_process/fuzzers/015-clbnffmux.md b/docs/db_dev_process/fuzzers/015-clbnffmux.md
diff --git a/docs/db_dev_process/fuzzers/016-clbnoutmux.md b/docs/db_dev_process/fuzzers/016-clbnoutmux.md
diff --git a/docs/db_dev_process/fuzzers/017-clbprecyinit.md b/docs/db_dev_process/fuzzers/017-clbprecyinit.md
diff --git a/docs/db_dev_process/fuzzers/018-clbram.md b/docs/db_dev_process/fuzzers/018-clbram.md
diff --git a/docs/db_dev_process/fuzzers/019-ndi1mux.md b/docs/db_dev_process/fuzzers/019-ndi1mux.md
diff --git a/docs/db_dev_process/fuzzers/050-intpips.md b/docs/db_dev_process/fuzzers/050-intpips.md
diff --git a/docs/db_dev_process/fuzzers/051-imuxlout.md b/docs/db_dev_process/fuzzers/051-imuxlout.md
diff --git a/docs/db_dev_process/fuzzers/052-clkin.md b/docs/db_dev_process/fuzzers/052-clkin.md
diff --git a/docs/db_dev_process/fuzzers/053-ctrlin.md b/docs/db_dev_process/fuzzers/053-ctrlin.md
diff --git a/docs/db_dev_process/fuzzers/054-gfan.md b/docs/db_dev_process/fuzzers/054-gfan.md
diff --git a/docs/db_dev_process/fuzzers/055-gnd.md b/docs/db_dev_process/fuzzers/055-gnd.md
diff --git a/docs/db_dev_process/fuzzers/056-rempips.md b/docs/db_dev_process/fuzzers/056-rempips.md
diff --git a/docs/db_dev_process/fuzzers/057-bipips.md b/docs/db_dev_process/fuzzers/057-bipips.md
diff --git a/docs/db_dev_process/fuzzers/058-hclkpips.md b/docs/db_dev_process/fuzzers/058-hclkpips.md
diff --git a/docs/db_dev_process/minitests/bram.md b/docs/db_dev_process/minitests/bram.md
diff --git a/docs/db_dev_process/minitests/clb_bused.md b/docs/db_dev_process/minitests/clb_bused.md
diff --git a/docs/db_dev_process/minitests/clb_ffcfg.md b/docs/db_dev_process/minitests/clb_ffcfg.md
diff --git a/docs/db_dev_process/minitests/clb_muxf8.md b/docs/db_dev_process/minitests/clb_muxf8.md
diff --git a/docs/db_dev_process/minitests/clb_n5ffmux.md b/docs/db_dev_process/minitests/clb_n5ffmux.md
diff --git a/docs/db_dev_process/minitests/clb_ncy0.md b/docs/db_dev_process/minitests/clb_ncy0.md
diff --git a/docs/db_dev_process/minitests/clb_ndi1mux.md b/docs/db_dev_process/minitests/clb_ndi1mux.md
diff --git a/docs/db_dev_process/minitests/clb_nffmux.md b/docs/db_dev_process/minitests/clb_nffmux.md
diff --git a/docs/db_dev_process/minitests/clb_noutmux.md b/docs/db_dev_process/minitests/clb_noutmux.md
diff --git a/docs/db_dev_process/minitests/clb_ram.md b/docs/db_dev_process/minitests/clb_ram.md