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

Change "implementor" to "implementers"; fix a couple typos #1830

Open
kbroch-rivosinc opened this issue Jan 28, 2025 · 3 comments
Open

Change "implementor" to "implementers"; fix a couple typos #1830

kbroch-rivosinc opened this issue Jan 28, 2025 · 3 comments
Assignees

Comments

@kbroch-rivosinc
Copy link
Contributor

Mostly did this as way to find terms not in the vocabulary of codespell (that we might want to include when running vale @kersten1 ). But did find some typos and "old" English.

Here's results of initial run of codespell and getting counts of things it thinks are spelling errors:

~/rvi/repos/riscv/riscv-isa-manual on main                                                                                                   at 11:27:39 AM
❯ codespell src | cut -d ' ' -f2  | sort | uniq -c  | sort -nr
 282 hart
 219 edn
  42 Hart
  41 sie
  25 STIP
  22 vill
  22 SIE
  10 SXL
  10 FLE
   9 covert
   6 vor
   5 implementor
   5 bund
   5 SHS
   4 useed
   3 implementors
   2 rouge
   2 USEED
   2 INH
   2 Covert
   2 Colum
   2 BU
   2 ADDD
   1 unstalls
   1 spcifiers
   1 ois
   1 inbetween
   1 Synopsys
   1 Specifiations
   1 Jaques
   1 Implementors
   1 Commun

Most of the above are words/term, so made exceptions for those, fixed the others and now it runs clean:

~/rvi/repos/riscv/riscv-isa-manual on dev/kbroch/codespell-corrections:main wip ⇡1                                                           at 11:31:03 AM
❯ codespell -L edn,hart,Hart,sie,STIP,vill,SIE,SXL,FLE,rouge,bund,covert,useed,vor,SHS,Synopsys,ADDD,BU,unstalls,INH,Colum,inbetween,Commun,Jaques,ois  src ~/rvi/repos/riscv/riscv-isa-manual on dev/kbroch/codespell-corrections:main wip ⇡1                                                           at 11:31:24 AM
❯
@kbroch-rivosinc kbroch-rivosinc self-assigned this Jan 28, 2025
@ved-rivos
Copy link
Collaborator

Some of these waivers may need to be fixed:

  • rouge -> rogue
  • Synopsys -> synopsis
  • Commun -> Common
  • bund -> bound
  • Colum -> Column

@kbroch-rivosinc
Copy link
Contributor Author

Some of these waivers may need to be fixed:

  • rouge -> rogue
  • Synopsys -> synopsis
  • Commun -> Common
  • bund -> bound
  • Colum -> Column

@ved-rivos : thanks for taking a look. I'll make change noted below:

generated clickable links from your suggestions:

❯ codespell -L edn,hart,Hart,sie,STIP,vill,SIE,SXL,FLE,covert,useed,vor,SHS,ADDD,BU,unstalls,INH,inbetween,Jaques,ois  src | gsed -e 's/\:/?plain=1#L/' | xargs -I {} echo "https://github.com/riscv/riscv-isa-manual/blob/main/{}"

https://github.com/riscv/riscv-isa-manual/blob/main/src/history.adoc?plain=1#L76: Synopsys ==> Synopsis
https://github.com/riscv/riscv-isa-manual/blob/main/src/riscv-privileged.adoc?plain=1#L38: rouge ==> rogue
https://github.com/riscv/riscv-isa-manual/blob/main/src/riscv-unprivileged.adoc?plain=1#L35: rouge ==> rogue
https://github.com/riscv/riscv-isa-manual/blob/main/src/scalar-crypto.adoc?plain=1#L5344: Colum ==> Column
https://github.com/riscv/riscv-isa-manual/blob/main/src/scalar-crypto.adoc?plain=1#L5350: Colum ==> Column
https://github.com/riscv/riscv-isa-manual/blob/main/src/resources/riscv-spec.bib?plain=1#L933: bund ==> bind, bound
https://github.com/riscv/riscv-isa-manual/blob/main/src/resources/riscv-spec.bib?plain=1#L1090: Commun ==> Commune, Common
https://github.com/riscv/riscv-isa-manual/blob/main/src/resources/riscv-spec.bib?plain=1#L1309: bund ==> bind, bound
https://github.com/riscv/riscv-isa-manual/blob/main/src/resources/riscv-spec.bib?plain=1#L1320: bund ==> bind, bound
https://github.com/riscv/riscv-isa-manual/blob/main/src/resources/riscv-spec.bib?plain=1#L1402: bund ==> bind, bound
https://github.com/riscv/riscv-isa-manual/blob/main/src/resources/riscv-spec.bib?plain=1#L1592: bund ==> bind, bound

I think only the Colum -> Column end up being a problem. I probably should have skipped the *.bib page completely.

@ved-rivos
Copy link
Collaborator

I think only the Colum -> Column end up being a problem.

@kbroch-rivosinc - agree!

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

No branches or pull requests

2 participants