1doc::krazyrc(3)       User Contributed Perl Documentation      doc::krazyrc(3)
2
3
4

NAME

6       .krazy - krazy control directives
7

DESCRIPTION

9       .krazy files provide directives that control how the Krazy Code
10       Checking tools perform within a KDE source directory.
11
12       Each line in the file can be a control directive, a blank line, or a
13       comment. Comment lines start with the # character.
14
15       If multiple instances of a directive are specified they will be merged
16       together in a logical way.
17

DIRECTIVES

19       The following directives are understood by the Krazy Code Checking
20       tools:
21
22       EXCLUDE plugin1[,plugin2,...]
23        Remove the specified plugins from the default set of checkers.
24
25       CHECK plugin1[,plugin2,...]
26        Run only the specified list of plugins from the default set of
27        checkers.  You may not combine this with the CHECKSET directive nor
28        with the --check-sets command line option.
29
30        Note: the CHECK directive takes precedence over the EXCLUDE directive;
31        i.e, plugins specified by the CHECK directive are always run, even if
32        they are also specified in an EXCLUDE directive.
33
34       CHECKSETS set1[,set2,...]
35        Run the checker programs belonging to the specified set(s) only.  You
36        may not combine this with the CHECK directive nor with the --check
37        command line option.
38
39       EXTRA plugin1[,plugin2,...]
40        Add the specified list of "extra" plugins to the default set of
41        checkers.
42
43       TYPES type1[,type2,...]
44        Check the specified file type(s) only.
45
46       EXCLUDETYPES type1[,type2,...]
47        Do NOT check the specified file type(s).
48
49       SKIP regexp
50        Do not process any file that maches the specified perl regular
51        expression.  See the perlreref(1) man page for a description of how to
52        write a perl regular expression.
53
54       PRIORITY priority
55        Set the priority value. Must be one of "low", "normal", "high",
56        "important", "all".
57
58       STRICT strict
59        Set the strict value. Must be one of "normal", "super", "all".
60
61       OUTPUT output
62        Set the output level. Must be one of "quiet", "brief", "all".
63
64          "quiet" means no output is printed, even if --verbose is passed on
65          the command line.
66
67          "brief" will only print checker summaries if the check has at least
68          1 issue.
69
70          "all" is the normal mode and prints all checker summaries
71
72       EXPORT export-type
73        Set the default export-type value. Must be one of the following:
74
75          "text" (default)
76
77          "textlist" prints 1 offending file-per-line
78
79          "textedit" prints text formatted for IDEs, 1 issue-per-line
80
81          "xml" prints XML formatted intended for follow-on processing
82
83       STYLE_CPPSTYLE C++-style
84        Tell the "style" checker to follow the guidelines of the specified
85        C++-style.
86
87        C++-style must be one of the following:
88
89          "kde" (default), see
90          http://techbase.kde.org/Policies/Kdelibs_Coding_Style
91
92          "pim" kdepim style, see
93          http://pim.kde.org/development/coding-korganizer.php
94
95        Note: Krazy uses a heuristic to decide what type of C++-style to check
96        against.  That heuristic isn't very smart; so use this setting to
97        enforce the C++-style.
98
99        Overrides the KRAZY_STYLE_CPPSTYLE environment variable, see
100        krazy2(1).
101
102       STYLE_OFFSET indent
103        Tell the "style" checker to check for a basic indentation level,
104        usually a small integer like 2 or 4.  This value overrides the offset
105        provided as part of the C++-style (see STYLE_CPPSTYLE).
106
107        Overrides the KRAZY_STYLE_OFFSET environment variable, see krazy2(1).
108
109       STYLE_LINEMAX length
110        Tell the "style" checker to check for lines longer than this number of
111        characters.  The default is unlimited line length.
112
113        Overrides the KRAZY_STYLE_LINEMAX environment variable, see krazy2(1).
114

ADMIN DIRECTIVES

116       This is a list of administrator directives used only by the
117       krazy2xml(1) program and typically not interesting to the average user.
118
119       IGNORESUBS subdir1[,subdir2,...]
120        Do not run Krazy on the specified list of subdirectories.  These must
121        be KDE "project" subdirectories that reside at the top level of a KDE
122        module.
123
124       EXTRASUBS subdir1[,subdir2,...]
125        Run Krazy on the specified list of subdirectories.  These must be KDE
126        "project" subdirectories that reside at the top level of a KDE module.
127
128       IGNOREMODS module1[,module2,...]
129        Do not run Krazy on the specified list of KDE modules.  These must be
130        KDE "module" subdirectories that reside at the top level of a KDE
131        component.
132

134       Copyright 2005-2010 by Allen Winter <winter@kde.org>
135

SEE ALSO

137       krazy2(1), krazy2all(1), krazy2xml(1), perlreftut(1)
138

AUTHORS

140       Allen Winter, <winter@kde.org>
141
142
143
144perl v5.34.0                      2021-07-22                   doc::krazyrc(3)
Impressum