Skip to content

Commit cc309db

Browse files
committed
Add documentation for new options in goto_check_c.h
1 parent 6921059 commit cc309db

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

src/ansi-c/goto_check_c.h

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,33 +51,47 @@ void goto_check_c(
5151
"(no-bounds-check)(no-pointer-check)(no-signed-overflow-check)" \
5252
"(no-pointer-primitive-check)(no-undefined-shift-check)(no-div-by-zero-check)"
5353

54-
#define HELP_GOTO_CHECK \
55-
" {y--bounds-check} \t enable array bounds checks\n" \
56-
" {y--pointer-check} \t enable pointer checks\n" \
54+
// clang-format off
55+
#define HELP_GOTO_CHECK \
56+
" {y--no-standard-checks} \t disable default checks (more information in manpage)" /* NOLINT(whitespace/line_length) */ \
57+
" {y--bounds-check} \t enable array bounds checks (default on)\n" \
58+
" {y--no-bounds-check} \t disable array bounds checks\n" \
59+
" {y--pointer-check} \t enable pointer checks (default on)\n" \
60+
" {y--no-pointer-check} \t disable pointer checks\n" \
5761
" {y--memory-leak-check} \t enable memory leak checks\n" \
5862
" {y--memory-cleanup-check} \t enable memory cleanup checks\n" \
59-
" {y--div-by-zero-check} \t enable division by zero checks\n" \
63+
" {y--div-by-zero-check} \t enable division by zero checks (default on)\n" \
64+
" {y--no-div-by-zero-check} \t disable division by zero checks\n" \
6065
" {y--signed-overflow-check} \t " \
61-
"enable signed arithmetic over- and underflow checks\n" \
66+
"enable signed arithmetic over- and underflow checks (default on)\n" \
67+
" {y--no-signed-overflow-check} \t " \
68+
"disable signed arithmetic over- and underflow checks\n" \
6269
" {y--unsigned-overflow-check} \t " \
6370
"enable arithmetic over- and underflow checks\n" \
6471
" {y--pointer-overflow-check} \t " \
6572
"enable pointer arithmetic over- and underflow checks\n" \
6673
" {y--conversion-check} \t " \
6774
"check whether values can be represented after type cast\n" \
68-
" {y--undefined-shift-check} \t check shift greater than bit-width\n" \
75+
" {y--undefined-shift-check} \t check shift greater than bit-width " \
76+
"(default on)\n" \
77+
" {y--no-undefined-shift-check} \t disable check for shift greater than " \
78+
"bit-width\n" \
6979
" {y--float-overflow-check} \t check floating-point for +/-Inf\n" \
7080
" {y--nan-check} \t check floating-point for NaN\n" \
7181
" {y--enum-range-check} \t " \
7282
"checks that all enum type expressions have values in the enum range\n" \
7383
" {y--pointer-primitive-check} \t " \
74-
"checks that all pointers in pointer primitives are valid or null\n" \
84+
"checks that all pointers in pointer primitives are valid or null (default " \
85+
"on)\n" \
86+
" {y--no-pointer-primitive-check} \t " \
87+
"disable checks that all pointers in pointer primitives are valid or null\n" \
7588
" {y--retain-trivial-checks} \t include checks that are trivially true\n" \
7689
" {y--error-label} {ulabel} \t check that label {ulabel} is unreachable\n" \
7790
" {y--no-built-in-assertions} \t ignore assertions in built-in library\n" \
7891
" {y--no-assertions} \t ignore user assertions\n" \
7992
" {y--no-assumptions} \t ignore user assumptions\n" \
8093
" {y--assert-to-assume} \t convert user assertions to assumptions\n"
94+
// clang-format on
8195

8296
// clang-format off
8397
#define PARSE_OPTIONS_GOTO_CHECK_NEGATIVE_DEFAULT_CHECKS(cmdline, options) \

0 commit comments

Comments
 (0)