#6988·ghidra

Looks like search-and-replace mistake making a paragraph of the Sleigh documentation difficult to understand

Author: hippietrailCreated Oct 1, 2024Updated Sep 14, 2026
LabelsFeature: DocumentationFeature: SleighStatus: Internal

Describe the bug

In the file docs/languages/html/sleigh_constructors.html towards the end of the 7.7.2.5. "Branching Statements" section is this paragraph:

As in the above example, the CBRANCH operation takes two inputs, a boolean value indicating % whether or operation % is invoked with the if goto operation takes two inputs, a boolean value % indicating whether or syntax %. The condition of the if operation takes two inputs, % a boolean value indicating whether or can be any semantic expression % that results in a boolean value. The destination must be an annotation varnode.

I've surrounded the problem wordings that I can't make sense of with percent signs % like this %:

  • % whether or operation % - presumably this one should be "whether the operation"
  • % indicating whether or syntax % - I have no idea what this one should be
  • % a boolean value indicating whether or can be any semantic expression % - I can't figure out what this was supposed to be either

I'm not 100% sure that it's not markup missing around words that are actually other "operations" like the if goto and if but if so I still can't guess how I should understand this.

I suggest a rewrite to clarify whether it's a search-and-replace mistake, missing markup, or just poor wording.

Source: NationalSecurityAgency/ghidra