Manual: Document pitfalls of specifying code with bools #1899
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bboston7
approved these changes
Aug 4, 2023
While the C `bool` type usually corresponds to `llvm_int 1`, there are some corner cases where it instead corresponds to `llvm_int 8`, which can cause your specifications to fail if you are not careful. This has tripped up multiple people in the past, and while it is difficult to catch this sort of mistake in general, we can at least warn about it in the SAW manual, which this patch accomplishes.
RyanGlScott
force-pushed
the
document-bool-pitfalls
branch
from
a9296ca to
f838f08
Compare
|
TIL that there is a PDF version of the SAW manual. (I wonder what it's used for.) I've regenerated it. |
RyanGlScott
added
the
PR: ready to merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While the C
booltype usually corresponds tollvm_int 1, there are some corner cases where it instead corresponds tollvm_int 8, which can cause your specifications to fail if you are not careful. This has tripped up multiple people in the past, and while it is difficult to catch this sort of mistake in general, we can at least warn about it in the SAW manual, which this patch accomplishes.