db, extra, user_data: handle: *x = 1; return x;"
[smatch.git] / cgcc.1
blob227c02ba469420b5ee6bfa1fb2c559ebf36fae5d
1 .\" cgcc manpage by Josh Triplett
2 .TH cgcc "1"
4 .SH NAME
5 cgcc \- Compiler wrapper to run Sparse after compiling
7 .SH SYNOPSIS
8 .B cgcc
9 [\fISPARSE OPTIONS\fR]... [\fICOMPILER OPTIONS\fR]... [\fIINPUT FILES\fR]...
10 .br
11 .B make CC=cgcc
13 .SH DESCRIPTION
14 \fBcgcc\fR provides a wrapper around a C compiler (\fBcc\fR by
15 default) which also invokes the Sparse static analysis tool.
17 \fBcgcc\fR accepts all Sparse command-line options, such as warning
18 options, and passes all other options through to the compiler.
20 By providing the same interface as the C compiler, \fBcgcc\fR allows
21 projects to run Sparse as part of their build without modifying their
22 build system, by using \fBcgcc\fR as the compiler.  For many projects,
23 setting \fBCC=cgcc\fR on the \fBmake\fR command-line will work.
25 .SH ENVIRONMENT
26 .TP
27 .B REAL_CC
28 If set, \fBcgcc\fR will use this as the compiler to invoke, rather
29 than the default \fBcc\fR.
31 .TP
32 .B CHECK
33 If set, \fBcgcc\fR will use this as the Sparse program to invoke,
34 rather than the default \fBsparse\fR.
36 .SH SEE ALSO
37 .BR sparse (1)