aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2022-06-24 18:28:53 +0100
committerYann Herklotz <git@yannherklotz.com>2022-06-24 18:28:53 +0100
commit56f1dd7a658dd21bb267dc41fc0301adbd620a6d (patch)
tree12f55df14f2e73a7b14f461cee837e79b15cb502
parent0a7f2f6f6e0f68a9fa89a27dc677b40f8dfb6e86 (diff)
downloadvericert-56f1dd7a658dd21bb267dc41fc0301adbd620a6d.tar.gz
vericert-56f1dd7a658dd21bb267dc41fc0301adbd620a6d.zip
Update build files for documentation
-rw-r--r--doc/Makefile3
-rw-r--r--doc/index.rst8
-rw-r--r--src/hls/Gible.v6
3 files changed, 10 insertions, 7 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 8a34845..e4a3988 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -9,7 +9,7 @@ SOURCEDIR = .
BUILDDIR = _build
SOURCE_DATE_EPOCH = $(shell git log -1 --format=%ct)
-VS_DOCS := Compiler.v hls/RTLBlockInstr.v hls/RTLBlockgen.v hls/RTLBlockgenproof.v
+VS_DOCS := Compiler.v hls/Gible.v hls/GibleSeq.v hls/GiblePar.v hls/GibleSeqgen.v hls/GibleSeqgenproof.v
# Put it first so that "make" without argument is like "make help".
help:
@@ -20,5 +20,6 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
+ mkdir -p src/hls
$(foreach d,$(VS_DOCS),cp ../src/$(d) src/$(d);)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/index.rst b/doc/index.rst
index 06aa509..f5a7776 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -33,9 +33,11 @@ have all been proven correct, providing a verified translation from C to Verilog
:caption: Sources
src/Compiler
- src/hls/RTLBlockInstr
- src/hls/RTLBlockgen
- src/hls/RTLBlockgenproof
+ src/hls/Gible.v
+ src/hls/GibleSeq.v
+ src/hls/GiblePar.v
+ src/hls/GibleSeqgen.v
+ src/hls/GibleSeqgenproof.v
Publications
------------
diff --git a/src/hls/Gible.v b/src/hls/Gible.v
index 399935b..8971535 100644
--- a/src/hls/Gible.v
+++ b/src/hls/Gible.v
@@ -16,9 +16,9 @@
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
-=============
-RTLBlockInstr
-=============
+=====
+Gible
+=====
These instructions are used for ``RTLBlock`` and ``RTLPar``, so that they have
consistent instructions, which greatly simplifies the proofs, as they will by