-
Notifications
You must be signed in to change notification settings - Fork 17
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
CERT-8156: split_rules documentation #345
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved.
docs/prover/cli/options.md
Outdated
**What does it do?** | ||
Typically, all rules (after being filtered by `--rule` and `--exclude_rule`) are evaluated in a single activation of | ||
the prover. With `--split_rules` the user can run specific rules each on a dedicated instance of the prover. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add an explanation about the return/console?
(the user will see multiple links to reports, and the final link will be to the dashboard)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for writing it, there is a missing part in the documentation
the prover. With `--split_rules` the user can run specific rules each on a dedicated instance of the prover. | ||
|
||
Note that you can specify this flag multiple times to denote several rules or rule patterns. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add:
**When to use it?**
This option is useful when some rule take a much longer time than the rest. Split the difficult rules to their own dedicated Prover jobs will give them more resources that will potentially reduce their chance to time out and will decrease the time to get the final job result for the less computationally intensive rules.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good imo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A small comment, otherwise great
Note that you can specify this flag multiple times to denote several rules or rule patterns. | ||
|
||
**When to use it?** | ||
This option is useful when some rules take a much longer time than the rest. Split the difficult rules to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This option is useful when some rules take a much longer time than the rest. Split the difficult rules to | |
This option is useful when some rules take a much longer time than the rest. Splitting the difficult rules to |
Naming convention:
Before requesting review:
spelling_wordlist.txt
README.md
for information about style and markdown syntaxJira ticket: TODO
Link to generated documentation: TODO