1
2Gendarme(Gendarme 4.2.0.0) Gendarme(Gendarme 4.2.0.0)
3
4
5
7 Gendarme - Rule-based code analysis for Mono.
8
9
11 ignore-file
12 This file is used to filter out defects from gendarme reports.
13 It uses a line oriented file format where the first characters
14 of the line control the interpretation of the line:
15 # - means that the line is a comment.
16 R: - if the full name of a rule to be filtered.
17 A: - is used to filter out an assembly (the extension can be
18 omitted).
19 T: - is used to filter out a namespace qualified type name.
20 M: - is used to filter out a method. It must contain the full
21 method name as it appears in the report.
22
23 An ignore-file can be generated automatically (using gd2i) from a XML
24 defect list produced by Gendarme.
25
26
27 rules.xml
28 This file is used in conjunction with the --set option to con‐
29 trol and configure the rules used by Gendarme. It contains a set
30 of named rules (rule sets) and each rule set contains a list of
31 rules. Rules have required from and include attributes, optional
32 exclude and applyTo attributes, and optional parameter child
33 elements.
34
35 The from attribute is the path of a dll to load ("Gen‐
36 darme.Rules.BadPractice.dll"). Relative paths are relative to
37 the gendarme executable.
38
39 The include attribute may be "*" to match every rule in the dll
40 or a list of rule names separated by '|' ("WhizBangRule |
41 MyRule").
42
43 The exclude attribute is a list of rule names separated by '|'
44 ("IckyRule"). These will override any rules matched by the
45 include attribute.
46
47 The applyTo attribute may be "all", "visible", or "nonvisible".
48 If it is all (the default) then all types in the assemblies are
49 checked, if it is visible then only the externally visible types
50 are checked, if it is nonvisible then only the internally visi‐
51 ble types are checked.
52
53 The parameter child element is used to customize the behavior of
54 a rule within a dll. It has three required attributes: rule,
55 property, and value. rule is the name of the applicable rule
56 ("AvoidSmallNamespaceRule"), property is the name of a public
57 property in the rule ("Minimum"), value is the value to assign
58 to the property ("10").
59
60 gendarme.exe.config
61 Used by debug versions of Gendarme to enable logging for rules.
62 A config file will be generated automatically by the make file.
63 To enable logging for a rule edit the config file, add a switch
64 using the rule's name, and set the value to 1.
65
66
68 Copyright (C) 2005-2010 Novell, Inc (http://www.novell.com)
69
71 Mailing lists are listed at the http://groups.google.com/group/gendarme
72
74 http://www.mono-project.com/Gendarme
75
77 gendarme(1),[22mgd2i(1)
78
79
80
81
82 Gendarme(Gendarme 4.2.0.0)