openhwgroup / core-v-xif

RISC-V eXtension interface that provides a generalized framework suitable to implement custom coprocessors and ISA extensions
https://docs.openhwgroup.org/projects/openhw-group-core-v-xif/en
Other
59 stars 24 forks source link

Use list tables #166

Open christian-herber-nxp opened 7 months ago

christian-herber-nxp commented 7 months ago

This specification has a lot of tables. They are all implemented using grid tables. This is the most powerful form of a table in restructure text, and we are not really using its features. They do have quite some disadvantages however. Most importantly, they are annoying to edit, and sometimes you are forced to completely reformat the table if something does not fit into the width of a column. This leads to horrible difs, which make review or comparing versions difficult.

List Tables would handle this much more gracefully.

One would be able to generate the exact binary equivalent output with that directive. Reworking this is however a bit of work, maybe a smart script or an AI could do the job, but I am not aware of a working approach that doesn't require a lot of manual work.