Skip to content

Commit fb32526

Browse files
committed
doc: document the JSON format used by --filter-file options
1 parent ec2e76a commit fb32526

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

doc/csdiff.h2m

+22
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
[NAME]
22
csdiff - take two lists of defects and output either added or fixed ones
33

4+
[OPTIONS]
5+
The \fB\-\-filter\-file\fR option takes a list of JSON files in the following
6+
format. Missing replace entry is equal to replace : "".
7+
8+
.RS 4
9+
.nf
10+
{
11+
"msg-filter" : [
12+
{
13+
"checker" : "DIVINE|SYMBIOTIC",
14+
"regexp" : "memory"
15+
},
16+
{
17+
"checker" : "COMPILER_WARNING",
18+
"regexp" : "called on unallocated object",
19+
"replace" : "called correctly, no UB here"
20+
}
21+
]
22+
}
23+
.fi
24+
.RE
25+
426
[EXIT STATUS]
527
csdiff exits with status 0 if arguments are valid and input files are parsed
628
successfully. It does not matter whether any defects were matched or not.

doc/csgrep.h2m

+22
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
[NAME]
22
csgrep - filter the list of defects by the specified regex-based predicates
33

4+
[OPTIONS]
5+
The \fB\-\-filter\-file\fR option takes a list of JSON files in the following
6+
format. Missing replace entry is equal to replace : "".
7+
8+
.RS 4
9+
.nf
10+
{
11+
"msg-filter" : [
12+
{
13+
"checker" : "DIVINE|SYMBIOTIC",
14+
"regexp" : "memory"
15+
},
16+
{
17+
"checker" : "COMPILER_WARNING",
18+
"regexp" : "called on unallocated object",
19+
"replace" : "called correctly, no UB here"
20+
}
21+
]
22+
}
23+
.fi
24+
.RE
25+
426
[EXIT STATUS]
527
csgrep exits with status 0 if arguments are valid and input files are parsed
628
successfully. It does not matter whether any defects were matched or not.

0 commit comments

Comments
 (0)