Add more documentation to odoc-generated docs. #36
Conversation
There was a problem hiding this comment.
Looks fine. Please enhace the documentation a bit. Furthermore, there are some ideas for future stories. Please evaluate these ideas and create a story for the good ones.
If you finish until this afternoon, I am going to merge it. If not, merge it yourself :)
| {2 How to use the docker image} | ||
|
|
||
| The docker image can be installed with | ||
| {[docker pull fkiecad/cwe_checker]} |
There was a problem hiding this comment.
this will pull the latest docker image BASED on the source code of HEAD!!
Note to us: we should tag images according to their versions on dockerhub, so that we can say docker pull fkiecad/cwe_checker:0.2
There was a problem hiding this comment.
Added to documentation. And story for us for stable docker images added.
|
|
||
| {1:CmdLineOptions Command line options} | ||
|
|
||
| All command line options have to be prefixed with [--cwe-checker] (so that BAP knows to forward them to the {i cwe_checker} plugin). |
There was a problem hiding this comment.
Note to us (maybe story): should we write a wrapper around bap (just a shellscript) and put it on the path. This wrapper would be called like cwe_checker --out BLA --json BINARY and it would translate it to bap BINARY --pass=cwe_checker --cwe-checker-out BLA --cwe-checker-json. This would made it more transparnet for the users!
There was a problem hiding this comment.
Yes, that would be useful, especially if combined with the docker container. I'll write a story for it.
| - [Tid_map: Bap.Std.word Bap.Std.Tid.Map.t] A map from the Tids of basic blocks to concrete addresses in the binary file | ||
| - [symbols_pairs: string list list] Symbols read from the {i config.json} file | ||
| - [parameters: string list] Parameters read from the config.json file | ||
|
|
There was a problem hiding this comment.
story: add an empty check that just outputs "Hello, World!"
There was a problem hiding this comment.
I have added an example .ml to the documentation, but I am not eager to add an actual hello-world-check to the code base. I hope the documentation is already clear enough so that users can copy-paste this example to the code base.
|
Ok, looks fine now. Travis errors, however these are networking issues and this PR should not be relevant to the testing suite anyways. Merging... |
The Readme.md file is not yet adjusted. But I would like to merge this PR first, then publish on Github Pages and then adjust the Readme.md file.