From 853b0119dafed347da4e5de7bf9cae1404f92ad1 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 18:10:45 -0700 Subject: [PATCH] docs: Automatically link fuzzer/minitest README.md files. Signed-off-by: Tim 'mithro' Ansell --- docs/.gitignore | 2 + docs/Makefile | 44 ++++++++++++++++++- docs/db_dev_process/fuzzers/011-ffconfig.md | 1 - docs/db_dev_process/fuzzers/012-clbn5ffmux.md | 1 - docs/db_dev_process/fuzzers/013-clbncy0.md | 1 - docs/db_dev_process/fuzzers/014-ffsrcemux.md | 1 - docs/db_dev_process/fuzzers/015-clbnffmux.md | 1 - docs/db_dev_process/fuzzers/016-clbnoutmux.md | 1 - .../fuzzers/017-clbprecyinit.md | 1 - docs/db_dev_process/fuzzers/018-clbram.md | 1 - docs/db_dev_process/fuzzers/019-ndi1mux.md | 1 - docs/db_dev_process/fuzzers/050-intpips.md | 1 - docs/db_dev_process/fuzzers/051-imuxlout.md | 1 - docs/db_dev_process/fuzzers/052-clkin.md | 1 - docs/db_dev_process/fuzzers/053-ctrlin.md | 1 - docs/db_dev_process/fuzzers/054-gfan.md | 1 - docs/db_dev_process/fuzzers/055-gnd.md | 1 - docs/db_dev_process/fuzzers/056-rempips.md | 1 - docs/db_dev_process/fuzzers/057-bipips.md | 1 - docs/db_dev_process/fuzzers/058-hclkpips.md | 1 - docs/db_dev_process/minitests/bram.md | 1 - docs/db_dev_process/minitests/clb_bused.md | 1 - docs/db_dev_process/minitests/clb_ffcfg.md | 1 - docs/db_dev_process/minitests/clb_muxf8.md | 1 - docs/db_dev_process/minitests/clb_n5ffmux.md | 1 - docs/db_dev_process/minitests/clb_ncy0.md | 1 - docs/db_dev_process/minitests/clb_ndi1mux.md | 1 - docs/db_dev_process/minitests/clb_nffmux.md | 1 - docs/db_dev_process/minitests/clb_noutmux.md | 1 - docs/db_dev_process/minitests/clb_ram.md | 1 - 30 files changed, 45 insertions(+), 29 deletions(-) delete mode 120000 docs/db_dev_process/fuzzers/011-ffconfig.md delete mode 120000 docs/db_dev_process/fuzzers/012-clbn5ffmux.md delete mode 120000 docs/db_dev_process/fuzzers/013-clbncy0.md delete mode 120000 docs/db_dev_process/fuzzers/014-ffsrcemux.md delete mode 120000 docs/db_dev_process/fuzzers/015-clbnffmux.md delete mode 120000 docs/db_dev_process/fuzzers/016-clbnoutmux.md delete mode 120000 docs/db_dev_process/fuzzers/017-clbprecyinit.md delete mode 120000 docs/db_dev_process/fuzzers/018-clbram.md delete mode 120000 docs/db_dev_process/fuzzers/019-ndi1mux.md delete mode 120000 docs/db_dev_process/fuzzers/050-intpips.md delete mode 120000 docs/db_dev_process/fuzzers/051-imuxlout.md delete mode 120000 docs/db_dev_process/fuzzers/052-clkin.md delete mode 120000 docs/db_dev_process/fuzzers/053-ctrlin.md delete mode 120000 docs/db_dev_process/fuzzers/054-gfan.md delete mode 120000 docs/db_dev_process/fuzzers/055-gnd.md delete mode 120000 docs/db_dev_process/fuzzers/056-rempips.md delete mode 120000 docs/db_dev_process/fuzzers/057-bipips.md delete mode 120000 docs/db_dev_process/fuzzers/058-hclkpips.md delete mode 120000 docs/db_dev_process/minitests/bram.md delete mode 120000 docs/db_dev_process/minitests/clb_bused.md delete mode 120000 docs/db_dev_process/minitests/clb_ffcfg.md delete mode 120000 docs/db_dev_process/minitests/clb_muxf8.md delete mode 120000 docs/db_dev_process/minitests/clb_n5ffmux.md delete mode 120000 docs/db_dev_process/minitests/clb_ncy0.md delete mode 120000 docs/db_dev_process/minitests/clb_ndi1mux.md delete mode 120000 docs/db_dev_process/minitests/clb_nffmux.md delete mode 120000 docs/db_dev_process/minitests/clb_noutmux.md delete mode 120000 docs/db_dev_process/minitests/clb_ram.md diff --git a/docs/.gitignore b/docs/.gitignore index e35d8850..9d7ce536 100644 --- 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 index b52c6680..bd71d27c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -18,7 +18,49 @@ 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 "# $$(basename $$i)" > $$(basename $$i).md; \ + echo "" >> $$(basename $$i).md; \ + echo "Missing 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 "# $$(basename $$i)" > $$(basename $$i).md; \ + echo "" >> $$(basename $$i).md; \ + echo "Missing 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 deleted file mode 120000 index 157999c5..00000000 --- a/docs/db_dev_process/fuzzers/011-ffconfig.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/011-ffconfig/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/012-clbn5ffmux.md b/docs/db_dev_process/fuzzers/012-clbn5ffmux.md deleted file mode 120000 index 4c9865de..00000000 --- a/docs/db_dev_process/fuzzers/012-clbn5ffmux.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/012-clbn5ffmux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/013-clbncy0.md b/docs/db_dev_process/fuzzers/013-clbncy0.md deleted file mode 120000 index ffd80bf3..00000000 --- a/docs/db_dev_process/fuzzers/013-clbncy0.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/013-clbncy0/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/014-ffsrcemux.md b/docs/db_dev_process/fuzzers/014-ffsrcemux.md deleted file mode 120000 index 20c90e11..00000000 --- a/docs/db_dev_process/fuzzers/014-ffsrcemux.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/014-ffsrcemux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/015-clbnffmux.md b/docs/db_dev_process/fuzzers/015-clbnffmux.md deleted file mode 120000 index 2e65f3f3..00000000 --- a/docs/db_dev_process/fuzzers/015-clbnffmux.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/015-clbnffmux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/016-clbnoutmux.md b/docs/db_dev_process/fuzzers/016-clbnoutmux.md deleted file mode 120000 index efc775b6..00000000 --- a/docs/db_dev_process/fuzzers/016-clbnoutmux.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/016-clbnoutmux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/017-clbprecyinit.md b/docs/db_dev_process/fuzzers/017-clbprecyinit.md deleted file mode 120000 index 1080e6f4..00000000 --- a/docs/db_dev_process/fuzzers/017-clbprecyinit.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/017-clbprecyinit/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/018-clbram.md b/docs/db_dev_process/fuzzers/018-clbram.md deleted file mode 120000 index 50454ea9..00000000 --- a/docs/db_dev_process/fuzzers/018-clbram.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/018-clbram/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/019-ndi1mux.md b/docs/db_dev_process/fuzzers/019-ndi1mux.md deleted file mode 120000 index 347d074a..00000000 --- a/docs/db_dev_process/fuzzers/019-ndi1mux.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/019-ndi1mux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/050-intpips.md b/docs/db_dev_process/fuzzers/050-intpips.md deleted file mode 120000 index b097a73e..00000000 --- a/docs/db_dev_process/fuzzers/050-intpips.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/050-intpips/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/051-imuxlout.md b/docs/db_dev_process/fuzzers/051-imuxlout.md deleted file mode 120000 index 36da9404..00000000 --- a/docs/db_dev_process/fuzzers/051-imuxlout.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/051-imuxlout/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/052-clkin.md b/docs/db_dev_process/fuzzers/052-clkin.md deleted file mode 120000 index 815c7cac..00000000 --- a/docs/db_dev_process/fuzzers/052-clkin.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/052-clkin/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/053-ctrlin.md b/docs/db_dev_process/fuzzers/053-ctrlin.md deleted file mode 120000 index 60fc07aa..00000000 --- a/docs/db_dev_process/fuzzers/053-ctrlin.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/053-ctrlin/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/054-gfan.md b/docs/db_dev_process/fuzzers/054-gfan.md deleted file mode 120000 index fe1c03ae..00000000 --- a/docs/db_dev_process/fuzzers/054-gfan.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/054-gfan/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/055-gnd.md b/docs/db_dev_process/fuzzers/055-gnd.md deleted file mode 120000 index f028afd9..00000000 --- a/docs/db_dev_process/fuzzers/055-gnd.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/055-gnd/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/056-rempips.md b/docs/db_dev_process/fuzzers/056-rempips.md deleted file mode 120000 index e79879c4..00000000 --- a/docs/db_dev_process/fuzzers/056-rempips.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/056-rempips/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/057-bipips.md b/docs/db_dev_process/fuzzers/057-bipips.md deleted file mode 120000 index 040214eb..00000000 --- a/docs/db_dev_process/fuzzers/057-bipips.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/057-bipips/README.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/058-hclkpips.md b/docs/db_dev_process/fuzzers/058-hclkpips.md deleted file mode 120000 index 071ce3dd..00000000 --- a/docs/db_dev_process/fuzzers/058-hclkpips.md +++ /dev/null @@ -1 +0,0 @@ -../../../fuzzers/058-hclkpips/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/bram.md b/docs/db_dev_process/minitests/bram.md deleted file mode 120000 index 527cf3e3..00000000 --- a/docs/db_dev_process/minitests/bram.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/bram/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_bused.md b/docs/db_dev_process/minitests/clb_bused.md deleted file mode 120000 index 031bc25e..00000000 --- a/docs/db_dev_process/minitests/clb_bused.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_bused/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_ffcfg.md b/docs/db_dev_process/minitests/clb_ffcfg.md deleted file mode 120000 index d560c280..00000000 --- a/docs/db_dev_process/minitests/clb_ffcfg.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_ffcfg/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_muxf8.md b/docs/db_dev_process/minitests/clb_muxf8.md deleted file mode 120000 index 53b0db4a..00000000 --- a/docs/db_dev_process/minitests/clb_muxf8.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_muxf8/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_n5ffmux.md b/docs/db_dev_process/minitests/clb_n5ffmux.md deleted file mode 120000 index ec617644..00000000 --- a/docs/db_dev_process/minitests/clb_n5ffmux.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_n5ffmux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_ncy0.md b/docs/db_dev_process/minitests/clb_ncy0.md deleted file mode 120000 index 22d88244..00000000 --- a/docs/db_dev_process/minitests/clb_ncy0.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_ncy0/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_ndi1mux.md b/docs/db_dev_process/minitests/clb_ndi1mux.md deleted file mode 120000 index c4b7aa29..00000000 --- a/docs/db_dev_process/minitests/clb_ndi1mux.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_ndi1mux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_nffmux.md b/docs/db_dev_process/minitests/clb_nffmux.md deleted file mode 120000 index 3b41da5b..00000000 --- a/docs/db_dev_process/minitests/clb_nffmux.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_nffmux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_noutmux.md b/docs/db_dev_process/minitests/clb_noutmux.md deleted file mode 120000 index ace55c8a..00000000 --- a/docs/db_dev_process/minitests/clb_noutmux.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_noutmux/README.md \ No newline at end of file diff --git a/docs/db_dev_process/minitests/clb_ram.md b/docs/db_dev_process/minitests/clb_ram.md deleted file mode 120000 index 1f946093..00000000 --- a/docs/db_dev_process/minitests/clb_ram.md +++ /dev/null @@ -1 +0,0 @@ -../../../minitests/clb_ram/README.md \ No newline at end of file