Conversion of LaTeX spec to asciidoc. #53
Conversation
Reorganized file structure to standard doc layout. Converted all tex to asciidoc. Added docs-resources submodule. Moved latex to latex archive folder.
Converted spec to asciidoc and applied standard spec template.
Signed-off-by: John Hauser <31252952+jhauser-us@users.noreply.github.com>
Signed-off-by: John Hauser <31252952+jhauser-us@users.noreply.github.com>
Adding dependencies to git tracking.
Title page info is in the asciidoc header in the preamble and contributors is moved to colophon.
Placed TOC after preface. Fixed broken file reference.
Cleaning up some issues after conversion to asciidoc.
Fixed several anchors. Cleaned up monospaced fonts.
Fixing anchors and image ref.
Fixed image macros. Changed placement of images. Fixed up table formatting. Fixed broken latexmath.
Adding back missing monospaced font text. Fixing up anchors.
Adding back missing monospaced font text. Cleaned up table.
Adding back more missing monospaced text. Fixing anchors.
Adding resources to Makefile for PDF generation. More conversion cleanup.
Removed all /mbox instances as it breaks asciidoctor- mathematical output as svg.
Added in many missing monespaced font text. Added tables. Cleaned up some garbage characters.
Cleaning up some poorly converted latexmath.
Added in missing monspaced text. Fixed up tables.
In asciidoc, indentation cause the text to become a literal block and render exactly as in the doc. In this case, we don't want that.
Adding back the text RISC-V. Fixing up images include macros. Other small conversion clean up.
Fixed tables. Fixed section and chapter anchors. Various small conversion text fixes.
Adding back all the missign text. Fixing latexmath. Lots of small textual cleanup.
Set sectnumlevels to 4. Added back in missing text. Fixed tables. Numerous other small cleanups.
Got two out of three formulas fixed.
Added in missing text. Cleaned up random characters.
Table formatting
Added in missing text. Formatted tables.
Table formatting Adding missing text
Added missing text for monspaced fonts Table formatting
Added the missing word UNSPECIFIED, domaincfg and a left parentheses.
Added in missing word ithreshold
Added latexmath:[$i$] to pseudocode and a missing closing quote.
Fixed missing parentheses in formulas and missing register name.
Moving table 10 outside of the note.
Replace svip with mvip.
Added missing register name stopi and missing i in pseudocode
Added missing vstopi
|
Thanks again, @jhauser-us all of these issues have been fixed. Note that a few of them exist in the released spec, so the asciidoc version is moving forward with corrections that the original spec does not have. |
Really? Which ones? I've been comparing directly with the released spec. |
|
I believe one of the - i in the pseudocode and one of the spelling mistakes that I can't remember off the top of my head. I can check again tomorrow. It's possible my pdf of the released spec is old though. |
|
Another batch of errors I've found, probably the last ones: In Section 6.1, "VS-level external interrupts with a guest interrupt file": In the first sentence of the second paragraph, register name vsiselect is miswritten as "viselect". In Section 6.3.1, "Configuring priorities of major interrupts at VS level": In the first sentence of the second paragraph, register name vsiselect is miswritten as "vsiseelect". In Section 6.3.2, "Virtual interrupts for VS level": In the sentence that is supposed to read "Bits 12:0 of hvien are reserved and must be read-only zeros, ...", register hvien has been incorrectly replaced by hvip. (The first part of this sentence is about hvien; the second part is about hvip.) In the sentence that begins "For interrupt numbers 13-63, a bit in vsie is writable if and only if ...", register name hvien is miswritten as "hiven". In the bullet point that says "asserting for VS level a major interrupt not supported by hvien and hvip;", register name hvien is miswritten as "hvvien". In the title for Section 6.3.3, "Virtual supervisor top interrupt CSR (vstopi)", the register name vstopi is missing. In Chapter 7, "Interprocessor Interrupts (IPIs)": In a note, in the sentence that begins "On such a trap, software can send a higher-level IPI via IMSIC ...", register name sip is missing (should be, "set the SSIP bit in sip"). In Section 8.3.2, "Recording of incoming MSIs to memory-resident interrupt files": In the sentence that begins "IMSIC interrupt files may also accept MSIs in big-endian byte order ...", register name seteipnum_be is miswritten as "setipnum_be". |
vsiselect register name was incorrectly written as viselect.
Register hvien was incorrectly written as hvip.
Fix hvien register name which was written as hvvien.
The register name vstopi was missing from the section title.
Sentence was missing the register name sip.
Fix spelling of seteipnum_be register name.
|
Thanks @jhauser-us , I've made all of the fixes. |
|
Hi @jhauser-us , so the next step would be to rename the main branch to "latex" and rename the asciidoc branch as "main" to set the asciidoc as the default branch. You'll have to audit the 27 open issues against the LaTeX branch and perhaps encourage the authors to move the issue to the asciidoc. |
|
The caption for Table 10 should not be in the middle of the table. See similar Table 12 for comparison. |
Not sure why Table 10 was broken into two separate tables. Now fixed.
|
Table 10 has been fixed. |
Conversion of LaTeX specification to asciidoc.