llvm.org GIT mirror llvm / 9d3787b
add a simple FileCheck man page. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79105 91177308-0d34-0410-b5e6-96231b3b80d8 Chris Lattner 10 years ago
2 changed file(s) with 67 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0
1 =pod
2
3 =head1 NAME
4
5 FileCheck - Flexible pattern matching file verifier
6
7 =head1 SYNOPSIS
8
9 B I [I<--check-prefix=XXX>] [I<--strict-whitespace>]
10
11 =head1 DESCRIPTION
12
13 B reads two files (one from standard input, and one specified on the
14 command line) and uses one to verify the other. This behavior is particularly
15 useful for the testsuite, which wants to verify that the output of some tool
16 (e.g. llc) contains the expected information (for example, a movsd from esp or
17 whatever is interesting). This is similar to using grep, but it is optimized
18 for matching multiple different inputs in one file in a specific order.
19
20 The I file specifies the file that contains the patterns to
21 match. The file to verify is always read from standard input.
22
23 The input and output of B is beyond the scope of this short
24 introduction. Please see the I page in the LLVM documentation.
25
26 =head1 OPTIONS
27
28 =over
29
30 =item B<--help>
31
32 Print a summary of command line options.
33
34 =item B<--check-prefix> I
35
36 FileCheck searches the contents of I for patterns to match. By
37 default, these patterns are prefixed with "CHECK:". If you'd like to use a
38 different prefix (e.g. because the same input file is checking multiple
39 different tool or options), the B<--check-prefix> argument allows you to specify
40 a specific prefix to match.
41
42 =item B<--strict-whitespace>
43
44 By default, FileCheck canonicalizes input horizontal whitespace (spaces and
45 tabs) which causes it to ignore these differences (a space will match a tab).
46 The --strict-whitespace argument disables this behavior.
47
48 =item B<-version>
49
50 Show the version number of this program.
51
52 =back
53
54 =head1 EXIT STATUS
55
56 If B verifies that the file matches the expected contents, it exits
57 with 0. Otherwise, if not, or if an error occurs, it will exit with a non-zero
58 value.
59
60 =head1 AUTHORS
61
62 Maintained by The LLVM Team (L).
63
64 =cut
127127
128128
129129
130
  • FileCheck -
  • 131 Flexible file verifier used extensively by the testing harness
    130132
  • tblgen -
  • 131133 target description reader and generator
    132134