From bab4c6af06f77e23f2223e258d4cfc806ae15973 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 17:43:11 -0700 Subject: [PATCH 1/8] docs: Fix the markdown tables. Signed-off-by: Tim 'mithro' Ansell --- docs/conf.py | 9 +++++++-- docs/requirements.txt | 1 + 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e4fbfd18..5f5b80e6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,8 +36,13 @@ from markdown_code_symlinks import MarkdownCodeSymlinks # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.imgmath', 'sphinx.ext.autodoc', 'sphinx.ext.doctest', - 'sphinx.ext.autosummary', 'sphinx.ext.napoleon', 'sphinx.ext.todo' + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.imgmath', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', + 'sphinx_markdown_tables', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/requirements.txt b/docs/requirements.txt index 56c1f78d..8e923c0e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,5 +4,6 @@ sphinx-autobuild breathe recommonmark +sphinx-markdown-tables sphinx_rtd_theme sphinxcontrib-napoleon From 853b0119dafed347da4e5de7bf9cae1404f92ad1 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 18:10:45 -0700 Subject: [PATCH 2/8] 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 From e6ab6ee820ce9ff4c5f547442c581c182649c94f Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 18:21:37 -0700 Subject: [PATCH 3/8] docs: Run `make links` on readthedocs. Signed-off-by: Tim 'mithro' Ansell --- docs/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 5f5b80e6..de314bca 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,6 +113,13 @@ if not on_rtd: "github_version": "master", # Version "conf_py_path": "/doc/", } +else: + import subprocess + subprocess.check_call( + 'make links', + cwd=os.path.abspath(os.path.dirname(__file__)), + shell=True) + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 01c3d1c5023ef767d615d35bf09bddc2a0a117e0 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 18:25:24 -0700 Subject: [PATCH 4/8] docs: Adding a readthedocs config file. Signed-off-by: Tim 'mithro' Ansell --- .readthedocs.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..4f5e2976 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,22 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: docs/requirements.txt + +submodules: + exclude: all From c5751032c6c8d289e5c0bb48beff34ca587866bd Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 18:27:57 -0700 Subject: [PATCH 5/8] docs: Get tags on readthedocs. Makes `git describe` work so we get the correct version information. Signed-off-by: Tim 'mithro' Ansell --- docs/conf.py | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index de314bca..4c5fa407 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,6 +63,31 @@ project = u'Project X-Ray' copyright = u'2018, SymbiFlow Team' author = u'SymbiFlow Team' +# Enable github links when not on readthedocs +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +if not on_rtd: + html_context = { + "display_github": True, # Integrate GitHub + "github_user": "symbiflow", # Username + "github_repo": "prjxray", # Repo name + "github_version": "master", # Version + "conf_py_path": "/doc/", + } +else: + import subprocess + subprocess.call( + 'git fetch origin --unshallow', + cwd=os.path.abspath(os.path.dirname(__file__)), + shell=True) + subprocess.check_call( + 'git fetch origin --tags', + cwd=os.path.abspath(os.path.dirname(__file__)), + shell=True) + subprocess.check_call( + 'make links', + cwd=os.path.abspath(os.path.dirname(__file__)), + shell=True) + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -103,23 +128,6 @@ html_theme = 'sphinx_rtd_theme' # # html_theme_options = {} -# Enable github links when not on readthedocs -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -if not on_rtd: - html_context = { - "display_github": True, # Integrate GitHub - "github_user": "symbiflow", # Username - "github_repo": "prjxray", # Repo name - "github_version": "master", # Version - "conf_py_path": "/doc/", - } -else: - import subprocess - subprocess.check_call( - 'make links', - cwd=os.path.abspath(os.path.dirname(__file__)), - shell=True) - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 1df4f358359e75881f7a460cb2b536e3663e0e55 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 19:09:43 -0700 Subject: [PATCH 6/8] docs: Run `make format` Signed-off-by: Tim 'mithro' Ansell --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 4c5fa407..e2aa1f71 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -128,7 +128,6 @@ html_theme = 'sphinx_rtd_theme' # # html_theme_options = {} - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". From 9717fa48ebc5a264dcb9e2341d3f64d89c6cc60f Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 19:25:42 -0700 Subject: [PATCH 7/8] docs: Fix top level headers and other small clean. * Make sure all files have top level headers. * Fixing a few spelling mistakes. * Fixed some trailing spaces. Signed-off-by: Tim 'mithro' Ansell --- fuzzers/012-clb-n5ffmux/README.md | 8 ++++---- fuzzers/013-clb-ncy0/README.md | 2 +- fuzzers/014-clb-ffsrcemux/README.md | 4 ++-- fuzzers/015-clb-nffmux/README.md | 2 +- fuzzers/016-clb-noutmux/README.md | 2 +- fuzzers/017-clb-precyinit/README.md | 2 +- fuzzers/018-clb-ram/README.md | 2 +- fuzzers/019-clb-ndi1mux/README.md | 2 +- fuzzers/025-bram-config/README.md | 2 ++ fuzzers/026-bram-data/README.md | 2 ++ fuzzers/032-cmt-pll/README.md | 3 +++ fuzzers/033-mon-xadc/README.md | 2 ++ fuzzers/044-clk-bufg-pips/README.md | 3 +-- fuzzers/045-hclk-cmt-pips/README.md | 3 +-- fuzzers/050-pip-seed/README.md | 4 +--- fuzzers/051-pip-imuxlout-bypalts/README.md | 4 +--- fuzzers/052-pip-clkin/README.md | 7 +++---- fuzzers/053-pip-ctrlin/README.md | 4 +--- fuzzers/054-pip-fan-alt/README.md | 4 +--- fuzzers/055-pip-gnd/README.md | 4 +--- fuzzers/056-pip-rem/README.md | 4 +--- fuzzers/057-pip-bi/README.md | 7 +++---- fuzzers/058-pip-hclk/README.md | 4 +--- 23 files changed, 36 insertions(+), 45 deletions(-) diff --git a/fuzzers/012-clb-n5ffmux/README.md b/fuzzers/012-clb-n5ffmux/README.md index 46cbf25e..352dd2ad 100644 --- a/fuzzers/012-clb-n5ffmux/README.md +++ b/fuzzers/012-clb-n5ffmux/README.md @@ -4,8 +4,8 @@ The A5FFMUX family of CLB muxes feed the D input of A5FF family of FFs -| N5FFMUX | N5FFMUX.D | -|--------|-----------------| -| IN_A | N5LUT.O5 | -| IN_B | NX | +| N5FFMUX | N5FFMUX.D | +|----------|-----------------| +| IN_A | N5LUT.O5 | +| IN_B | NX | diff --git a/fuzzers/013-clb-ncy0/README.md b/fuzzers/013-clb-ncy0/README.md index f2efb164..e0ec0445 100644 --- a/fuzzers/013-clb-ncy0/README.md +++ b/fuzzers/013-clb-ncy0/README.md @@ -4,7 +4,7 @@ The ACY0 family of CLB muxes feeds the CARRY4.DI0 family -| NCY0 | CARRY4.DIN | +| NCY0 | CARRY4.DIN | |--------|------------------| | 0 | NX | | 1 | O5 | diff --git a/fuzzers/014-clb-ffsrcemux/README.md b/fuzzers/014-clb-ffsrcemux/README.md index bab6736b..2fcc3c35 100644 --- a/fuzzers/014-clb-ffsrcemux/README.md +++ b/fuzzers/014-clb-ffsrcemux/README.md @@ -4,7 +4,7 @@ Configures whether clock enable (CE) is used or clock always on -| CEUSEDMUX | CE | +| CEUSEDMUX | CE | |------------|------------------| | 0 | Always on | | 1 | Controlled | @@ -14,7 +14,7 @@ Configures whether clock enable (CE) is used or clock always on Configures whether FF can be reset or simply uses D value -| SRUSEDMUX | Resettable? | +| SRUSEDMUX | Resettable? | |------------|------------------| | 0 | No | | 1 | Controlled | diff --git a/fuzzers/015-clb-nffmux/README.md b/fuzzers/015-clb-nffmux/README.md index 35ec2094..7485624f 100644 --- a/fuzzers/015-clb-nffmux/README.md +++ b/fuzzers/015-clb-nffmux/README.md @@ -4,5 +4,5 @@ Configures the AFFMUX family of CLB muxes which feed the D input of the AFF series of FFs. -Availible selections varies by A/B/C/D, see db for details. +Available selections varies by A/B/C/D, see db for details. diff --git a/fuzzers/016-clb-noutmux/README.md b/fuzzers/016-clb-noutmux/README.md index 287a86f9..ef2950ff 100644 --- a/fuzzers/016-clb-noutmux/README.md +++ b/fuzzers/016-clb-noutmux/README.md @@ -4,5 +4,5 @@ Configures the AOUTMUX family of CLB muxes which feed the AMUX family of CLB outputs -Availible selections varies by A/B/C/D, see db for details. +Available selections varies by A/B/C/D, see db for details. diff --git a/fuzzers/017-clb-precyinit/README.md b/fuzzers/017-clb-precyinit/README.md index 96cf7373..41de497a 100644 --- a/fuzzers/017-clb-precyinit/README.md +++ b/fuzzers/017-clb-precyinit/README.md @@ -4,7 +4,7 @@ Configures the PRECYINIT mux which provides CARRY4's first carry chain input -| PRECYINIT | Value | +| PRECYINIT | Value | |------------|---------------------------------| | C0 | Logic 0 | | C1 | Logic 1 | diff --git a/fuzzers/018-clb-ram/README.md b/fuzzers/018-clb-ram/README.md index 5c455165..9d312659 100644 --- a/fuzzers/018-clb-ram/README.md +++ b/fuzzers/018-clb-ram/README.md @@ -43,7 +43,7 @@ Set to 1 to propagate CLB's BX input to WA8 ## WEMUX.CE -| WEMUX.CE | CLB RAM write enable | +| WEMUX.CE | CLB RAM write enable | |-----------|----------------------| | 0 | CLB WE input | | 1 | CLB CE input | diff --git a/fuzzers/019-clb-ndi1mux/README.md b/fuzzers/019-clb-ndi1mux/README.md index 714a2148..3a5990c2 100644 --- a/fuzzers/019-clb-ndi1mux/README.md +++ b/fuzzers/019-clb-ndi1mux/README.md @@ -4,5 +4,5 @@ Configures the NDI1MUX mux which provides the DI1 input on CLB RAM. -Availible selections varies by A/B/C/D, see db for details. +Available selections varies by A/B/C/D, see db for details. diff --git a/fuzzers/025-bram-config/README.md b/fuzzers/025-bram-config/README.md index da689dd5..3bce790e 100644 --- a/fuzzers/025-bram-config/README.md +++ b/fuzzers/025-bram-config/README.md @@ -1,2 +1,4 @@ +# BRAM Configuration + Solves for BRAM configuration bits (18K vs 36K, etc) diff --git a/fuzzers/026-bram-data/README.md b/fuzzers/026-bram-data/README.md index 7350e13f..98e84c60 100644 --- a/fuzzers/026-bram-data/README.md +++ b/fuzzers/026-bram-data/README.md @@ -1,3 +1,5 @@ +# BRAM Data + Solves for BRAM data bits See workflow comments: https://github.com/SymbiFlow/prjxray/pull/180 diff --git a/fuzzers/032-cmt-pll/README.md b/fuzzers/032-cmt-pll/README.md index e69de29b..583cb3a2 100644 --- a/fuzzers/032-cmt-pll/README.md +++ b/fuzzers/032-cmt-pll/README.md @@ -0,0 +1,3 @@ +# Clock Management Tile (CMT) - Phase Lock Loop (PLL) Fuzzer + +FIXME: Add description. diff --git a/fuzzers/033-mon-xadc/README.md b/fuzzers/033-mon-xadc/README.md index 4a0b8baa..0da982c5 100644 --- a/fuzzers/033-mon-xadc/README.md +++ b/fuzzers/033-mon-xadc/README.md @@ -1,3 +1,5 @@ +# XADC Fuzzer + As of this writing, this fuzzer is not in the ROI To use it, you must run tilegrid first with these options (artix7): diff --git a/fuzzers/044-clk-bufg-pips/README.md b/fuzzers/044-clk-bufg-pips/README.md index 3073e716..e07b7d31 100644 --- a/fuzzers/044-clk-bufg-pips/README.md +++ b/fuzzers/044-clk-bufg-pips/README.md @@ -1,4 +1,3 @@ -BUFG interconnect fuzzer -======================== +# BUFG interconnect fuzzer Solves pips located within the BUFG switch box. diff --git a/fuzzers/045-hclk-cmt-pips/README.md b/fuzzers/045-hclk-cmt-pips/README.md index 941e0636..631814f0 100644 --- a/fuzzers/045-hclk-cmt-pips/README.md +++ b/fuzzers/045-hclk-cmt-pips/README.md @@ -1,4 +1,3 @@ -HCLK\_CMT interconnect fuzzer -============================= +# HCLK\_CMT interconnect fuzzer Solves pips located within the HCLK\_CMT switch box. diff --git a/fuzzers/050-pip-seed/README.md b/fuzzers/050-pip-seed/README.md index af0d6e4e..ce667628 100644 --- a/fuzzers/050-pip-seed/README.md +++ b/fuzzers/050-pip-seed/README.md @@ -1,6 +1,4 @@ - -Generic fuzzer for INT PIPs ---------------------------- +# Generic fuzzer for INT PIPs Run this fuzzer a few times until it stops adding new PIPs to the database. diff --git a/fuzzers/051-pip-imuxlout-bypalts/README.md b/fuzzers/051-pip-imuxlout-bypalts/README.md index 6e32a8b8..8d5032cc 100644 --- a/fuzzers/051-pip-imuxlout-bypalts/README.md +++ b/fuzzers/051-pip-imuxlout-bypalts/README.md @@ -1,6 +1,4 @@ - -Fuzzer for INT LOGIC\_OUTS -> IMUX PIPs ---------------------------------------- +# Fuzzer for INT LOGIC\_OUTS -> IMUX PIPs Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop). diff --git a/fuzzers/052-pip-clkin/README.md b/fuzzers/052-pip-clkin/README.md index 38999f1b..0093b346 100644 --- a/fuzzers/052-pip-clkin/README.md +++ b/fuzzers/052-pip-clkin/README.md @@ -1,6 +1,5 @@ +# Fuzzer for INT PIPs driving the CLK wires -Fuzzer for INT PIPs driving the CLK wires ------------------------------------------ - -Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop). +Run this fuzzer a few times until it produces an empty todo.txt file (`make +run` will run this loop). diff --git a/fuzzers/053-pip-ctrlin/README.md b/fuzzers/053-pip-ctrlin/README.md index ed767449..e82bf9c1 100644 --- a/fuzzers/053-pip-ctrlin/README.md +++ b/fuzzers/053-pip-ctrlin/README.md @@ -1,6 +1,4 @@ - -Fuzzer for INT PIPs driving the CTRL wires ------------------------------------------- +# Fuzzer for INT PIPs driving the CTRL wires Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop). diff --git a/fuzzers/054-pip-fan-alt/README.md b/fuzzers/054-pip-fan-alt/README.md index 670d7cc7..1d4506ae 100644 --- a/fuzzers/054-pip-fan-alt/README.md +++ b/fuzzers/054-pip-fan-alt/README.md @@ -1,5 +1,3 @@ - -Fuzzer for the ALT_FAN.*GFAN PIPs ---------------------------------- +# Fuzzer for the ALT_FAN.*GFAN PIPs This fuzzer solves the ALT_FAN.GFAN PIPs which had collisions with the GFAN PIPs. diff --git a/fuzzers/055-pip-gnd/README.md b/fuzzers/055-pip-gnd/README.md index 2ddb1f56..0a64ae06 100644 --- a/fuzzers/055-pip-gnd/README.md +++ b/fuzzers/055-pip-gnd/README.md @@ -1,6 +1,4 @@ - -Fuzzer for INT PIPs driving the GFAN wires with GND ---------------------------------------------------- +# Fuzzer for INT PIPs driving the GFAN wires with GND Run this fuzzer once. diff --git a/fuzzers/056-pip-rem/README.md b/fuzzers/056-pip-rem/README.md index 8ec4d2eb..8aedeab6 100644 --- a/fuzzers/056-pip-rem/README.md +++ b/fuzzers/056-pip-rem/README.md @@ -1,6 +1,4 @@ - -Fuzzer for the remaining INT PIPs ---------------------------------- +# Fuzzer for the remaining INT PIPs Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop). diff --git a/fuzzers/057-pip-bi/README.md b/fuzzers/057-pip-bi/README.md index 06ff59e3..e79ae3a0 100644 --- a/fuzzers/057-pip-bi/README.md +++ b/fuzzers/057-pip-bi/README.md @@ -1,6 +1,5 @@ +# Fuzzer for bidirectional INT PIPs -Fuzzer for bidirectional INT PIPs ---------------------------------- - -Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop). +Run this fuzzer a few times until it produces an empty todo.txt file (`make +run` will run this loop). diff --git a/fuzzers/058-pip-hclk/README.md b/fuzzers/058-pip-hclk/README.md index 7522154e..6045c2f5 100644 --- a/fuzzers/058-pip-hclk/README.md +++ b/fuzzers/058-pip-hclk/README.md @@ -1,6 +1,4 @@ - -Fuzzer for PIPs in HCLK titles ------------------------------- +# Fuzzer for PIPs in HCLK titles Run this fuzzer once. From 8c90ae2e395cb00bee5855a5f3e9727826a25c9e Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 3 Apr 2019 19:28:23 -0700 Subject: [PATCH 8/8] docs: Adding DRAM info to TOC. Signed-off-by: Tim 'mithro' Ansell --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.rst b/docs/index.rst index cb08fe45..d9b51b79 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ to develop a free and open Verilog to bitstream toolchain for these devices. architecture/overview architecture/configuration architecture/bitstream_format + architecture/dram_configuration architecture/glossary .. toctree::