1
2Gendarme(Gendarme 2.6.2.0)                          Gendarme(Gendarme 2.6.2.0)
3
4
5

NAME

7       Gendarme - Rule-based code analysis for Mono.
8
9

FILE FORMATS

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
24       rules.xml
25              This  file  is used in conjunction with the --set option to con‐
26              trol and configure the rules used by Gendarme. It contains a set
27              of  named rules (rule sets) and each rule set contains a list of
28              rules. Rules have required from and include attributes, optional
29              exclude  and  applyTo  attributes,  and optional parameter child
30              elements.
31
32              The from  attribute  is  the  path  of  a  dll  to  load  ("Gen‐
33              darme.Rules.BadPractice.dll").   Relative  paths are relative to
34              the gendarme executable.
35
36              The include attribute may be "*" to match every rule in the  dll
37              or  a  list  of  rule  names  separated  by '|' ("WhizBangRule |
38              MyRule").
39
40              The exclude attribute is a list of rule names separated  by  '|'
41              ("IckyRule").   These  will  override  any  rules matched by the
42              include attribute.
43
44              The applyTo attribute may be "all", "visible", or  "nonvisible".
45              If  it is all (the default) then all types in the assemblies are
46              checked, if it is visible then only the externally visible types
47              are  checked, if it is nonvisible then only the internally visi‐
48              ble types are checked.
49
50              The parameter child element is used to customize the behavior of
51              a  rule  within  a dll.  It has three required attributes: rule,
52              property, and value. rule is the name  of  the  applicable  rule
53              ("AvoidSmallNamespaceRule"),  property  is  the name of a public
54              property in the rule ("Minimum"), value is the value  to  assign
55              to the property ("10").
56
57       gendarme.exe.config
58              Used  by debug versions of Gendarme to enable logging for rules.
59              A config file will be generated automatically by the make  file.
60              To  enable logging for a rule edit the config file, add a switch
61              using the rule's name, and set the value to 1.
62
63

65       Copyright (C) 2005-2009 Novell, Inc (http://www.novell.com)
66

MAILING LISTS

68       Mailing lists are listed at the http://groups.google.com/group/gendarme
69

WEB SITE

71       http://www.mono-project.com/Gendarme
72

SEE ALSO

74       gendarme(1)
75
76
77
78
79                                                    Gendarme(Gendarme 2.6.2.0)
Impressum