riscv-ctg icon indicating copy to clipboard operation
riscv-ctg copied to clipboard

Missing documentation for Instr Attributes

Open cmuellner opened this issue 1 year ago • 1 comments

The following instruction attributes are not documented (see https://riscv-ctg.readthedocs.io/en/latest/overview.html#attributes):

  • std_op
  • sig and its subfields stride and sz

Further, the example has the following template:

  template: |

    // $comment
    // opcode: $inst ; op1:$rs1; op2:$rs2; dest:$rd; op1val:$rs1_val;  op2val:$rs2_val
    TEST_RR_OP($inst, $rd, $rs1, $rs2, $correctval, $rs1_val, $rs2_val, $swreg, $offset, $testreg)

However, a |- should be there instead of the |.

Additionally, the order of attributes does not match the order used in most templates.

cmuellner avatar Mar 21 '23 19:03 cmuellner

The following instruction attributes are not documented (see https://riscv-ctg.readthedocs.io/en/latest/overview.html#attributes):

* `std_op`

* `sig` and its subfields `stride` and `sz`

However, a |- should be there instead of the |.

Noted. Documentation needs to be updated with this information.

Additionally, the order of attributes does not match the order used in most templates.

The order of attributes does not matter because these are serialized as a dictionary entry(key-value pairs).

pawks avatar Mar 22 '23 04:03 pawks