Generate benchcomp.yaml documentation from schema
#2593
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Here is how it looks, the text is slightly out of date (I've since made the example shorter)
|
To make filenames in a future commit less ambiguous.
This commit switches the data validation package from `cerberus` to `schema`. This is because schema is able to emit the schema in a standardized format that can later be rendered into HTML. This will be implemented in a future commit.
This commit adds the schema of benchcomp.yaml to the Kani book to document how benchcomp configuration files are written. The code will be used in future commits for documenting the parser and visualizer formats.
qinheping
approved these changes
Jul 23, 2023
There was a problem hiding this comment.
Looks great!
A typo in https://github.com/model-checking/kani/blob/main/tools/benchcomp/benchcomp/visualizers/__init__.py#L134. extra_colums -> extra_columns
|
|
||
| {{#include ../gen_src/BenchcompYaml.md}} | ||
|
|
||
| A minimal example of such a file is: |
There was a problem hiding this comment.
It would be great to have a paragraph to explain the workflow of a variant in this configuration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
This PR adds a validation schema for the benchcomp configuration file format, as well as code to emit that schema into the Kani book. This is in preparation for further PRs that will add similar schemas for the format that a benchcomp parser should emit, and the format that benchcomp visualizers should expect, both of which will also be rendered in the book.
Here is a rendered version.
Resolved issues:
Resolves #2592
Related RFC:
None
Call-outs:
N/A
Testing:
Rendered version](https://karkhaz.github.io/kani/benchcomp-conf.html) on my fork
No
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.