1KRAZYRC(1)              User   Contributed   Perl   Documentation
2KRAZYRC(1)
3
4
5
6[1mkrazyrc[0m
7       .krazy ‐ krazy control directives
8
9[1mDESCRIPTION[0m
10       .krazy files provide directives that control how the Krazy
11Code
12       Checking tools perform within a KDE source directory.
13
14       Each  line in the file can be a control directive, a blank
15line, or a
16       comment. Comment lines start with the # character.
17
18       If multiple instances of a directive  are  specified  they
19will be merged
20       together in a logical way.
21
22[1mDIRECTIVES[0m
23       The  following directives are understood by the Krazy Code
24Checking
25       tools:
26
27       EXCLUDE plugin1[,plugin2,...]
28        Remove the specified plugins  from  the  default  set  of
29checkers.
30
31       CHECK plugin1[,plugin2,...]
32        Run  only  the specified list of plugins from the default
33set of
34        checkers.  You may not combine this with the CHECKSET di‐
35rective nor
36        with the [1m‐‐check‐sets [22mcommand line option.
37
38        [4mNote[24m:  the  CHECK  directive takes precedence over
39the EXCLUDE directive;
40        i.e, plugins specified by the CHECK directive are  always
41run, even if
42        they are also specified in an EXCLUDE directive.
43
44       CHECKSETS set1[,set2,...]
45        Run  the  checker  programs  belonging  to  the specified
46set(s) only.  You
47        may not combine this with the CHECK  directive  nor  with
48the [1m‐‐check[0m
49        command line option.
50
51       EXTRA plugin1[,plugin2,...]
52        Add  the specified list of "extra" plugins to the default
53set of
54        checkers.
55
56       TYPES type1[,type2,...]
57        Check the specifed file type(s) only.
58
59       EXCLUDETYPES type1[,type2,...]
60        Do NOT check the specified file type(s).
61
62       SKIP regexp
63        Do not process any file that maches  the  specified  perl
64regular
65        expression.   See the [4mperlreftut[24m(1) man page for a
66description of how
67        to write a perl regular expression.
68
69       PRIORITY priority
70        Set the priority value. Must be one of  "low",  "normal",
71"high",
72        "important", "all".
73
74       STRICT strict
75        Set  the  strict value. Must be one of "normal", "super",
76"all".
77
78       OUTPUT output
79        Set the output level. Must be one  of  "quiet",  "brief",
80"all".
81
82          "quiet"  means  no output is printed, even if ‐‐verbose
83is passed on
84          the command line.
85
86          "brief" will only print checker summaries if the  check
87has at least
88          1 issue.
89
90          "all"  is  the  normal mode and prints all checker sum‐
91maries
92
93       EXPORT export‐type
94        Set the default export‐type value. Must  be  one  of  the
95following:
96
97          "text" (default)
98
99          "textlist" prints 1 offending file‐per‐line
100
101          "textedit" prints text formatted for IDEs, 1 issue‐per‐
102line
103
104          "xml" prints XML formatted intended for follow‐on  pro‐
105cessing
106
107       STYLE_CPPSTYLE C++‐style
108        Tell  the "style" checker to follow the guidelines of the
109specified
110        C++‐style.
111
112        C++‐style must be one of the following:
113
114          "kde" (default), see
115          http://techbase.kde.org/Policies/Kdelibs_Coding_Style
116
117          "pim" kdepim style, see
118          http://pim.kde.org/development/coding‐korganizer.php
119
120        Note: Krazy uses a  heuristic  to  decide  what  type  of
121C++‐style to check
122        against.   That  heuristic  isn’t very smart; so use this
123setting to
124        enforce the C++‐style.
125
126        Overrides the KRAZY_STYLE_CPPSTYLE environment  variable,
127see
128        [4mkrazy2[24m(1).
129
130       STYLE_OFFSET indent
131        Tell the "style" checker to check for a basic indentation
132level,
133        usually a small integer like 2 or 4.   This  value  over‐
134rides the offset
135        provided as part of the C++‐style (see STYLE_CPPSTYLE).
136
137        Overrides  the  KRAZY_STYLE_OFFSET  environment variable,
138see [4mkrazy2[24m(1).
139
140       STYLE_LINEMAX length
141        Tell the "style" checker to check for lines  longer  than
142this number of
143        characters.  The default is 100 characters.
144
145        Overrides  the  KRAZY_STYLE_LINEMAX environment variable,
146see [4mkrazy2[24m(1).
147
148[1mADMIN DIRECTIVES[0m
149       This is a list of administrator directives  used  only  by
150the
151       [4mkrazy2xml[24m(1)  program and typically not interesting
152to the average user.
153
154       IGNORESUBS subdir1[,subdir2,...]
155        Do not run Krazy on the specified list of subdirectories.
156These must
157        be  KDE  "project"  subdirectories that reside at the top
158level of a KDE
159        module.
160
161       EXTRASUBS subdir1[,subdir2,...]
162        Run Krazy on the specified list of subdirectories.  These
163must be KDE
164        "project"  subdirectories that reside at the top level of
165a KDE module.
166
167       IGNOREMODS module1[,module2,...]
168        Do not run Krazy on the specified list  of  KDE  modules.
169These must be
170        KDE  "module" subdirectories that reside at the top level
171of a KDE
172        component.
173
174[1mCOPYRIGHT[0m
175       Copyright 2005‐2010 by Allen Winter <winter@kde.org>
176
177[1mSEE ALSO[0m
178       [4mkrazy2[24m(1),                     [4mkrazy2all[24m(1),
179[4mkrazy2xml[24m(1), [4mperlreftut[24m(1)
180
181[1mAUTHORS[0m
182       Allen Winter, <winter@kde.org>
183
184
185
186perl            v5.12.2                                2010‐08‐07
187KRAZYRC(1)
188
189
190
191
192
193
194
195
196
197
198