Added more documentation to checks #26
Merged
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
tbarabosch
suggested changes
Jul 18, 2019
| @@ -28,5 +28,9 @@ uninstall: | |||
| cd plugins/cwe_checker_type_inference; make uninstall; cd ../.. | |||
| cd plugins/cwe_checker_type_inference_print; make uninstall; cd ../.. | |||
|
|
|||
| documentation: | |||
There was a problem hiding this comment.
make doc doesn't work. Or at least I haven't found a way to escape the @doc in the build command in a way such that it doesn't collide with make doc.
There was a problem hiding this comment.
ok, then leave it as it is
|
|
||
| Just run `make all` to compile and register the plugin with BAP. You can run the test suite via `make test`. | ||
| Just run `make all` to compile and register the plugin with BAP. You can run the test suite via `make test`. Documentation can be built via `make documentation`. |
|
Looks fine, merging 👍 |
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.
I haven't figured out how to escape the
@character indune build @docfor inclusion into to the makefile. I also need to figure out how to change the build directory for the documentation without causing dune to segfault. But the generated documentation already looks quite nice!