Move spec to AsciiDoc #91
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added submodule for docs-resources. Converted all LaTeX src to asciidoc src. Added header file.
Reformatted the Basic Control table as asciidoc.
Reformatting tables as asciidoc.
Formatted tables as asciidoc and fixed references.
Cleaned up single quotes.
Fixed link to figure and set figure caption in theme to center.
Formatting table to asciidoc
Reformatted tables to asciidoc format and relocated them to match LaTeX spec.
Fixed up some references.
Fixed up some references and added an empty line at the eof in order to allow the next included file to parse correctly.
Reformatted tables and updated references.
Wrapped xml code in a source code block, removed backticks.
Formatting the pseudo code using the c++ source highlighting. This can be easily changed.
Wrapped the examples in source blocks as c code. This can be easily changed lated.
Formatting the code examples and cleaning up the monospaced backticked text.
Deleted Zexmpl from the doc title, must have been a cut and paste error on my part.
Updated revision daate and revision number to match latest LaTeX version.
Changing SRET to DRET to match LaTeX changes.
Manually applying commit 4731525 to match most recent LaTeX changes.
Fixed link to filtering chapter.
Fixed link to a table.
Wrapped link to filtering chapter in correct << >>.
Reformatting table.
Fixed missing plus sign.
Trying to get column widths better and fixing a broken link to a section.
Fixed a nesting issue with the title_page.
Adjusted the theme to remove duplication of variables found in the header. Set monospaced font to 8 and table font to 8. Added changelog. Centered content on title page.
Fixing theme and adding missing images.
xrefs between asciidoc files use the xref: macro. This change fixed two in chapter 2.
Removing :media: prepress from theme fixes issue with broken links.
Changed <<alt-multi>> to <<sec:alt-multi>>.
Changed table index to <<tab:ingress-side-band>>.
Added index to Synchronization section in Ch. 3 and fixed link to it in Ch. 9.
Deleted an extraneous > from the index for tab:dataAttributes.
Changed 2023 to 2024 in header.
Turns out we want :media: prepress set to get the recto/verso margins to display correctly in the PDF. Therefore setting it and setting the don't show uri links attribute.
Coderay doesn't support the code we're using here so removing the C code highlighting.
We shouldn't be storing spec specific images in the docs-resources directory of the submodule.
Moved logo to images directory and changed to svg version.
Add logo to git tracking.
Updated Gajinder's email address.
Update .gitignore to ignore generated stem files.
As we have build-pdf.yml file we don't need this older build file.
Update .gitignore to ignore stem files.
Updated submoduele
|
@IainCRobertson, what are your plans for getting this reviewed? |
|
Hi Jeff. I reviewed the Asciidoc version of the spec with Bill prior to this PR, but it wasn't clear to me who was responsible for merging this. I can review, and if I'm happy that it is an accurate transformation from LaTeX, are you happy for me to just merge, or does someone else need to bless it off? |
|
Feel free to merge, Iain.
Bill Traynor
Documentation Build and Release Engineer
RISC-V International
…On Tue, Feb 27, 2024 at 5:35 PM IainCRobertson ***@***.***> wrote:
Hi Jeff. I reviewed the Asciidoc version of the spec with Bill prior to
this PR, but it wasn't clear to me who was responsible for merging this. I
can review, and if I'm happy that it is an accurate transformation from
LaTeX, are you happy for me to just merge, or does someone else need to
bless it off?
—
Reply to this email directly, view it on GitHub
<#91 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAN6ZGO3W6H4EEUPZPL7OTYVZNURAVCNFSM6AAAAABCCFA6COVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRXG44DMMZUGA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
|
Reviewed and looks okay. |
|
Done 😊.
I assume you or Jeff will take care of publishing and updating the Technical Specification page to link to the new asciidoc based PDF?
Iain
From: Bill Traynor ***@***.***>
Sent: Tuesday, February 27, 2024 11:11 PM
To: riscv-non-isa/riscv-trace-spec ***@***.***>
Cc: Robertson, Iain (DI SW ICS TST RD EAH) ***@***.***>; Mention ***@***.***>
Subject: Re: [riscv-non-isa/riscv-trace-spec] Move spec to AsciiDoc (PR #91)
Feel free to merge, Iain.
Bill Traynor
Documentation Build and Release Engineer
RISC-V International
On Tue, Feb 27, 2024 at 5:35 PM IainCRobertson ***@***.***<mailto:***@***.***>> wrote:
Hi Jeff. I reviewed the Asciidoc version of the spec with Bill prior to
this PR, but it wasn't clear to me who was responsible for merging this. I
can review, and if I'm happy that it is an accurate transformation from
LaTeX, are you happy for me to just merge, or does someone else need to
bless it off?
—
Reply to this email directly, view it on GitHub
<#91 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAN6ZGO3W6H4EEUPZPL7OTYVZNURAVCNFSM6AAAAABCCFA6COVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRXG44DMMZUGA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***<mailto:***@***.***>>
—
Reply to this email directly, view it on GitHub<#91 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ALQOPSQGI2ZN337AP7VPKMDYVZRWXAVCNFSM6AAAAABCCFA6COVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRXHA3TSNJRHE>.
You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>
|
|
Yes, we’ll take care of that.
Bill Traynor
Documentation Build and Release Engineer
RISC-V International
On Thu, Feb 29, 2024 at 8:39 PM IainCRobertson ***@***.***>
wrote:
… Done 😊.
I assume you or Jeff will take care of publishing and updating the
Technical Specification page to link to the new asciidoc based PDF?
Iain
From: Bill Traynor ***@***.***>
Sent: Tuesday, February 27, 2024 11:11 PM
To: riscv-non-isa/riscv-trace-spec ***@***.***>
Cc: Robertson, Iain (DI SW ICS TST RD EAH) ***@***.***>; Mention
***@***.***>
Subject: Re: [riscv-non-isa/riscv-trace-spec] Move spec to AsciiDoc (PR
#91)
Feel free to merge, Iain.
Bill Traynor
Documentation Build and Release Engineer
RISC-V International
On Tue, Feb 27, 2024 at 5:35 PM IainCRobertson ***@***.***<mailto:***@***.***>>
wrote:
> Hi Jeff. I reviewed the Asciidoc version of the spec with Bill prior to
> this PR, but it wasn't clear to me who was responsible for merging this.
I
> can review, and if I'm happy that it is an accurate transformation from
> LaTeX, are you happy for me to just merge, or does someone else need to
> bless it off?
>
> —
> Reply to this email directly, view it on GitHub
> <
#91 (comment)>,
> or unsubscribe
> <
https://github.com/notifications/unsubscribe-auth/AAAN6ZGO3W6H4EEUPZPL7OTYVZNURAVCNFSM6AAAAABCCFA6COVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRXG44DMMZUGA>
> .
> You are receiving this because you authored the thread.Message ID:
> ***@***.***<mailto:***@***.***>>
>
—
Reply to this email directly, view it on GitHub<
#91 (comment)>,
or unsubscribe<
https://github.com/notifications/unsubscribe-auth/ALQOPSQGI2ZN337AP7VPKMDYVZRWXAVCNFSM6AAAAABCCFA6COVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRXHA3TSNJRHE>.
You are receiving this because you were mentioned.Message ID:
***@***.******@***.***>>
—
Reply to this email directly, view it on GitHub
<#91 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAN6ZHUXUAJ5QMF3WJ4SETYV7L45AVCNFSM6AAAAABCCFA6COVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZSGI4TCNRRHA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR for change to AsciiDoc.