Skip to content
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

Added documentation for REPL commands and :set-able options to reference manual #1790

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pfisher-existx
Copy link

Added documentation as requested in #612

Copy link
Contributor

@RyanGlScott RyanGlScott left a comment

Choose a reason for hiding this comment

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

Thank you for writing this up!

Comment on lines 204 to 208
**Valid values:** ``cvc4``, ``cvc5``, ``yices``, ``z3``, ``boolector``,
``mathsat``, ``abc``, ``offline``, ``any``, ``sbv-cvc4``, ``sbv-cvc5``,
``sbv-yices``, ``sbv-z3``, ``sbv-boolector``, ``sbv-mathsat``, ``sbv-abc``,
``sbv-offline``, ``sbv-any``, ``w4-cvc4``, ``w4-cvc5``, ``w4-yices``,
``w4-z3``, ``w4-boolector``, ``w4-abc``, ``w4-offline``, ``w4-any``
Copy link
Contributor

Choose a reason for hiding this comment

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

This list should also include bitwuzla, sbv-bitwuzla, and w4-bitwuzla.

no argument, check all properties.)

If the expression is successfully proven, the screen will display ``Q.E.D``.
If not, the screen will display some counterexamples that return false.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think Cryptol ever displays multiple counterexamples, does it? Perhaps change the phrasing here to "will display a counterexample that returns false".

@weaversa
Copy link
Collaborator

weaversa commented Jan 14, 2025 via email

@RyanGlScott
Copy link
Contributor

Not to my knowledge, no. The source code suggests that satNum is only used to influence the output of :sat, not :prove:

qtype <- if isSat then SatQuery <$> getUserSatNum else pure ProveQuery

(getUserSatNum is the only place that reads the contents of the satNum setting, and this is the only call site for getUserSatNum.)

Copy link
Contributor

@RyanGlScott RyanGlScott left a comment

Choose a reason for hiding this comment

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

One last request: could you mention "fixes #612" somewhere in the commit message? That way, the issue will be automatically closed when the PR lands. Thanks!

@pfisher-existx pfisher-existx force-pushed the 612-repl-commands-should-be-documented-in-one-place branch from f6fb6ab to 98d98f5 Compare January 16, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants