README: add bit on MODEL_ASSERT() macro

[model-checker.git] / README

diff --git a/README b/README
index dfcd5202fbc641455badeecd6a05c3d9456e5193..3064ce64e3c8cfe1d64c984ce480f5191b0a6e6a 100644 (file)
--- a/README
+++ b/README
@@ -90,7 +90,9 @@ Model-checker options:
                               Default: 1
 -b, --bound=MAX             Upper length bound.
                               Default: 0
--v, --verbose               Print verbose execution information.
+-v[NUM], --verbose[=NUM]    Print verbose execution information. NUM is optional:
+                              0 is quiet; 1 is noisy; 2 is noisier.
+                              Default: 0
 -u, --uninitialized=VALUE   Return VALUE any load which may read from an
                               uninitialized atomic.
                               Default: 0
@@ -99,6 +101,9 @@ Model-checker options:
                             -o help for a list of options
  --                         Program arguments follow.
 
+Analysis plugins:
+SC
+
 
 Note that we also provide a series of benchmarks (distributed separately),
 which can be placed under the benchmarks/ directory. After building CDSChecker,
@@ -129,7 +134,12 @@ We only support C11 thread syntax (thrd_t, etc. from <thread.h>).
 Test programs may also use our included happens-before race detector by
 including <librace.h> and utilizing the appropriate functions
 (store_{8,16,32,64}() and load_{8,16,32,64}()) for loading/storing data from/to
-from non-atomic shared memory.
+non-atomic shared memory.
+
+CDSChecker can also check boolean assertions in your test programs. Just
+include <model-assert.h> and use the MODEL_ASSERT() macro in your test program.
+CDSChecker will report a bug in any possible execution in which the argument to
+MODEL_ASSERT() evaluates to false (that is, 0).
 
 Test programs should be compiled against our shared library (libmodel.so) using
 the headers in the include/ directory. Then the shared library must be made