annotate runtime/tools/ccfilter_README.txt @ 14707:5cb5b079ad90

Added tag v8.1.0365 for changeset 2c0f454fcdc94c0e633f1f509e9e266e30e04581
author Christian Brabandt <cb@256bit.org>
date Mon, 10 Sep 2018 22:15:05 +0200
parents e751b5c9dff3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13857
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
1 READ THIS FIRST
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
2 ===============
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
3
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
4 ccfilter is a C program to filter the output of a few compilers to a common
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
5 QuickFix format. It is provided with Vim to make quickfix useful for more
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
6 compilers.
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
7
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
8 ccfilter WILL FAIL with long lines (more than 2047 bytes).
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
9
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 4437
diff changeset
10
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 COMPILING AND INSTALLING:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 =========================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 To compile ccfilter, you can just do a plain:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 cc ccfilter.c -o ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 Though, it may be wise to have your default compiler defined,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 so you would normally compile it with one of the following:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 cc -D_GCC ccfilter.c -o ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 cc -D_AIX ccfilter.c -o ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 cc -D_ATT ccfilter.c -o ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 cc -D_IRIX ccfilter.c -o ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 cc -D_SOLARIS ccfilter.c -o ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 cc -D_HPUX ccfilter.c -o ccfilter
4437
eb6ab7e78925 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
24 You can then copy ccfilter to its target destination (i.e: /usr/local/bin).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 The man page ccfilter.1 has to be copied to somewhere in your MANPATH,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 under a man1 directory (i.e: /usr/local/man/man1).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 SUPPORTED COMPILERS/PORTING NOTES:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 ==================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 The supported formats for the different compilers are described below:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 In this section, meta-names are used as place-holders in the line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 formats: <FILE> <ROW> <COL> <SEVERITY> <REASON> <>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 The <> denotes ignored text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 Line formats are delimited by the ^ (caret) symbol.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 0) Special case: "gmake directory change" lines:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 Lines with a format like:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 ^gmake[<NUM>]: Entering directory `<DIR>'^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 are used to follow the directory changes during the make process,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 providing in the <FILE> part, a relative (if possible) directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 path to the erroneous file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 1) GCC:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 Recognized lines are of the format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 - ^In file included from <FILE>:<ROW>:^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 Line following this one is used as <REASON>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 <SEVERITY> is always 'e' (error)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 <COL> is always '0'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 - ^<FILE>:<ROW>:<REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 <SEVERITY> is always 'e' (error)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 <COL> is always '0'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 2) AIX:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 Recognized lines are of the format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 - ^"<FILE>", line <ROW>.<COL>: <> (<SEVERITY>) <REASON>",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 3) HPUX:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 Recognized lines are of the format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 - ^cc: "<FILE>", line <ROW>: <SEVERITY>: <REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 <COL> is always '0'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 4) SOLARIS:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 Recognized lines are of the format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 - ^"<FILE>", line <ROW>: warning: <REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 This assumes <SEVERITY> is "W"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 <COL> is always '0'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 - ^"<FILE>", line <ROW>: <REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 This assumes <SEVERITY> is "E"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 <COL> is always '0'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 5) ATT / NCR:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 Recognized lines are of the format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 - ^<SEVERITY> "<FILE>",L<ROW>/C<COL><>:<REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 - ^<SEVERITY> "<FILE>",L<ROW>/C<COL>:<REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 Following lines beginning with a pipe (|) are continuation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 lines, and are therefore appended to the <REASON>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 - ^<SEVERITY> "<FILE>",L<ROW>:<REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 <COL> is '0'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 Following lines beginning with a pipe (|) are continuation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 lines, and are therefore appended to the <REASON>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 6) SGI-IRIX:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 Recognized lines are of the format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 - ^cfe: <SEVERITY>: <FILE>: <ROW>: <REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 ^cfe: <SEVERITY>: <FILE>, line <ROW>: <REASON>^
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 Following lines beginning with a dash (-) are "column-bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 that end with a caret in the column of the error. These lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 are analyzed to generate the <COL>.