1KRAZY2ALL(1) User Contributed Perl Documentation KRAZY2ALL(1)
2
6 krazy2all - Sanity checks KDE source code.
7
9 krazy2all [options]
10
12 krazy2all finds all supported files within the current directory tree
13 and runs the krazy2 checker on all of them, producing 1 concise report
14 in the specified export format.
15
17 --help
18 Print help message and exit.
19 --version
21 Print version information and exit.
22 --list
24 Print a list of all available checker programs and exit.
25 --list-types
27 Print a list of the support file types and exit.
28 --list-sets
30 Print a list of all the checker sets and exit.
31 --list-set <set>
33 Print the list of available checkers for the specified set and
34 exit.
35 --priority <low|normal|high|important|all>
37 Tell each checker program to report issues with the specified
38 priority only. This option is useful to help put issues into "fix-
39 first" order.
40 Supported priorites are:
42 low -> print low priority issues only
43 normal -> print normal priority issues only
44 high -> print high priority issues only
45 important -> print issues with normal or high priority
46 all -> print all issues (default)
47 --strict <normal|super|all>
49 Tell each checker program to report issues match the strictness
50 level only. Use this option to help filter out issues of less
51 importance.
52 Support strictness levels are:
54 normal -> print non-super strict issues only
55 super -> print super strict issues only
56 all -> print all issues (default)
57 --explain
59 For each checker program, if any issues are found, print an
60 explanation of the problem along with solving instructions. May be
61 used in conjunction with the --list option to provide a more
62 detailed description of the checker programs.
63 --ignorerc
65 Ignore .krazy files.
66 --config <krazyrc>
68 Read settings from the specified krazyrc configuration file only.
69 All other configuration files will be ignored, including those
70 found in the user's home directory or in the current working
71 directory.
72 --dry-run
74 With this option the checker programs aren't run; instead, the
75 command line for each check that would be run is printed.
76 --check <prog[,prog1,prog2,...,progN]>
78 Run the specified checker program(s) only. You may not combine
79 this option with --check-sets.
80 Use the --list option to show the list of available checkers.
82 --check-sets <set[,set1,set2,...,setN]>
84 Run the checker programs belonging to the specified set(s) only.
85 You may not combine this option with --check.
86 Use the --list-sets option to see the list of available check sets
88 and programs.
89 --exclude <prog[,prog1,prog2,...,progN]>
91 Do NOT run the specified checker program(s).
92 --extra <prog[,prog1,prog2,...,progN]>
94 Add the specified "extra" program(s) to the list of checkers to
95 run. Use the --list option to show the list of available "extra"
96 checkers; they will be marked with the tag [EXTRA] by the checker
97 description line.
98 --types <type[,type1,type2,...,typeN]>
100 Check the specified file type(s) only.
101 --exclude-types <type[,type1,type2,...,typeN]>
103 Do NOT check the specified file type(s).
104 --export <text|textlist|textedit|xml>
106 Output in one of the following formats:
107 text (default)
108 textlist -> plain old text, 1 offending file-per-line
109 textedit -> text formatted for IDEs, 1 issue-per-line
110 (file:line:issue)
111 xml -> XML formatted
112 --title
114 Give the output report a project title.
115 --cms
117 An acronym for "component/module/subdir". Used to write the
118 breadcrumbs line in the XML output. Must be a slash-delimited
119 triple containing the component, module, and subdir which is being
120 scanned.
121 --brief
123 Only print the output for checkers that have at least 1 issue.
124 --no-brief
126 Print the result of all checks i.e, the opposite of --brief. This
127 is the default output setting.
128 --quiet
130 Suppress all output messages.
131 --verbose
133 Print the offending content for each file processed
134
136 KRAZY_PLUGIN_PATH - this is a colon-separated list of paths which is
137 searched when locating plugins. By default, plugins are searched for in
138 the path $TOP/lib/krazy2/krazy-plugins:krazy-plugins.
139 KRAZY_EXTRA_PATH - this is a colon-separated list of paths which is
141 searched when locating "extra" plugins. By default, the "extras" are
142 searched for in the path $TOP/lib/krazy2/krazy-extras:krazy-extras.
143 KRAZY_SET_PATH - this is a colon-separated list of paths which is
145 searched when locating checker sets. By default, the sets are searched
146 for in the path $TOP/lib/krazy2/krazy-sets:krazy-sets.
147 where $TOP is the top-level installation directory (eg. /usr/local,
149 /usr/local/Krazy2)
150
152 In normal operation, krazy2all exits with a status 0.
153 If a command line option was incorrectly provided, krazy2all exits with
155 status=1.
156 If krazy2all was envoked with the --help, --version --list or
158 --list-types options it will exit with status=0.
159
161 Copyright (c) 2005-2010 by Allen Winter <winter@kde.org>
162 This program is free software; you can redistribute it and/or modify it
164 under the terms of the GNU General Public License as published by the
165 Free Software Foundation; either version 2 of the License, or (at your
166 option) any later version.
167 This program is distributed in the hope that it will be useful, but
169 WITHOUT ANY WARRANTY; without even the implied warranty of
170 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
171 General Public License for more details.
172 You should have received a copy of the GNU General Public License along
174 with this program; if not, write to the Free Software Foundation, Inc.,
175 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
176
178 .krazy (see krazyrc(3))
179 krazy2all looks up the current working directory tree for a .krazy file
181 in the project subdirectory. Only .krazy files found at the project
182 subdirectory level are read.
183 For example, if the current working dir is
185 /my/kde/trunk/KDE/kdepimlibs/kcal/versit, then krazy2all will look for
186 /my/kde/trunk/KDE/kdepimlibs/kcal/.krazy, since kcal is the project
187 within the kdepimlibs module.
188 If the current working dir is not within a KDE module, or if the
190 current working dir is above a project subdir, then a .krazy file will
191 not be read.
192
194 krazyrc(3), krazy2(1), krazy2xml(1)
195
197 Allen Winter, <winter@kde.org>
198perl v5.38.0 2023-07-20 KRAZY2ALL(1)