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

Convert to asciidoc #971

Merged
merged 246 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
246 commits
Select commit Hold shift + click to select a range
b6b180c
Merge pull request #912 from riscv/master
wmat Nov 20, 2023
412c417
Initial conversion
wmat Nov 23, 2023
3a91105
Added build dir and new makefile
wmat Nov 23, 2023
e4cc9ca
Renaming old latex Makefile
wmat Nov 24, 2023
579ec1e
Update verify.yml
wmat Nov 24, 2023
6e1da94
Added in missing text and indentation.
wmat Nov 27, 2023
fcd789b
Fixing features lists for missing words and links
wmat Nov 27, 2023
1907199
Fixed anchor
wmat Nov 27, 2023
c2c8e75
Added wavedrom fig, and missing tables.
wmat Nov 27, 2023
b50608e
Fixed footnote.
wmat Nov 27, 2023
3635bde
Format list as asciidoc dlist.
wmat Nov 27, 2023
b57cfec
Adding converted PDF to SVG fig.
wmat Nov 27, 2023
16bc22c
Fix image for system overview.
wmat Nov 27, 2023
d7ada09
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Nov 27, 2023
50df3f9
Fixing conversion issues.
wmat Nov 27, 2023
f96805c
Update verify.yml
wmat Nov 27, 2023
86c6738
Update verify.yml
wmat Nov 28, 2023
832b92a
Update verify.yml
wmat Nov 28, 2023
4cdee8a
Update verify.yml
wmat Nov 28, 2023
246fb35
Update verify.yml
wmat Nov 28, 2023
4c84dc0
Fixing conversion issues.
wmat Nov 28, 2023
0fcc1e9
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Nov 28, 2023
f08cce4
Update verify.yml
wmat Nov 28, 2023
1150b4b
Update verify.yml
wmat Nov 28, 2023
f9e10a7
Update verify.yml
wmat Nov 28, 2023
8da3d63
Fixing conversion issue with missing words
wmat Nov 28, 2023
21cd620
Adding back missing words and cleaning up.
wmat Dec 11, 2023
f06f607
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Dec 11, 2023
19d7fb0
More conversion cleanup
wmat Dec 11, 2023
f61438d
More conversion cleanup.
wmat Dec 11, 2023
36cb1d4
Conversion cleanup
wmat Dec 11, 2023
cc69c8d
Pull in abstract_commands
wmat Dec 11, 2023
1ccf1b8
Added abstract commands to git
wmat Dec 11, 2023
21c8f5e
More conversion cleanup
wmat Dec 11, 2023
2333496
Cleaning up tables.
wmat Dec 11, 2023
dfbb333
Conversion cleanup
wmat Dec 13, 2023
0ca8671
Fixing github verify build.
wmat Dec 13, 2023
2ef6379
Removing duplicated words.
wmat Dec 13, 2023
2458af6
Removing more duplicate words.
wmat Dec 13, 2023
9abda60
Conversion cleanup.
wmat Dec 14, 2023
e4a71fe
Adding access command diagrams.
wmat Dec 18, 2023
06a45ca
Fix access memory tables and clean up.
wmat Dec 18, 2023
0a7d6bc
Fixing table width.
wmat Dec 18, 2023
51fd504
Fixing table widths.
wmat Dec 18, 2023
db75b12
Add --adoc to registers.py.
timsifive Dec 18, 2023
a2b246c
Table formatting and conversion cleanup.
wmat Dec 18, 2023
27b7969
Testing my git access.
wmat Dec 19, 2023
e03768f
Merge branch 'master' of github.com:riscv/riscv-debug-spec into asciidoc
wmat Dec 19, 2023
7bf12f4
Merge pull request #925 from riscv/adoc_xml
wmat Dec 19, 2023
74976e3
Update verify to fix github build.
wmat Dec 19, 2023
f9c1582
Fixing verify to work for asciidoc
wmat Dec 19, 2023
d4c9819
Playing with verify again.
wmat Dec 19, 2023
c146adf
Going back to what I started with.
wmat Dec 19, 2023
f050af9
Trying to fix action build.
wmat Dec 19, 2023
1cf5087
Fixing tables.
wmat Dec 19, 2023
840d438
Table formatting.
wmat Dec 19, 2023
e7d5cc9
Table reformatting.
wmat Dec 19, 2023
c81f802
Table formatting and conversion cleanup.
wmat Dec 19, 2023
a97f1b2
Table formatting and cleanup.
wmat Dec 19, 2023
adf797f
Conversion cleanup.
wmat Dec 19, 2023
2d102dd
Table and conversion cleanup.
wmat Dec 19, 2023
7088f36
Fix asciidoc build within the build directory
rpsene Dec 19, 2023
a8bf78e
Merge pull request #926 from rpsene/asciidoc
wmat Dec 19, 2023
d6917da
Update verify.yml
rpsene Dec 19, 2023
e4e6eae
Merge pull request #927 from riscv/rpsene-patch-ghactions-update
wmat Dec 19, 2023
e37ff6b
Update verify.yml
rpsene Dec 19, 2023
d052140
Update riscv-debug-header.adoc
rpsene Dec 19, 2023
56403c6
Setting toc:left for now
wmat Dec 19, 2023
513b07d
Call registers.py during build to convert XML to adoc.
timsifive Dec 19, 2023
2815a23
Install python3-sympy for build.
timsifive Dec 19, 2023
d3f1ac0
Conversion cleanup.
wmat Dec 20, 2023
63f48b5
Table reformatting and cleanup.
wmat Dec 20, 2023
a0c2ad9
Conversion cleanup.
wmat Dec 20, 2023
a062416
More conversion cleanup.
wmat Dec 20, 2023
d8d7062
Fixed missing bracket.
wmat Dec 20, 2023
5af1a3b
Merge pull request #928 from riscv/adoc_xml
wmat Dec 20, 2023
9108540
Added includes of registers.
wmat Dec 20, 2023
cd743ba
Added register files to git for tracking.
wmat Dec 20, 2023
f6a927b
Adding untracked files.
wmat Dec 20, 2023
d320622
Adding untracked files.
wmat Dec 20, 2023
63d6782
WIP on register formatting
timsifive Dec 20, 2023
4544685
Fix includes, and remove autogenerated files from github.
timsifive Dec 20, 2023
61f35d0
Conversion
wmat Dec 20, 2023
d6ea223
Get register table formatting closer to what we want.
timsifive Dec 20, 2023
8325c0a
Merge branch 'asciidoc' into include_fix
timsifive Dec 20, 2023
0f2a613
Deleted unused qaccess.edn file.
wmat Dec 20, 2023
75bcaf5
Merge pull request #932 from riscv/include_fix
wmat Dec 21, 2023
51d4aa8
Merge pull request #933 from riscv/adoc_fmt
wmat Dec 21, 2023
aa854dc
Adding missing row delimiter pipe
wmat Dec 21, 2023
3bd9706
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Dec 21, 2023
e0acfad
Clean up.
wmat Dec 21, 2023
d9a3b16
Tweak arguments to write to files, instead of relying on stdout.
timsifive Dec 21, 2023
f7138d6
Removing generated files from GitHub
wmat Dec 21, 2023
01a1dc4
Generate macros to refer to registers and fields.
timsifive Dec 21, 2023
8a61259
Change register/field macros from LaTeX to asciidoc.
timsifive Dec 21, 2023
7568e8e
Merge pull request #934 from riscv/registers_py
wmat Dec 22, 2023
d72716b
Removed old pdf
wmat Dec 22, 2023
74e4284
Update .gitignore
wmat Dec 22, 2023
8224acd
Add newline to end of "Auto-generated ..."
timsifive Dec 22, 2023
65623a7
Merge pull request #935 from riscv/gen_line
wmat Dec 22, 2023
acadd27
Clean up remaining LaTeX register/field macros.
timsifive Dec 22, 2023
49d1c04
Merge pull request #936 from riscv/references
wmat Dec 22, 2023
f063b2c
Add /n to end of comment in generated files.
wmat Dec 22, 2023
a292ee3
Bold field access (WARL etc.)
timsifive Dec 22, 2023
518cd88
Get rid of all | that format fields in LaTeX.
timsifive Dec 22, 2023
7df554b
Merge pull request #937 from riscv/bold_access
wmat Dec 22, 2023
c9d4e73
Fix some macro uses that my script got wrong.
timsifive Dec 22, 2023
4a43906
Merge pull request #938 from riscv/hwbpxml
wmat Dec 22, 2023
682f0bc
Draw register diagrams using bytefield-svg
timsifive Dec 27, 2023
3fcd134
Merge pull request #939 from riscv/xml-diagram
wmat Dec 28, 2023
ea33a59
Move label before header.
timsifive Dec 29, 2023
83482fb
Render asciidoc inside table cells, for lists.
timsifive Dec 29, 2023
ac0f59b
Replace LaTeX {steps} with ordered list.
timsifive Dec 29, 2023
008f367
Replace {csr-mcontrol}Six with {csr-mcontrol6}
timsifive Dec 29, 2023
5885135
Merge pull request #940 from riscv/misc_steps
wmat Dec 29, 2023
127620a
Conversion cleanup and fixes.
wmat Dec 29, 2023
994a735
Conversion cleanup and formatting.
wmat Dec 29, 2023
931e241
Conversion cleanup.
wmat Dec 29, 2023
a10a93f
Replacing LaTeX table with asciidoc
wmat Dec 29, 2023
d3e6f9d
Manual conversion of LaTeX table in XML file.
wmat Dec 29, 2023
e663113
Updated table link.
wmat Dec 29, 2023
b3e1637
Updated commentary to admonitions.
wmat Dec 29, 2023
e40db5a
Fixing the links to defined csrs.
wmat Dec 29, 2023
38a5924
Fixing links to core registers.
wmat Dec 29, 2023
0a6692e
Updated table anchor.
wmat Dec 29, 2023
d004044
Add <diagram> option to <register> entries.
rtwfroody Jan 2, 2024
2614760
Replace LaTeX commentary blocks with [NOTE]
rtwfroody Jan 2, 2024
c1d40c5
Merge pull request #942 from riscv/xml-diagram
rtwfroody Jan 2, 2024
e1c2846
Merge pull request #941 from riscv/xml-commentary
wmat Jan 2, 2024
b1d6357
Replace {\tt ...} with `...`
rtwfroody Jan 3, 2024
9ee3e43
Replace \Rreg with `reg`
rtwfroody Jan 3, 2024
c1bffbd
Replace \label and \index with asciidoc versions.
rtwfroody Jan 3, 2024
838a1e0
Add index, so I can check that my \index changes work
rtwfroody Jan 3, 2024
cd363b5
Ignore empty elements in adoc identifier.
rtwfroody Jan 3, 2024
8b1c175
Use auto-generated DM and example registers.
rtwfroody Jan 3, 2024
a99aa43
Fix 2 broken register references.
rtwfroody Jan 3, 2024
f6a20a8
Merge pull request #943 from riscv/xml-cleanup
wmat Jan 3, 2024
06360ba
Fixing wrong links.
wmat Jan 3, 2024
6c9e046
Fixing up more links to registers.
wmat Jan 3, 2024
4044d29
Cleaning up links to registers.
wmat Jan 3, 2024
7f63a24
Conversion cleanup.
wmat Jan 4, 2024
519efe3
Fix Section references in XML files.
rtwfroody Jan 4, 2024
8a6953d
Fix spacing.
wmat Jan 4, 2024
6cfb259
Fix XML references to tab:action.
rtwfroody Jan 4, 2024
2d1cb4e
Fix missing register links.
wmat Jan 4, 2024
9fc97c7
Fixed missing space.
wmat Jan 4, 2024
b0045d1
Merge pull request #945 from riscv/xml-ref
wmat Jan 4, 2024
935f8cb
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Jan 4, 2024
590712b
Fix privmode table.
wmat Jan 4, 2024
f885e05
Fixing up table.
wmat Jan 4, 2024
4c5146d
Fixing refs to register defs.
wmat Jan 4, 2024
1a9cb1a
Fixed tt font with backticks.
wmat Jan 4, 2024
b2ecdfa
Fix table refs and superscript.
wmat Jan 4, 2024
f9b04be
Fix rendering of UNSPECIFIED.
wmat Jan 4, 2024
d5b1767
Fixing up the math formatting.
wmat Jan 4, 2024
a150cfc
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Jan 5, 2024
afd39ff
Reformatted table.
wmat Jan 5, 2024
9f35111
Fixing up the fractions
wmat Jan 5, 2024
8e543d5
Removed extraneous back slashes.
wmat Jan 5, 2024
199e3ba
Fix unordered list.
wmat Jan 5, 2024
df945b4
Including dtm.adoc.
wmat Jan 5, 2024
2ace1b1
Add better references to tables listing each register.
rtwfroody Jan 5, 2024
6899a60
Table clean up.
wmat Jan 5, 2024
c97bf8a
Convert Abstract Register Numbers table, and fix reference
rtwfroody Jan 5, 2024
cad1ef6
Replace \unspecified with UNSPECIFIED in XML
rtwfroody Jan 5, 2024
c403b6c
Replace "\ " with " ", and remove end-of-line whitespace
rtwfroody Jan 5, 2024
478d59e
Set appendices correctly and cleanup.
wmat Jan 5, 2024
a967e4d
Merge pull request #946 from riscv/xml-jan5
wmat Jan 5, 2024
55f82c7
Cleaning up debug appendix
wmat Jan 5, 2024
143b3e1
Cleaned up Using Abstract Command section.
wmat Jan 5, 2024
5e628b8
Adding a temporary file.
wmat Jan 5, 2024
ad233a6
Merge branch 'asciidoc' of github.com:riscv/riscv-debug-spec into asc…
wmat Jan 5, 2024
b212983
Cleaning up tables.
wmat Jan 5, 2024
4082a6a
Table clean up.
wmat Jan 6, 2024
4dcb386
Adding temp file for my debugger chapter changes.
wmat Jan 8, 2024
dcd3e6a
Fixing tables for asciidoc formatting.
wmat Jan 8, 2024
ff7a15d
Table reformatting
wmat Jan 8, 2024
1708ca8
Deleting the temp file I was using.
wmat Jan 8, 2024
8f38beb
Added warning to the preface.
wmat Jan 8, 2024
d85ed2b
Fixing refs and tables.
wmat Jan 8, 2024
302f880
Fixing broken links to registers.
wmat Jan 8, 2024
6d2eb11
Cleaning up broken links.
wmat Jan 8, 2024
7959a08
Substiture links for page numbers.
wmat Jan 8, 2024
58ab812
Fixed a formatting issue.
wmat Jan 9, 2024
ec67685
Fixing links to register defs.
wmat Jan 9, 2024
0534fed
Clean up and add latexmath
wmat Jan 9, 2024
6a7c2e4
Fixed link to table.
wmat Jan 9, 2024
51a1093
Cleaned up double quotes.
wmat Jan 9, 2024
e2ba36d
Clean up.
wmat Jan 9, 2024
231cb43
Don't link to registers that we don't describe.
rtwfroody Jan 9, 2024
4c6f6e0
Merge pull request #947 from riscv/xml-links
wmat Jan 9, 2024
e4de539
Fix references to keepalive and hartsel.
rtwfroody Jan 9, 2024
e8a11e5
Add empty line before starting bytefields.
rtwfroody Jan 9, 2024
7c6a4c9
Merge pull request #948 from riscv/keepalive_hartsel
wmat Jan 9, 2024
809c52d
Merge pull request #949 from riscv/bytefield-space
wmat Jan 9, 2024
5802058
Remove files unnecessary to build asciidoc.
rtwfroody Jan 10, 2024
4cb1db3
Merge pull request #950 from riscv/remove_files
wmat Jan 10, 2024
3e9f1a4
Fix resethaltreq references.
rtwfroody Jan 11, 2024
6f5d040
Merge pull request #952 from riscv/resethaltreq
wmat Jan 11, 2024
e832592
Revive `make debug_defines` and `make chisel`
rtwfroody Jan 12, 2024
f56679a
Merge pull request #954 from riscv/make_code
wmat Jan 12, 2024
b90329c
Clean up remaining LaTeXisms in XML files.
rtwfroody Jan 16, 2024
0683bd3
Make register fields show up in the index.
rtwfroody Jan 16, 2024
f233db1
Merge pull request #955 from riscv/xml-jan16
wmat Jan 16, 2024
8bdb8ef
Merge pull request #956 from riscv/xml-field-index
wmat Jan 16, 2024
b982b11
Make more space for description in field tables.
rtwfroody Jan 19, 2024
265edd0
Merge pull request #958 from riscv/table_field
wmat Jan 19, 2024
f6cf241
Merge branch 'master' into from_master
rtwfroody Jan 25, 2024
d459b1d
Fix version number, and Tim's email address.
rtwfroody Jan 25, 2024
477db5b
Fix stable warning to frozen warning.
rtwfroody Jan 25, 2024
5467850
Add changes from #917.
rtwfroody Jan 26, 2024
d3b3f76
Add changes from #918.
rtwfroody Jan 26, 2024
dc5d135
Add changes from #911.
rtwfroody Jan 26, 2024
b9148d2
Fix authors line.
rtwfroody Jan 26, 2024
4c6fe6f
Merge pull request #959 from riscv/from_master
wmat Jan 26, 2024
cb07ea6
Fix reference typo.
rtwfroody Jan 29, 2024
caf758c
Fix gitignore for adoc files instead of LaTeX ones.
rtwfroody Jan 30, 2024
7fcdc10
Remove LaTeX PDF.
rtwfroody Jan 30, 2024
f0b9cb0
Don't put an anchor in front of register overview tables.
rtwfroody Jan 31, 2024
b760640
Put build artifact images in the build/images directory.
rtwfroody Jan 31, 2024
64052e2
Image path fix-up, so images work.
rtwfroody Jan 31, 2024
69486ef
Remove now-unused file.
rtwfroody Jan 31, 2024
bd3aa10
Merge pull request #961 from riscv/fix_warnings
wmat Jan 31, 2024
bc3d7a4
Newer docs-resources has nice table font size.
rtwfroody Feb 1, 2024
810754f
Increase register diagram font sizes.
rtwfroody Feb 1, 2024
648a8f8
Update verify.yml
wmat Feb 1, 2024
da6734a
Update verify.yml
wmat Feb 1, 2024
81b9b93
Update verify.yml
wmat Feb 1, 2024
84804d8
Update verify.yml
wmat Feb 1, 2024
49ccae0
Update verify.yml
wmat Feb 1, 2024
f9e14bf
Update verify.yml
wmat Feb 1, 2024
b8ae589
Merge pull request #962 from riscv/font_size
wmat Feb 1, 2024
d8adb6a
Version is 1.0.0-rc1
rtwfroody Feb 6, 2024
19a367b
Add newline after register description.
rtwfroody Feb 6, 2024
f9037b2
Tweak editors formatting, and put myself first.
rtwfroody Feb 6, 2024
d532342
Fix reference to index.
rtwfroody Feb 6, 2024
e5b43b4
Remove email from authors line.
rtwfroody Feb 7, 2024
fd51d21
Merge pull request #963 from riscv/title_page
wmat Feb 7, 2024
5065ca5
Remove stray $ left over from LaTeX.
rtwfroody Feb 8, 2024
921a26f
Rephrase text to avoid $ formatting.
rtwfroody Feb 8, 2024
66b857c
Merge pull request #965 from riscv/dollars
rtwfroody Feb 9, 2024
fffbaa2
Make space in short fields for the offset.
rtwfroody Feb 14, 2024
7cbd0f9
Make more vertical space for offset.
rtwfroody Feb 14, 2024
e6f4a36
Prevent offsets from overlapping at the edges.
rtwfroody Feb 14, 2024
b079fc1
Merge pull request #970 from riscv/diagram_spacing
wmat Feb 14, 2024
a1bef9b
Update README links to "latest" versions.
rtwfroody Feb 21, 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
47 changes: 36 additions & 11 deletions .github/workflows/verify.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,38 @@
name: Verify Build
on: [push]

on:
pull_request:
push:
branches:
- asciidoc

jobs:
Build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: sudo apt-get update
- run: >
sudo apt-get install python3-sympy texlive-latex-base \
texlive-latex-recommended texlive-latex-extra \
texlive-fonts-extra texlive-science
- run: make draft stable release chisel
build:
runs-on: ubuntu-latest

steps:
# Step 0: Install build requirements
- name: Install Build Requirements
run: sudo apt update && sudo apt install -y python3-sympy

# Step 1: Checkout the repository
- name: Checkout repository
uses: actions/checkout@v3
with:
submodules: 'recursive'

# Step 2: Pull the latest RISC-V Docs container image
- name: Pull Container
run: docker pull riscvintl/riscv-docs-base-container-image:latest

# Step 3: Build Files
- name: Build Files
run: cd ./build && make

# Step 4: Upload the built PDF files as a single artifact
- name: Upload Build Artifacts
uses: actions/upload-artifact@v3
with:
name: Build Artifacts
path: ${{ github.workspace }}/build/*.pdf
retention-days: 30
30 changes: 5 additions & 25 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
# LaTeX intermediate files
*.aux
*.idx
*.ilg
*.ind
*.lof
*.log
*.out
*.toc
*.lot
*.hst
*.ver

# Generated files
*_registers.tex
*_registers.tex.inc
*_registers.h
serial.*
abstract_commands.*
debug_defines.*

# Changelogs
changelog.tex
vc.tex
build/*.adoc
build/images
build/.asciidoctor
build/*.pdf

# Resulting PDFs
riscv-debug-workgroup-notes.pdf
.vscode
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 = https://github.com/riscv/docs-resources.git
99 changes: 0 additions & 99 deletions Makefile

This file was deleted.

5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
RISC-V Debug Specification
==========================

The current master branch is v1.0.0-frozen.

You may be looking for one of the following pre-built PDFs:
* [Latest frozen](https://github.com/riscv/riscv-debug-spec/blob/master/riscv-debug-frozen.pdf)
* [Latest release candidate](https://github.com/riscv/riscv-debug-spec/releases)
* [Latest release](https://github.com/riscv/riscv-debug-spec/blob/release/riscv-debug-release.pdf)
(This is outdated at this point, and only of historical interest.)

Build Instructions
------------------
Expand Down
Loading
Loading