Skip to content

Commit

Permalink
Document that XGhostState is only defined for LLVM at the moment
Browse files Browse the repository at this point in the history
I've included a pointer to #1929 as well to indicate our intention to support
ghost state on other language backends.
  • Loading branch information
RyanGlScott committed Sep 1, 2023
1 parent d623a68 commit 5a47ded
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions src/SAWScript/Crucible/Common/Setup/Value.hs
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,10 @@ deriving instance (SetupValueHas Show ext) => Show (SetupValue ext)
--------------------------------------------------------------------------------
-- ** Ghost state

-- TODO: This is language-independent, it should be always-true rather than a
-- toggle.

-- TODO: documentation

-- | This extension field controls whether ghost state is enabled for a
-- particular language backend. At the moment, ghost state is only enabled for
-- the LLVM backend, but we want to expand this to cover other language backends
-- in the future. See <https://github.com/GaloisInc/saw-script/issues/1929>.
type family XGhostState ext

--------------------------------------------------------------------------------
Expand Down

0 comments on commit 5a47ded

Please sign in to comment.