search

riscv-software-src / riscv-unified-db

Machine-readable database of the RISC-V specification, and tools to generate various views
Other
20 stars 15 forks source link

automation for human language linting of prose in yaml files #293

Open kbroch-rivosinc opened 2 days ago

kbroch-rivosinc commented 2 days ago

To consistently apply style rules across the spec being written by many people, automation could be used.

One such solution "vale" is already being worked with https://github.com/riscv-admin/docs-sig/issues/5

Just want to discuss the deployment of it here.

It could start small even with solving the problem of inconsistency with sentences ending with punctuation seen here:

~/rvi/repos/riscv-software-src/riscv-unified-db/arch/inst/I on main ?8                                                                                    Py 3.12.4 Ruby 3.3.4 at 07:56:53 AM
❯ yq ".name,.description"  add*.yaml
add
Add the value in rs1 to rs2, and store the result in rd.
Any overflow is thrown away.

---
addi
---
Add an immediate to the value in rs1, and store the result in rd
---
addiw
---
Add an immediate to the 32-bit value in rs1, and store the sign extended result in rd
---
addw
---
Add the 32-bit values in rs1 to rs2, and store the sign-extended result in rd.
Any overflow is thrown away.
dhower-qc commented 1 day ago

I'm all for this.