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

Fix wording and formatting of x0 special cases #1770

Merged
merged 3 commits into from
Dec 16, 2024

Conversation

pfusik
Copy link
Contributor

@pfusik pfusik commented Dec 12, 2024

Restore semicolons removed accidentally in aaad788

@wmat
Copy link
Collaborator

wmat commented Dec 12, 2024

Thanks for this, those semicolons somehow went missing. Can I suggest that you also change the "only valid" to "valid only", as it's grammatically an improvement.

@pfusik
Copy link
Contributor Author

pfusik commented Dec 12, 2024

How about normalizing these "not equal" signs? Some are UTF-8, some are HTML entities and some are latexmath. I think UTF-8 would be best.

@wmat
Copy link
Collaborator

wmat commented Dec 12, 2024

I think UTF-8 would work. Perhaps add attributes to the header docs for UTF-8 replacements, such as:

:le: ≤
:ge: ≥
:lt: <
:gt: >

Then replace in the asciidoc files with attribute references such as {ge}

@pfusik
Copy link
Contributor Author

pfusik commented Dec 12, 2024

What do you mean by "header docs" ? Why use attribute references if we can (and already do) directly use Unicode characters? Especially for ASCII characters such as < and >.

@wmat
Copy link
Collaborator

wmat commented Dec 12, 2024

Asciidoc requires header docs, for the ISA manuals, they are riscv-unprivileged.adoc and riscv-privileged.adoc. At the beginning of each is a set of attributes that asciidoctor requires to build the full documents. Adding attributes for unicode would but down on a few keystrokes for extension authors.

@pfusik
Copy link
Contributor Author

pfusik commented Dec 13, 2024

I see, there's no on keyboards. But it was already extensively used and WYSIWYG. It's easier to copy the whole phrase than to re-type it. latexmath ended up in HTML as SVG - not good for screen readers.

@pfusik
Copy link
Contributor Author

pfusik commented Dec 13, 2024

When merging, please select my Samsung email.

Copy link
Member

@aswaterman aswaterman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title of this PR does not reflect what it actually does. It makes several wording changes.

@pfusik pfusik changed the title Restore semicolons in "C" Extension spec Fix wording and formtting of x0 special cases Dec 14, 2024
@pfusik pfusik changed the title Fix wording and formtting of x0 special cases Fix wording and formatting of x0 special cases Dec 14, 2024
Copy link
Member

@aswaterman aswaterman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much improved, thank you.

@aswaterman aswaterman merged commit 472a620 into riscv:main Dec 16, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants