Further note: With the intention of keeping the docs consistent I added the SMT tactic flag like this:
--smt-tactic $smt_tactic
I used this to match what we have in the docs right now. The cheatsheet has the flags documented like this: --bmc-depth $n
Showing that $n is something the user will set. This is slightly different than what is in the terminal when you run kontrol prove -h there you will see --bmc-depth BMC_DEPTH (@JuanCoRo tell me if this is wrong.)
We might want to discuss which way to use. The docs should match what shows up in the terminal when you use --help
Personally the way Juan did it by adding $ makes sense to me. I immediately realized that it was something like a variable that the user would set. It also is what is used on the kup cheatsheet page. So its consistent on the docs side at the moment.
Kontrol Cheatsheet
Further note: With the intention of keeping the docs consistent I added the SMT tactic flag like this:
--smt-tactic $smt_tacticI used this to match what we have in the docs right now. The cheatsheet has the flags documented like this:
--bmc-depth $nShowing that
$nis something the user will set. This is slightly different than what is in the terminal when you runkontrol prove -hthere you will see--bmc-depth BMC_DEPTH(@JuanCoRo tell me if this is wrong.)We might want to discuss which way to use. The docs should match what shows up in the terminal when you use
--helpPersonally the way Juan did it by adding $ makes sense to me. I immediately realized that it was something like a variable that the user would set. It also is what is used on the kup cheatsheet page. So its consistent on the docs side at the moment.
Originally posted by @reekamaharaj in https://github.com/runtimeverification/gitbook-kontrol/issues/30#issuecomment-1841309038