Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversion of LaTeX spec to asciidoc. #53

Open
wants to merge 189 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 116 commits
Commits
Show all changes
189 commits
Select commit Hold shift + click to select a range
46bacc0
Converting to use templates and asciidoc
wmat Jul 4, 2023
ebb0ed5
Initial conversion to asciidoc.
wmat Aug 17, 2023
6f35f61
Update to ratified version 1.0
jhauser-us Jul 1, 2023
5923f6b
Update version number to 1.0-RC6
jhauser-us Jun 16, 2023
82bc6d4
Adding dependencies.
wmat Aug 17, 2023
c09a207
Removing title page info and contributors.
wmat Aug 17, 2023
b8d33cd
Placed TOC after preface.
wmat Aug 17, 2023
fdde8bb
Conversion cleanup
wmat Aug 17, 2023
a78b454
Conversion cleanup.
wmat Aug 18, 2023
8dd860d
Conversion cleanup.
wmat Aug 18, 2023
eef1a53
Conversion cleanup.
wmat Aug 18, 2023
bd0119e
Conversion cleanup.
wmat Aug 21, 2023
ef55b95
Conversion cleanup.
wmat Aug 21, 2023
92dd73b
Conversion cleanup.
wmat Aug 21, 2023
813e16f
Fixing Makefile options
wmat Aug 25, 2023
2044c90
Removed all /mbox latexmath code.
wmat Aug 25, 2023
9211653
Conversion cleanup.
wmat Aug 25, 2023
7818392
Cleaning up latexmath
wmat Aug 25, 2023
10fde25
Conversion cleanup
wmat Aug 25, 2023
5d54aa9
Removing indent of text which causes literal block.
wmat Aug 29, 2023
d1689a2
Conversion cleanup.
wmat Aug 29, 2023
1db5924
Conversion cleanup
wmat Aug 29, 2023
b8453ff
Conversion cleanup.
wmat Aug 29, 2023
4b1d34a
Conversion cleanup.
wmat Aug 29, 2023
af7e8bb
Trying to fix latexmath
wmat Aug 29, 2023
44e9082
Conversion cleanup.
wmat Aug 29, 2023
1b5fa0e
Table formatting
wmat Aug 30, 2023
fb7cd9b
Conversion cleanup
wmat Aug 31, 2023
126c7d6
Conversion cleanup
wmat Aug 31, 2023
5711009
Conversion cleanup
wmat Aug 31, 2023
c9761f8
Conversion cleanup.
wmat Sep 5, 2023
e4b7dc8
Conversion clean up
wmat Sep 5, 2023
d903200
Conversion cleanup.
wmat Sep 5, 2023
23c8b66
Conversion cleanup
wmat Sep 5, 2023
50a2934
Conversion cleanup
wmat Sep 5, 2023
519605c
Conversion cleanup
wmat Sep 5, 2023
92e3060
Fix up spaces
wmat Sep 5, 2023
092941b
Attempting to fix table
wmat Sep 5, 2023
80971be
Fixing tables.
wmat Sep 12, 2023
7c81569
Fix table formatting
wmat Sep 13, 2023
1fd77c9
Added table in admonition
wmat Sep 13, 2023
c56cbff
Conversion cleanup
wmat Sep 13, 2023
7abaf8e
Fix bulleted list
wmat Sep 13, 2023
d55f947
Left align table
wmat Sep 13, 2023
7355ffb
Fixing latexmath.
wmat Sep 13, 2023
fe694fe
Table formatting
wmat Sep 13, 2023
177cbac
Moved table.
wmat Sep 13, 2023
0fcf507
Reformatting table.
wmat Sep 13, 2023
c8142ee
Adding compress attribute to asciidoc build.
wmat Feb 28, 2024
2e7b7a9
Update src/intro.adoc
wmat Feb 28, 2024
b03badc
Update src/intro.adoc
wmat Feb 28, 2024
73068d0
Update src/intro.adoc
wmat Feb 28, 2024
7aead07
Update src/intro.adoc
wmat Feb 28, 2024
a7d13d0
Update src/intro.adoc
wmat Feb 28, 2024
7a3b232
Beginning to scrub the asciidoc branch of latex dependencies.
wmat Feb 28, 2024
5af4037
Merge branch 'asciidoc' of github.com:riscv/riscv-aia into asciidoc
wmat Feb 28, 2024
257c255
Update src/CSRs.adoc
wmat Feb 28, 2024
615db05
Update src/CSRs.adoc
wmat Feb 28, 2024
90a5e36
Update src/CSRs.adoc
wmat Feb 28, 2024
d34a1d8
Update src/CSRs.adoc
wmat Feb 28, 2024
cefcfb2
Update src/CSRs.adoc
wmat Feb 28, 2024
48307b3
Update src/CSRs.adoc
wmat Feb 28, 2024
9e4bd70
Update src/CSRs.adoc
wmat Feb 28, 2024
bfffc29
Update src/CSRs.adoc
wmat Feb 28, 2024
021d161
Update src/CSRs.adoc
wmat Feb 28, 2024
135b25a
Update src/CSRs.adoc
wmat Feb 28, 2024
7d1a4eb
Update src/CSRs.adoc
wmat Feb 28, 2024
8e9d06c
Update src/CSRs.adoc
wmat Feb 28, 2024
8e6d8df
Update src/CSRs.adoc
wmat Feb 28, 2024
8beb498
Update src/CSRs.adoc
wmat Feb 28, 2024
19c7d57
Update src/CSRs.adoc
wmat Feb 28, 2024
10e49fc
Update src/CSRs.adoc
wmat Feb 28, 2024
9599d96
Update src/CSRs.adoc
wmat Feb 28, 2024
8233f44
Update src/CSRs.adoc
wmat Feb 28, 2024
806f13d
Update src/CSRs.adoc
wmat Feb 28, 2024
8edab12
Update src/CSRs.adoc
wmat Feb 28, 2024
fd58347
Update src/CSRs.adoc
wmat Feb 28, 2024
e672fa5
Update src/CSRs.adoc
wmat Feb 28, 2024
a89fb21
Update src/CSRs.adoc
wmat Feb 28, 2024
beb65ba
Update src/CSRs.adoc
wmat Feb 28, 2024
fccaa7e
Update src/CSRs.adoc
wmat Feb 28, 2024
062c52e
Update src/CSRs.adoc
wmat Feb 28, 2024
24c34cd
Update src/CSRs.adoc
wmat Feb 28, 2024
e0f0d64
Update src/CSRs.adoc
wmat Feb 28, 2024
7564c21
Update src/CSRs.adoc
wmat Feb 28, 2024
184fba9
Update src/CSRs.adoc
wmat Feb 28, 2024
9164fe0
Update src/CSRs.adoc
wmat Feb 28, 2024
2408400
Update src/CSRs.adoc
wmat Feb 28, 2024
8b5839e
Update src/CSRs.adoc
wmat Feb 28, 2024
2dbddd5
Update src/CSRs.adoc
wmat Feb 28, 2024
816131e
Update src/CSRs.adoc
wmat Feb 28, 2024
7ff1c85
Update src/CSRs.adoc
wmat Feb 28, 2024
e6d42fe
Update src/CSRs.adoc
wmat Feb 28, 2024
14a7e7b
Update src/CSRs.adoc
wmat Feb 28, 2024
b453a99
Update src/CSRs.adoc
wmat Feb 28, 2024
2f07047
Update src/CSRs.adoc
wmat Feb 28, 2024
12f2c92
Update src/CSRs.adoc
wmat Feb 28, 2024
073f8b6
Update src/CSRs.adoc
wmat Feb 28, 2024
9299385
Update src/CSRs.adoc
wmat Feb 28, 2024
71dbd2a
Update src/CSRs.adoc
wmat Feb 28, 2024
803ad8a
Make file structure match official template.
wmat Feb 28, 2024
1249c6f
Merge branch 'asciidoc' of github.com:riscv/riscv-aia into asciidoc
wmat Feb 28, 2024
683977d
Adding the docs-resources.
wmat Feb 28, 2024
b3c1bea
Move Makefile to top level.
wmat Feb 28, 2024
b481611
Update src/IMSIC.adoc
wmat Feb 28, 2024
0ea6087
Update src/IMSIC.adoc
wmat Feb 28, 2024
8c4d54a
Update src/IMSIC.adoc
wmat Feb 28, 2024
13216c3
Update src/AdvPLIC.adoc
wmat Feb 28, 2024
210c4f1
Update src/IMSIC.adoc
wmat Feb 28, 2024
d68e7d3
Update src/IMSIC.adoc
wmat Feb 28, 2024
8e7a0b9
Update src/CSRs.adoc
wmat Feb 28, 2024
375637d
Update src/CSRs.adoc
wmat Feb 28, 2024
759102b
Update src/AdvPLIC.adoc
wmat Feb 28, 2024
f79c0ae
Update src/AdvPLIC.adoc
wmat Feb 28, 2024
16c8788
Update src/AdvPLIC.adoc
wmat Feb 28, 2024
8b9fb0e
Update src/AdvPLIC.adoc
wmat Feb 28, 2024
512b3a3
Update src/MSLevel.adoc
wmat Feb 29, 2024
42975a3
Update src/MSLevel.adoc
wmat Feb 29, 2024
a4eeeb8
Update src/MSLevel.adoc
wmat Feb 29, 2024
e264b12
Update src/MSLevel.adoc
wmat Feb 29, 2024
4037aeb
Update src/MSLevel.adoc
wmat Feb 29, 2024
295b873
Update src/MSLevel.adoc
wmat Feb 29, 2024
a8ee616
Update src/MSLevel.adoc
wmat Feb 29, 2024
85cc9d7
Update src/MSLevel.adoc
wmat Feb 29, 2024
3959d97
Fixing latexmath issues.
wmat Feb 29, 2024
626065c
Merge branch 'asciidoc' of github.com:riscv/riscv-aia into asciidoc
wmat Feb 29, 2024
1163a86
Fix Makefile
wmat Mar 5, 2024
874b637
Fix badly converted double quotes.
wmat Mar 26, 2024
edccc91
Fixing latexmath.
wmat Mar 26, 2024
f139a8d
Fix parentheses in latexmath
wmat Mar 26, 2024
2478c03
Fixing colophon chapter.
wmat Apr 23, 2024
ab716b5
Adding missing word RISC-V and fixing table.
wmat Apr 23, 2024
4db9b97
Added back more missing RISC-V instances.
wmat Apr 23, 2024
09028d4
Fix table to match LaTeX version.
wmat Apr 23, 2024
4a6e415
Table formatting.
wmat Apr 23, 2024
75f2637
Table formatting.
wmat Apr 23, 2024
f746def
Formatting updates.
wmat Apr 23, 2024
277935b
Formatting updates.
wmat Apr 23, 2024
82352df
Formatting updates.
wmat Apr 23, 2024
bf3c14a
Formatting fixes.
wmat Apr 24, 2024
11cea40
Formatting clean up.
wmat Apr 24, 2024
68be3c9
Formatting fixes.
wmat Apr 24, 2024
9ab1888
Fixing repo to use template and docs-resources.
wmat Jun 6, 2024
70c6338
Adding docs-resources submodule
wmat Jun 6, 2024
aebf5d7
Refactor repo to use spec template
wmat Jun 6, 2024
2b6b3e8
Fixes from Jeff's review
wmat Jun 6, 2024
660ad56
Fixes from Jeff's review
wmat Jun 6, 2024
33fa1bf
Fixing formatting
wmat Jun 6, 2024
2c335bc
Formatting fixes
wmat Jun 6, 2024
49aa467
Formatting fixes
wmat Jun 6, 2024
25ddbfc
Formatting fixes.
wmat Jun 6, 2024
97268c8
Adding github workflow
wmat Jun 6, 2024
c1f7c12
Trying to fix latexmath
wmat Jun 7, 2024
2352263
Added asciidoctor-mathematical requirement to Makefile.
wmat Jun 7, 2024
c00cb73
:Merge branch 'main' into asciidoc
wmat Jun 7, 2024
5725f40
Removed RC6 changes para as redundant with 1.0 para.
wmat Aug 9, 2024
3e291e8
Added in missing mcause and scause register names.
wmat Aug 9, 2024
641aa64
Removed extra word 'listed'.
wmat Aug 9, 2024
706767c
Fix Machine-Level high-half CSR descriptions.
wmat Aug 9, 2024
26d28d6
Remove extra word 'to'.
wmat Aug 9, 2024
6022d25
Fixed link to Section 2.3.
wmat Aug 9, 2024
5fce732
Fix placement of word 'range' and add missing comma.
wmat Aug 9, 2024
50ab289
Add missing width of hviprio2 in table.
wmat Aug 9, 2024
0e03586
Fixed xref to section 2.3.
wmat Aug 9, 2024
970a11f
Fixing several typos.
wmat Aug 9, 2024
46d0b73
Fix latexmath formatting.
wmat Aug 9, 2024
867cfd3
Add in missing words.
wmat Aug 9, 2024
efd605f
Add missing word "that"
wmat Aug 29, 2024
1da7b93
Fix Table 6.
wmat Aug 29, 2024
9ff7ba6
Fix misplaced comma.
wmat Aug 29, 2024
ad3cb2f
Cleaned up section 4.5.3
wmat Aug 29, 2024
81c735a
Delete extra parentheses from title
wmat Aug 29, 2024
9ea6a74
Fixed missing word "writing"
wmat Aug 29, 2024
7bcc2cd
Add missing register name
wmat Aug 29, 2024
ae1cba0
Move misplaced word register
wmat Aug 29, 2024
f88b6f5
Fix missing word "of"
wmat Aug 29, 2024
316ef7e
Fix typo of register name and add missing word
wmat Aug 29, 2024
08df169
Fixed typo of register name
wmat Aug 29, 2024
4765330
Adding back missing words
wmat Aug 29, 2024
210a52c
Fix missing word
wmat Aug 29, 2024
d9ab5f7
Fix missing word and character.
wmat Aug 29, 2024
a3207b3
Fixing up missing parentheses and word.
wmat Aug 29, 2024
1ff6483
Typo fix.
wmat Aug 29, 2024
c438f3e
Typo fix.
wmat Aug 29, 2024
aac68ff
Conversion cleanup.
wmat Aug 29, 2024
6202106
Typo fixes
wmat Aug 29, 2024
41d6a98
Fix typo
wmat Aug 29, 2024
515608f
Typo fixes
wmat Aug 29, 2024
ab5b074
Missing word addition
wmat Aug 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs-resources"]
path = docs-resources
url = [email protected]:riscv/docs-resources.git
69 changes: 69 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Makefile for RISC-V ISA Manuals
#
# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
# International License. To view a copy of this license, visit
# http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
#
# SPDX-License-Identifier: CC-BY-SA-4.0
#
# Description:
#
# This Makefile is designed to automate the process of building and packaging
# the documentation for RISC-V ISA Manuals. It supports multiple build targets
# for generating documentation in various formats (PDF, HTML).

# Build Targets
TARGETS := aia aia-html

# Declare phony targets
.PHONY: all $(TARGETS) clean

# Default target builds all
all: $(TARGETS)

#ifneq ($(SKIP_DOCKER),true)
# DOCKER_CMD := docker run --rm -v ${PWD}:/build -w /build \
# riscvintl/riscv-docs-base-container-image:latest \
# /bin/sh -c
# DOCKER_QUOTE := "
#endif

# Asciidoctor options
ASCIIDOCTOR_OPTS := -a --compress \
--attribute=mathematical-format=svg \
--failure-level=ERROR \
--require=asciidoctor-diagram \
--require=asciidoctor-mathematical \
--trace

# Source directory
SRCDIR := src


# AIA Specification AsciiDoc Build
aia: riscv-interrupts.pdf

riscv-interrupts.pdf: $(SRCDIR)/riscv-interrupts.adoc $(SRCDIR)/*.adoc
@echo "Building AIA Specification"
rm -f [email protected]
asciidoctor-pdf $(ASCIIDOCTOR_OPTS) [email protected] $<
mv [email protected] $@

# AIA Specification HTML build
aia-html: riscv-interrupts.html

riscv-interrupts.html: $(SRCDIR)/riscv-interrupts.adoc
@echo "Building AIA HTML Specification"
asciidoctor $(ASCIIDOCTOR_OPTS) --out-file=$@ $<

clean:
@if [ -f riscv-interrupts.pdf ]; then \
echo "Removing riscv-interrupts.pdf"; \
rm -f riscv-interrupts.pdf; \
fi
@if [ -f riscv-interrupts.html ]; then \
echo "Removing riscv-interrupts.html"; \
rm -f riscv-interrupts.html; \
fi
done
11 changes: 11 additions & 0 deletions build/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
*.aux
*.bbl
*.blg
*.log
*.out
*.pdf
*.toc
*.tmp
*stem*
../src/docs-resources/images/stem*
../doc/build/*
14 changes: 14 additions & 0 deletions dependencies/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
source 'https://rubygems.org'
gem 'asciidoctor'
gem 'asciidoctor-bibtex'
gem 'asciidoctor-diagram'
gem 'asciidoctor-mathematical'
gem 'asciidoctor-pdf'
gem 'citeproc-ruby'
gem 'coderay'
gem 'csl-styles'
gem 'json'
gem 'pygments.rb'
gem 'rghost'
gem 'rouge'
gem 'ruby_dev'
3 changes: 3 additions & 0 deletions dependencies/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Dependencies for the build environment for various package managers. Used in
`.github/workflows/`.

22 changes: 22 additions & 0 deletions dependencies/apt_packages.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
bison
build-essential
cmake
curl
flex
fonts-lyx
git
graphviz
# For wavedrom
default-jre
libcairo2-dev
libffi-dev
libgdk-pixbuf2.0-dev
libglib2.0-dev
libpango1.0-dev
libxml2-dev
make
pkg-config
ruby
ruby-dev
libwebp-dev
libzstd-dev
8 changes: 8 additions & 0 deletions dependencies/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "local",
"version": "0.0.1",
"dependencies": {
"wavedrom-cli": "^2.6.8",
"bytefield-svg": "^1.8.0"
}
}
7 changes: 0 additions & 7 deletions doc/build/.gitignore

This file was deleted.

71 changes: 0 additions & 71 deletions doc/build/Makefile

This file was deleted.

Loading