Skip to content

Commit effa6b4

Browse files
fix(data): make descriptions consistent with the RISC-V style guidelines (#1084)
...and fix a few spelling mistakes. Closes #1082
1 parent 1b1692b commit effa6b4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+205
-203
lines changed

backends/instructions_appendix/all_instructions.golden.adoc

Lines changed: 102 additions & 101 deletions
Large diffs are not rendered by default.

spec/std/isa/inst/D/fadd.d.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description:
1111
- id: inst-fadd.d-behaviour
1212
normative: false
1313
text: |
14-
`FADD.D` is analogous to `FADD.S` and performs double-precision floating-point addition between
15-
_fs1_ and _fs2_ and writes the final result to _fd_.
14+
The `fadd.d` instruction is analogous to `fadd.s` and performs double-precision floating-point addition between
15+
`fs1` and `fs2` and writes the final result to `fd`.
1616
definedBy: D
1717
assembly: fd, fs1, fs2, rm
1818
encoding:

spec/std/isa/inst/D/fclass.d.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ description:
1111
- id: inst-fclass.d-behaviour
1212
normative: false
1313
text: |
14-
`FCLASS.D` is defined analogously to its single-precision counterpart, but operates on double-precision operands.
15-
It examines the value in floating-point register _fs1_ and writes to integer register _xd_ a 10-bit mask that
14+
The `fclass.d` instruction is defined analogously to its single-precision counterpart, but operates on double-precision
15+
operands. It examines the value in floating-point register `fs1` and writes to integer register `xd` a 10-bit mask that
1616
indicates the class of the floating point number.
1717
18-
The format of the mask is described in the table below. The corresponding bit in _xd_ will be set if the property
19-
is true and clear otherwise. All other bits in _xd_ are cleared. Note that exactly one bit in xd will be set.
18+
The format of the mask is described in the table below. The corresponding bit in `xd` will be set if the property
19+
is true and clear otherwise. All other bits in `xd` are cleared. Note that exactly one bit in `xd` will be set.
2020
2121
.Format of result of `fclass` instruction.
2222
[%autowidth,float="center",align="center",cols="^,<",options="header",]

spec/std/isa/inst/D/fcvt.d.l.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description:
1111
- id: inst-fcvt.d.l-behaviour
1212
normative: false
1313
text: |
14-
`FCVT.D.L` converts a 64-bit signed integer, in integer register _xs1_ into a double-precision
15-
floating-point number in floating-point register _fd_.
14+
The `fcvt.d.l` instruction converts a 64-bit signed integer, in integer register `xs1` into a double-precision
15+
floating-point number in floating-point register `fd`.
1616
definedBy: D
1717
assembly: fd, xs1, rm
1818
encoding:

spec/std/isa/inst/D/fcvt.d.lu.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description:
1111
- id: inst-fcvt.d.lu-behaviour
1212
normative: false
1313
text: |
14-
`FCVT.D.LU` converts to or from a 64-bit unsigned integer, _xs1_ into a double-precision
15-
floating-point number in floating-point register _fd_.
14+
The `fcvt.d.lu` instruction converts to or from a 64-bit unsigned integer, `xs1` into a double-precision
15+
floating-point number in floating-point register `fd`.
1616
definedBy: D
1717
assembly: fd, xs1, rm
1818
encoding:

spec/std/isa/inst/D/fcvt.d.s.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ description:
1111
- id: inst-fcvt.d.s-behaviour
1212
normative: false
1313
text: |
14-
The single-precision to double-precision conversion instruction, `FCVT.D.S` is encoded in the OP-FP
14+
The single-precision to double-precision conversion instruction, `fcvt.d.s` is encoded in the OP-FP
1515
major opcode space and both the source and destination are floating-point registers. The `xs2` field
1616
encodes the datatype of the source, and the `fmt` field encodes the datatype of the destination.
17-
`FCVT.D.S` will never round.
17+
`fcvt.d.s` will never round.
1818
definedBy: D
1919
assembly: fd, fs1, rm
2020
encoding:

spec/std/isa/inst/D/fcvt.d.w.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ description:
1111
- id: inst-fcvt.d.w-behaviour
1212
normative: false
1313
text: |
14-
`FCVT.D.W` converts a 32-bit signed integer, in integer register _xs1_ into a double-precision
15-
floating-point number in floating-point register _fd_. Note `FCVT.D.W` always produces an exact
16-
result and is unaffected by rounding mode.
14+
The `fcvt.d.w` instruction converts a 32-bit signed integer, in integer register `xs1` into a double-precision
15+
floating-point number in floating-point register `fd`. Note `fcvt.d.w` always produces an exact result and is
16+
unaffected by rounding mode.
1717
definedBy: D
1818
assembly: fd, xs1, rm
1919
encoding:

spec/std/isa/inst/D/fcvt.d.wu.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ description:
1111
- id: inst-fcvt.d.wu-behaviour
1212
normative: false
1313
text: |
14-
`FCVT.D.WU` converts a 32-bit unsigned integer in integer register _xs1_ into a double-precision
15-
floating-point number in floating-point register _fd_. Note `FCVT.D.WU` always produces an exact
16-
result and is unaffected by rounding mode.
14+
The `fcvt.d.wu` instruction converts a 32-bit unsigned integer in integer register `xs1` into a double-precision
15+
floating-point number in floating-point register `fd`. Note `fcvt.d.wu` always produces an exact result and is
16+
unaffected by rounding mode.
1717
definedBy: D
1818
assembly: fd, xs1, rm
1919
encoding:

spec/std/isa/inst/D/fcvt.l.d.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description:
1111
- id: inst-fcvt.l.d-behaviour
1212
normative: false
1313
text: |
14-
`FCVT.L.D` converts a double-precision floating-point number in floating-point register _fs1_
15-
to a signed 64-bit integer, in integer register _xd_.
14+
The `fcvt.l.d` instruction converts a double-precision floating-point number in floating-point register `fs1`
15+
to a signed 64-bit integer, in integer register `xd`.
1616
definedBy: D
1717
assembly: xd, fs1, rm
1818
encoding:

spec/std/isa/inst/D/fcvt.lu.d.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description:
1111
- id: inst-fcvt.lu.d-behaviour
1212
normative: false
1313
text: |
14-
`FCVT.LU.D` converts a double-precision floating-point number in floating-point register _fs1_
15-
to an unsigned 64-bit integer, in integer register _xd_.
14+
The `fcvt.lu.d` instruction converts a double-precision floating-point number in floating-point register `fs1`
15+
to an unsigned 64-bit integer, in integer register `xd`.
1616
definedBy: D
1717
assembly: xd, fs1, rm
1818
encoding:

0 commit comments

Comments
 (0)