1CSCLNG(1)                                                            CSCLNG(1)
2
3
4

NAME

6       csclng - a compiler wrapper that runs the Clang analyzer in background
7

SYNOPSIS

9       csclng [--help | --print-path-to-wrap]
10

DESCRIPTION

12       csclng is a compiler wrapper that runs clang in background. Create a
13       symbolic link to csclng named as your compiler (gcc, g++, ...) and put
14       it to your $PATH.
15
16       The following parameters are given to clang by default:
17
18       •   --analyze
19
20       •   -Xanalyzer -analyzer-output=text
21
22       The following parameters are passed to clang from compiler’s command
23       line:
24
25       •   -D...
26
27       •   -I...
28
29       •   -include ...
30
31       •   -iquote ...
32
33       •   -isystem ...
34
35       •   -m16
36
37       •   -m32
38
39       •   -m64
40
41       •   -fno-exceptions
42
43       •   -O...
44
45       •   -std...
46
47       The following file extensions are recognized as C/C++ source files:
48
49       •   c
50
51       •   C
52
53       •   cc
54
55       •   cpp
56
57       •   cxx
58
59       The following path substrings are black-listed from being scanned by
60       clang:
61
62       •   conftest.c
63
64       •   _configtest.c
65
66       •   /CMakeTmp/
67
68       •   ../test.c
69
70       •   ../../test.c
71
72       •   config-temp/qemu-conf.c
73
74       •   scripts/kconfig/conf.c
75
76       •   scripts/kconfig/zconf.tab.c
77
78       •   /tmp/cov-mockbuild/
79
80       If csclng is installed on system, the following command activates the
81       wrapper:
82
83           export PATH="`csclng --print-path-to-wrap`:$PATH"
84

OPTIONS

86       --help
87           Prints basic usage information.
88
89       --print-path-to-wrap
90           Prints path to the directory with symlinks to the csclng
91           executable.
92

EXIT STATUS

94       csclng propagates the exit status returned by the compiler (in case
95       csclng succeeds to run the compiler). The exit status returned by clang
96       does not affect the resulting exit status.
97

ENVIRONMENT VARIABLES

99       DEBUG_CSCLNG
100           If set to a non-empty string, csclng outputs the list of parameters
101           given to clang to the standard output.
102
103       CSCLNG_ADD_OPTS
104           csclng expects a colon-separated list of Clang options that should
105           be appended to command line prior to invoking Clang. The options
106           are appended even if they already appear in the command line and
107           they are always appended at the end of the command line.
108

BUGS

110       Please report bugs and feature requests at
111       https://github.com/kdudka/cscppc .
112

AUTHOR

114       Written by Kamil Dudka.
115

COPYING

117       Copyright (C) 2013-2014 Red Hat, Inc. Free use of this software is
118       granted under the terms of the GNU General Public License (GPL). See
119       the COPYING file for details.
120
121
122
123                                  05/21/2021                         CSCLNG(1)
Impressum