Skip to content

Help output: document that stop-on-fail implies trace #5662

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

Merged
merged 1 commit into from
Dec 14, 2020

Conversation

tautschnig
Copy link
Collaborator

Running CBMC or JBMC with --stop-on-fail will print a counter-example
trace. Previously, the help output suggested that --trace was required
to accomplish this. Clarify in the help output that --trace is implied
by --stop-on-fail.

Fixes: #5654

  • Each commit message has a non-empty body, explaining why the change was made.
  • n/a 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).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

@codecov
Copy link

codecov bot commented Dec 14, 2020

Codecov Report

Merging #5662 (b8287fe) into develop (f85b11d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #5662   +/-   ##
========================================
  Coverage    69.41%   69.41%           
========================================
  Files         1243     1243           
  Lines       100621   100621           
========================================
  Hits         69850    69850           
  Misses       30771    30771           
Flag Coverage Δ
cproversmt2 43.14% <ø> (ø)
regression 66.31% <ø> (ø)
unit 32.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
jbmc/src/jbmc/jbmc_parse_options.cpp 73.73% <ø> (ø)
src/cbmc/cbmc_parse_options.cpp 77.62% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f85b11d...b8287fe. Read the comment docs.

Copy link
Collaborator

@martin-cs martin-cs left a comment

Choose a reason for hiding this comment

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

If we are keeping this behaviour then, yes, it should be documented.

Running CBMC or JBMC with --stop-on-fail will print a counter-example
trace. Previously, the help output suggested that --trace was required
to accomplish this. Clarify in the help output that --trace is implied
by --stop-on-fail.

Fixes: diffblue#5654
@tautschnig tautschnig force-pushed the stop-on-fail-help-msg branch from 9ecaaf7 to b8287fe Compare December 14, 2020 14:24
@tautschnig tautschnig merged commit 48f7139 into diffblue:develop Dec 14, 2020
@tautschnig tautschnig deleted the stop-on-fail-help-msg branch December 14, 2020 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

--stop-on-fail generates a trace even though --trace is omitted
4 participants