Document operand modifier

riscv-non-isa / riscv-c-api-doc

Documentation of the RISC-V C API

https://jira.riscv.org/browse/RVG-4

Creative Commons Attribution 4.0 International

68 stars 38 forks source link

Document operand modifier #45

Closed kito-cheng closed 10 months ago

kito-cheng commented 1 year ago

Document z and i, which has implemented on both LLVM and GCC.

@topperc fixed a GCC compatible issue on r constraint with 0 immediate[1], and I found we didn't well document those operand modifier any where including GCC document...so I think it would be great to start document this some where, and here should be a good starter.

[1] https://reviews.llvm.org/D154744

cc @asb

asb commented 1 year ago

I think it might be nice to give an example of what the use of an operand modifier looks like (I can see the argument for keeping the doc minimal, but we do already have quite a lot of related explanatory material here). But LGTM.

kito-cheng commented 10 months ago

I guess I was plan to add some example, but seems not found a good timing to do that, and I realized we may just moving forward and then improve this later instead of holding this here, anyway, will keep improving this doc when I found time, so let me merge this first