aboutsummaryrefslogtreecommitdiff
path: root/build
diff options
context:
space:
mode:
authorBill Traynor <wmat@riscv.org>2024-03-20 14:12:30 -0400
committerGitHub <noreply@github.com>2024-03-20 14:12:30 -0400
commite5ce8f1e11c2de97901a2c646cddc3150604f86c (patch)
tree07ba522ef7ecf5d5a101f06ad7913baec13075e4 /build
parent8fdbc3b75ad7bdc726cbfcdd40d6b326b952f43f (diff)
parentaa5dce0b1ffda7eaa74491156c4b507d2e4d6460 (diff)
downloadriscv-isa-manual-e5ce8f1e11c2de97901a2c646cddc3150604f86c.zip
riscv-isa-manual-e5ce8f1e11c2de97901a2c646cddc3150604f86c.tar.gz
riscv-isa-manual-e5ce8f1e11c2de97901a2c646cddc3150604f86c.tar.bz2
Merge branch 'main' into bitmanip
Signed-off-by: Bill Traynor <wmat@riscv.org>
Diffstat (limited to 'build')
-rw-r--r--build/.gitignore2
-rw-r--r--build/Makefile37
2 files changed, 11 insertions, 28 deletions
diff --git a/build/.gitignore b/build/.gitignore
index 3b37eba..3c56997 100644
--- a/build/.gitignore
+++ b/build/.gitignore
@@ -1,9 +1,11 @@
*.aux
*.bbl
*.blg
+*.html
*.log
*.out
*.pdf
+*.pdf.tmp
*.toc
images
.asciidoctor
diff --git a/build/Makefile b/build/Makefile
index 9b72b01..fad4fbc 100644
--- a/build/Makefile
+++ b/build/Makefile
@@ -14,7 +14,7 @@
# for generating documentation in various formats (PDF, HTML).
# Build Targets
-TARGETS := priv unpriv priv-html unpriv-html priv-latex
+TARGETS := priv unpriv priv-html unpriv-html
# Declare phony targets
.PHONY: all $(TARGETS) clean
@@ -22,8 +22,14 @@ TARGETS := priv unpriv priv-html unpriv-html priv-latex
# Default target builds all
all: $(TARGETS)
+# Build with preinstalled docker container; first install it with:
+# docker pull riscvintl/riscv-docs-base-container-image:latest
+docker:
+ cd .. && docker run -it -v .:/build riscvintl/riscv-docs-base-container-image:latest /bin/sh -c 'cd ./build; make $(MAKEFLAGS)'
+
# Asciidoctor options
-ASCIIDOCTOR_OPTS := --attribute=mathematical-format=svg \
+ASCIIDOCTOR_OPTS := -a compress \
+ --attribute=mathematical-format=svg \
--failure-level=ERROR \
--require=asciidoctor-bibtex \
--require=asciidoctor-diagram \
@@ -33,15 +39,6 @@ ASCIIDOCTOR_OPTS := --attribute=mathematical-format=svg \
# Source directory
SRCDIR := ../src
-# LaTeX source and related files
-#SRCS := $(wildcard $(SRCDIR)/latex/*.tex)
-#FIGS := $(wildcard $(SRCDIR)/latex/figs/*)
-#BIBS := $(SRCDIR)/latex/riscv-spec.bib
-
-# LaTeX build tools
-#PDFLATEX := TEXINPUTS=$(SRCDIR)/latex: pdflatex -interaction=nonstopmode -halt-on-error
-#BIBTEX := BIBINPUTS=$(SRCDIR)/latex: bibtex
-
# Temporary files to clean up for LaTeX build
JUNK := *.pdf *.aux *.log *.bbl *.blg *.toc *.out *.fdb_latexmk *.fls *.synctex.gz
@@ -77,15 +74,6 @@ unpriv-isa-asciidoc.html: $(SRCDIR)/riscv-unprivileged.adoc
@echo "Building Unprivileged ISA HTML"
asciidoctor $(ASCIIDOCTOR_OPTS) --out-file=$@ $<
-# LaTeX build for Privileged ISA
-#priv-latex: riscv-privileged.pdf
-
-#riscv-privileged.pdf: $(SRCDIR)/latex/riscv-privileged.tex $(SRCS) $(FIGS) $(BIBS)
-# $(PDFLATEX) riscv-privileged
-# $(BIBTEX) riscv-privileged
-# $(PDFLATEX) riscv-privileged
-# $(PDFLATEX) riscv-privileged
-
clean:
@if [ -f priv-isa-asciidoc.pdf ]; then \
echo "Removing priv-isa-asciidoc.pdf"; \
@@ -103,11 +91,4 @@ clean:
echo "Removing unpriv-isa-asciidoc.html"; \
rm -f unpriv-isa-asciidoc.html; \
fi
-# @echo "Cleaning up files from LaTeX build"
-# @cd $(SRCDIR)/latex; \
-# for file in $(JUNK); do \
-# if [ -f "$$file" ]; then \
-# echo "Removing $$file"; \
-# rm -f "$$file"; \
-# fi; \
-# done
+