summaryrefslogtreecommitdiff
path: root/FreeRTOS/Test/CBMC/proofs/Task/TaskGetCurrentTaskHandle/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'FreeRTOS/Test/CBMC/proofs/Task/TaskGetCurrentTaskHandle/README.md')
-rw-r--r--FreeRTOS/Test/CBMC/proofs/Task/TaskGetCurrentTaskHandle/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/FreeRTOS/Test/CBMC/proofs/Task/TaskGetCurrentTaskHandle/README.md b/FreeRTOS/Test/CBMC/proofs/Task/TaskGetCurrentTaskHandle/README.md
new file mode 100644
index 000000000..af9280495
--- /dev/null
+++ b/FreeRTOS/Test/CBMC/proofs/Task/TaskGetCurrentTaskHandle/README.md
@@ -0,0 +1,6 @@
+This proof demonstrates the memory safety of the TaskGetCurrentTaskHandle
+function. We assume that `pxCurrentTCB` is not NULL and we check that the
+return value is not NULL.
+
+This proof is a work-in-progress. Proof assumptions are described in
+the harness.