ppcInstructionMatcher: Reference PPCSyscall Haddocks

GaloisInc · Jul 22, 2024 · ad31314 · ad31314
1 parent 70a92e0
commit ad31314
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/macaw-ppc/src/Data/Macaw/PPC/Arch.hs b/macaw-ppc/src/Data/Macaw/PPC/Arch.hs
@@ -842,6 +842,8 @@ ppcInstructionMatcher (D.Instruction opc operands) =
       resVal       <- G.addExpr (G.AppExpr (MC.TupleField knownRepr res PL.index0))
       errorCondVal <- G.addExpr (G.AppExpr (MC.TupleField knownRepr res PL.index1))
 
+      -- See the documentation on 'PPCSyscall' for a description of the
+      -- registers used to return values from syscalls.
       G.setRegVal (PPC_GP (D.GPR 3)) resVal
       -- We need to use an explicit type signature here to prevent GHC's type
       -- inference from becoming confused by the GADT pattern match on