-
Notifications
You must be signed in to change notification settings - Fork 82
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentations #567
base: develop
Are you sure you want to change the base?
Conversation
@zvonimir @michael-emmi @keram88, I think our documentations are very out-of-dated. I added some points about how we should update them. Any feedback? Btw, I should add Rust stuff into them, too. |
@@ -7,7 +7,7 @@ SMACK is both a *modular software verification toolchain* and a | |||
*self-contained software verifier*. It can be used to verify the assertions | |||
in its input programs. In its default mode, assertions are verified up to a | |||
given bound on loop iterations and recursion depth; it contains experimental | |||
support for unbounded verification as well. SMACK handles complicated feature | |||
support for unbounded verification as well (REMOVE THIS). SMACK handles complicated feature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why would you want to remove this?
@@ -3,7 +3,7 @@ | |||
|
|||
SMACK software verifier is run using the `smack` tool in the bin directory. | |||
For a given input C/C++ program, the tool checks for violations of user-provided | |||
assertions. SMACK has a number of command line options that can be used | |||
assertions (MENTION GENERATED ASSERTIONS IN MEMORY SAFETY/OVERFLOW CHECKING). SMACK has a number of command line options that can be used |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, good idea.
@@ -99,6 +99,8 @@ directory. SMACK defines a number of functions (one for each basic type) | |||
for introducing nondeterministic (i.e., unconstrained) values, such as | |||
`__VERIFIER_nondet_int` used in this example. | |||
|
|||
MENTION ASSERT/ASSUME |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea.
@@ -114,5 +116,9 @@ verifier leverages to generate more informative error traces. Then, the generate | |||
file is translated into Boogie code, which is in turn passed to the chosen back-end | |||
verifier. | |||
|
|||
EXAMPLE ON MEMORY SAFETY |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea.
No description provided.