Convert to asciidoc #971
Convert to asciidoc #971
Conversation
SYncing with master
Added a document header adoc file. Initial conversion of the tex to adoc using pandoc.
Added build dir and new makefile for PDF and HTML from asciidoc.
Renamed latex Makefile to Makefile-latex
Setting to only verify on asciidoc branch. Signed-off-by: Bill Traynor <[email protected]>
For some reason the bolded text was omitted on conversion, therefore re-adding as well as indentation.
Added back in all the missing anchors. Added ordered list formatting.
Setting anchor to asciidoc format.
Added wavedrom diagram for long name. Added missing table for register access abbreviations.
Fixed footnote format.
Using the asciidoc dlist format to get correct formatting.
Added converted PDF to SVG for use in the doc.
Converted system overview diagram to png. Updated anchors.
Adding back in missing anchores and admonitions.
Signed-off-by: Bill Traynor <[email protected]>
Signed-off-by: Bill Traynor <[email protected]>
Signed-off-by: Bill Traynor <[email protected]>
Moving to docker build. Signed-off-by: Bill Traynor <[email protected]>
Signed-off-by: Bill Traynor <[email protected]>
Adding in missing words.
Fixing docker build. Signed-off-by: Bill Traynor <[email protected]>
Adding some context to the PDF build. Signed-off-by: Bill Traynor <[email protected]>
Fixing target. Signed-off-by: Bill Traynor <[email protected]>
Added back in missing anchors.
Adding back all of the missing words that didn't convert correctly and cleaning up conversion issues.
Added back in missing words that didn't convert.
Adding in missing words and general conversion cleanup.
Signed-off-by: Bill Traynor <[email protected]>
Signed-off-by: Bill Traynor <[email protected]>
Increase font size in tables and register diagrams.
Not rc0
Now "This CSR is read/write/whatever" message appears in a separate paragraph like it does in the original document.
I've been working on this spec since the very start, and Paul is OK not being alphabetically sorted.
It never parses right. I can't figure out how to do this properly.
Misc asciidoc fixes.
Instead explicitly list both fields.
Remove stray $ left over from LaTeX.
E.g. if the field is "hit" and the offset is "XLEN-18" then the field needs to be sized to accommodate that offset.
Top of some characters would sometimes be cut off otherwise.
bytefield really handles this very poorly, so this is a hack by moving long offsets in a bit. Now some look a little odd with not much space between upper and lower offset, but at least there's no actual overlapping text anymore.
Fix text overlapping in offsets in register diagrams.
There was a problem hiding this comment.
Other specs changed the branch name from master to main as part of this process. Is that something that we're supposed to also do as part of the inclusive naming policy? Either way, we can also do what riscv-isa-manual did and also create a branch named latex which is the final latex version (for easy reference if we ever need to look at that).
@wmat probably knows something about what we're supposed to do.
|
Changing branch names seems like a completely separate change that has nothing to do with asciidoc. Makes sense to make a latex branch if people find that helpful. I'll do that after this merges. |
|
Actually, when I "flipped the switch" to asciidoc on riscv0isa-manual I did change the master branch to main. This makes the repo comply with inclusive language rules. |
|
I agree that the branch name is orthogonal but now is a convenient time, no? It seems like we could effectively rename merge_asciidoc to be main and rename master to be latex. |
|
I'd suggest renaming master to latex, then renaming asciidoc to main. That way you have the latex branch as a separate branch. |
|
I definitely want a regular merge to happen in the interest of keeping the git history consistent, and to have the tools automatically enforce that we didn't miss merging something. So:
|
|
That's better than my plan :) |
Once this merges, I'll make a github release including the PDF, so the first link will work.
|
I made the latex branch. |
Convert from LaTeX to asciidoc, to be consistent with other RISC-V specifications.
The only notable regression is that there is no longer a list of tables and figures. There is no good asciidoc support for this.
#966 tracks this.