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 --ignorerc
30 Ignore .krazy files.
31 --config <krazyrc>
33 Read settings from the specified krazyrc configuration file only.
34 All other configuration files will be ignored, including those
35 found in the user's home directory or in the current working
36 directory.
37 --dry-run
39 With this option the checker programs aren't run; instead, the
40 command line for each check that would be run is printed.
41 --priority <low|normal|high|important|all>
43 Tell each checker program to report issues with the specified
44 priority only. This option is useful to help put issues into "fix-
45 first" order.
46 Supported priorites are:
48 low -> print low priority issues only
49 normal -> print normal priority issues only
50 high -> print high priority issues only
51 important -> print issues with normal or high priority
52 all -> print all issues (default)
53 --strict <normal|super|all>
55 Tell each checker program to report issues match the strictness
56 level only. Use this option to help filter out issues of less
57 importance.
58 Support strictness levels are:
60 normal -> print non-super strict issues only
61 super -> print super strict issues only
62 all -> print all issues (default)
63 --check <prog[,prog1,prog2,...,progN]>
65 Run the specified checker program(s) only. You may not combine
66 this option with --check-sets.
67 Use the --list option to show the list of available checkers.
69 --check-sets <set[,set1,set2,...,setN]>
71 Run the checker programs belonging to the specified set(s) only.
72 You may not combine this option with --check.
73 Use the --list-sets option to see the list of available check sets
75 and programs.
76 --exclude <prog[,prog1,prog2,...,progN]>
78 Do NOT run the specified checker program(s).
79 --extra <prog[,prog1,prog2,...,progN]>
81 Add the specified "extra" program(s) to the list of checkers to
82 run. Use the --list option to show the list of available "extra"
83 checkers; they will be marked with the tag [EXTRA] by the checker
84 description line.
85 --types <type[,type1,type2,...,typeN]>
87 Check the specified file type(s) only.
88 --exclude-types <type[,type1,type2,...,typeN]>
90 Do NOT check the specified file type(s).
91 --export <text|textlist|textedit|xml>
93 Output in one of the following formats:
94 text (default)
95 textlist -> plain old text, 1 offending file-per-line
96 textedit -> text formatted for IDEs, 1 issue-per-line
97 (file:line:issue)
98 xml -> XML formatted
99 --title
101 Give the output report a project title.
102 --cms
104 An acronym for "component/module/subdir". Used to write the
105 breadcrumbs line in the XML output. Must be a slash-delimited
106 triple containing the component, module, and subdir which is being
107 scanned.
108 --brief
110 Only print the output for checkers that have at least 1 issue.
111 --quiet
113 Suppress all output messages.
114 --verbose
116 Print the offending content for each file processed
117
119 KRAZY_PLUGIN_PATH - this is a colon-separated list of paths which is
120 searched when locating plugins. By default, plugins are searched for in
121 the path $TOP/lib/krazy2/krazy-plugins:krazy-plugins.
122 KRAZY_EXTRA_PATH - this is a colon-separated list of paths which is
124 searched when locating "extra" plugins. By default, the "extras" are
125 searched for in the path $TOP/lib/krazy2/krazy-extras:krazy-extras.
126 KRAZY_SET_PATH - this is a colon-separated list of paths which is
128 searched when locating checker sets. By default, the sets are searched
129 for in the path $TOP/lib/krazy2/krazy-sets:krazy-sets.
130 where $TOP is the top-level installation directory (eg. /usr/local,
132 /usr/local/Krazy2)
133
135 In normal operation, krazy2all exits with a status 0.
136 If a command line option was incorrectly provided, krazy2all exits with
138 status=1.
139 If krazy2all was envoked with the --help, --version --list or
141 --list-types options it will exit with status=0.
142
144 Copyright (c) 2005-2010 by Allen Winter <winter@kde.org>
145 This program is free software; you can redistribute it and/or modify it
147 under the terms of the GNU General Public License as published by the
148 Free Software Foundation; either version 2 of the License, or (at your
149 option) any later version.
150 This program is distributed in the hope that it will be useful, but
152 WITHOUT ANY WARRANTY; without even the implied warranty of
153 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
154 General Public License for more details.
155 You should have received a copy of the GNU General Public License along
157 with this program; if not, write to the Free Software Foundation, Inc.,
158 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
159
161 .krazy (see krazyrc(5))
162 krazy2all looks up the current working directory tree for a .krazy file
164 in the project subdirectory. Only .krazy files found at the project
165 subdirectory level are read.
166 For example, if the current working dir is
168 /my/kde/trunk/KDE/kdepimlibs/kcal/versit, then krazy2all will look for
169 /my/kde/trunk/KDE/kdepimlibs/kcal/.krazy, since kcal is the project
170 within the kdepimlibs module.
171 If the current working dir is not within a KDE module, or if the
173 current working dir is above a project subdir, then a .krazy file will
174 not be read.
175
177 krazyrc(5), krazy2(1), krazy2xml(1)
178
180 Allen Winter, <winter@kde.org>
181perl v5.12.2 2010-09-02 KRAZY2ALL(1)