capstone icon indicating copy to clipboard operation
capstone copied to clipboard

Add documentation about LLVM imported `FEATURE` groups.

Open Rot127 opened this issue 1 year ago • 0 comments

Feature

  • [ ] New architecture module
  • [ ] Support for processor extension
  • [ ] Add more instruction details (elaborated below)
  • [ ] Binding support for: language
  • [x] Other (elaborated below)

Describe the feature you'd like

We should document somehow the feature groups which are copied from LLVM. This is important because the naming can lead to confusion as in https://github.com/capstone-engine/capstone/issues/2343.

LLVM uses the feature flags to decide if it can assemble a certain instruction or not. Flags like HasSMEorSME means "if either of the features is enabled, use the instruction". While in the Capstone disassembly context, it might get casually interpreted as "is defined in both extensions", which doesn't need to be the case.

Also it is useful in general.

Additional context none

Rot127 avatar May 16 '24 09:05 Rot127