Skip to content

Commit

Permalink
Deprecate --visualize in favor of concrete playback (#3281)
Browse files Browse the repository at this point in the history
We believe the `--visualize` is much harder to use than concrete
playback. In the rare cases where a trace might be relevant, users can
still use CBMC trace.

For most users, this will simplify installation since Kani will no
longer depend on Python3.

Note: As opposed to `--function` which was purely an internal feature, I
believe we have mentioned `--visualize` to users before, so I think it's
important to have a deprecation period.

Related #2832
  • Loading branch information
celinval committed Jun 21, 2024
1 parent 0d8675d commit 73843ec
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
14 changes: 9 additions & 5 deletions kani-driver/src/args/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -532,12 +532,16 @@ impl ValidateArgs for VerificationArgs {
);
}

if self.visualize && !self.common_args.enable_unstable {
return Err(Error::raw(
ErrorKind::MissingRequiredArgument,
"Missing argument: --visualize now requires --enable-unstable
if self.visualize {
if !self.common_args.enable_unstable {
return Err(Error::raw(
ErrorKind::MissingRequiredArgument,
"Missing argument: --visualize now requires --enable-unstable
due to open issues involving incorrect results.",
));
));
} else {
print_deprecated(&self.common_args, "--visualize", "--concrete-playback");
}
}

if self.mir_linker {
Expand Down
1 change: 1 addition & 0 deletions tests/cargo-kani/simple-visualize/main.expected
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
warning: The `--visualize` option is deprecated. This option will be removed soon. Consider using `--concrete-playback` instead
report-main/html/index.html

0 comments on commit 73843ec

Please sign in to comment.