Skip to content

Update goto-checker documentation #4348

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 8, 2019
Merged

Update goto-checker documentation #4348

merged 1 commit into from
Mar 8, 2019

Conversation

peterschrammel
Copy link
Member

Adds single-path symex checker and fault localization.

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

tautschnig
tautschnig approved these changes Mar 7, 2019
View reviewed changes
src/goto-checker/README.md Outdated
found then a trace can be retrieved from the incremental goto checker.
* \ref fault_localization_providert: If a violated property has been
found then a likely fault location can be determined.
* \ref witness_providert: A correctness witness can be output (for violated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of these \ref appear to resolve according to CI.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also: "correctness witness" and "violated property" don't go together.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same trap again: there must be a space to separate the colon from the ref.

src/goto-checker/README.md Outdated
@@ -68,16 +73,36 @@ There are the following variants of goto verifiers at the moment:
verification algorithm has terminated.
The reporting uses 'goals' rather than 'property' terminology. I.e.
a failing property means 'success' and a passing property 'failed'.
* \ref stop_on_fail_verifier_with_fault_localizationt : Same as
\ref stop_on_fail_verifiert, but also finds an reports
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/an/and/

src/goto-checker/README.md Outdated
the most likely fault location. Requires an incremental goto checker
that provides fault localization.
* \ref all_properties_verifier_with_fault_localizationt : Same as
\ref all_properties_verifier_with_trace_storaget, but also finds an reports
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/an/and/

@peterschrammel
Update goto-checker documentation
b901d2a 
Adds single-path symex checker and fault localization.
allredj
allredj reviewed Mar 8, 2019
View reviewed changes
Copy link
Contributor

@allredj allredj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️
This PR failed Diffblue compatibility checks (cbmc commit: b901d2a).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/103662997
Status will be re-evaluated on next push.
Common spurious failures:

  • the cbmc commit has disappeared in the mean time (e.g. in a force-push)

  • the author is not in the list of contributors (e.g. first-time contributors).

  • the compatibility was already broken by an earlier merge.

@peterschrammel peterschrammel merged commit 9468913 into diffblue:develop Mar 8, 2019
@peterschrammel peterschrammel deleted the goto-checker-docs branch March 8, 2019 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@allredj allredj allredj left review comments

@tautschnig tautschnig tautschnig approved these changes

@chrisr-diffblue chrisr-diffblue Awaiting requested review from chrisr-diffblue

@kroening kroening Awaiting requested review from kroening kroening is a code owner

@smowton smowton Awaiting requested review from smowton

Assignees

@peterschrammel peterschrammel

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@peterschrammel @tautschnig @allredj