len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-10-28 00:06:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

Update result section in README under CBMC folder. (#1196)

Browse source 
* Update result section in README under CBMC folder

* Code review suggestions

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>

* Update proofs result path

---------

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
Co-authored-by: Gaurav Aggarwal <aggarg@amazon.com>
Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
This commit is contained in:
ActoryOu 2024-03-22 10:43:47 +08:00 • committed by GitHub
parent 7de1b5098d
commit c5c41ef3af
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
FreeRTOS/Test/CBMC/README.md
View file

@ -72,11 +72,19 @@ Each of the leaf directories under `proofs` is a proof of the memory
safety of a single entry point in FreeRTOS. The scripts that you ran in the safety of a single entry point in FreeRTOS. The scripts that you ran in the
previous step will have left a Makefile in each of those directories. To previous step will have left a Makefile in each of those directories. To
run a proof, change into the directory for that proof and run `make`. run a proof, change into the directory for that proof and run `make`.
The proofs may take some time to run; they eventually write their output to The proofs may take some time to run.
`cbmc.txt`, which should have the text `VERIFICATION SUCCESSFUL` at the end.
The make command will also generate a report in html and json format which makes ### Proof results
understanding the failures easier.
The `make` command above generates a report in HTML and JSON format. Taking
[TaskCreate](./proofs/Task/TaskCreate) as an example:
* HTML report is generated at `./proofs/Task/TaskCreate/html/html`.
* JSON report is generated at `./proofs/Task/TaskCreate/html/json`.
You can open `./proofs/Task/TaskCreate/html/html/index.html` in any browser to view
the HTML report. You should see `None` under the `Errors` section in case of a
successful run.
### Proof directory structure ### Proof directory structure