Permalink
Browse files

Reuploaded version from ASPNetProvider.

  • Loading branch information...
1 parent 7351b3e commit 941cfabdc7f09f2bfff1a9c4ba25c61870a8984f fxjr committed Feb 19, 2010
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
View
@@ -1,45 +1,3 @@
-2009-12-20 Version 2.6
-
- Released just in time for xmas Gendarme 2.6 comes with a lot of
- enhancements and bug fixes. Rule documentation (wiki) and our MAN
- pages were also greatly enhanced by the work of Jesse Jones.
-
- In the ecosystem Daniel Nauck contributed Gendarme support for
- CC.NET and a new NAnt task with reduced dependencies. With this
- Gendarme should be easier than ever to use on your projects.
-
- This release includes 12 new rules (207 rules total):
-
- Gendarme.Rules.BadPractice
- * DoNotUseEnumIsAssignableFromRule [JB Evain]
- * OnlyUseDisposeForIDisposableTypesRule [Jesse Jones]
- * PreferSafeHandleRule [Jesse Jones]
-
- Gendarme.Rules.Concurrency
- * DoNotUseThreadStaticWithInstanceFieldsRule [Jesse Jones]
-
- Gendarme.Rules.Correctness
- * ProvideValidXmlStringRule [Cedric Vivier]
- * ProvideValidXPathExpressionRule [Cedric Vivier]
-
- Gendarme.Rules.Design
- * PreferXmlAbstractionsRule [Cedric Vivier]
- * UseCorrectDisposeSignaturesRule [Jesse Jones]
- * UseFlagsAttributeRule [Jesse Jones]
-
- Gendarme.Rules.Exceptions
- * UseObjectDisposedExceptionRule [Jesse Jones]
-
- Gendarme.Rules.Interoperability
- * DelegatesPassedToNativeCodeMustIncludeExceptionHandlingRule [Rolf Bjarne Kvinge]
-
- Gendarme.Rules.Performance
- * ReviewLinqMethodRule [Jesse Jones]
-
- Contributors for this release are:
- Cedric Vivier, Daniel Nauck, JB Evain, Jesse Jones, Rolf Bjarne
- Kvinge and Sebastien Pouliot.
-
2009-01-20 Version 2.4
This release was the shortest (about 2 months) release cycle ever
@@ -82,7 +40,7 @@
Contributors for this release are:
Andres G. Aragoneses, Cedric Vivier, JB Evain, Jesse Jones,
Nestor Salceda, Sebastien Pouliot.
-
+
2008-11-10 Version 2.2
This release includes the development results of the last four
Binary file not shown.
View
@@ -1,49 +1,47 @@
.\"
.\" Gendarme manual page.
.\"
-.\" Authors:
+.\" Author:
.\" Sebastien Pouliot <sebastien@ximian.com>
-.\" Jesse Jones <jesjones@mindspring.com>
.\"
-.\" Copyright (C) 2005-2006,2008-2009 Novell, Inc (http://www.novell.com)
+.\" Copyright (C) 2005-2006,2008 Novell, Inc (http://www.novell.com)
.\"
.de Sp
.if t .sp .5v
.if n .sp
..
-.TH Gendarme "Gendarme 2.6.0.0"
+.TH Gendarme "Gendarme 2.4.0.0"
.SH NAME
-Gendarme \- Rule-based code analysis for Mono.
+Gendarme \- Rule-based code analysis for Mono::
.SH SYNOPSIS
.PP
.B gendarme [--config configfile] [--set ruleset] [--log file | --xml file | --html file] [options] assemblies ...
.SH DESCRIPTION
-\fIGendarme\fP is a extensible rule-based tool used to find problems in .NET
+\fIGendarme\fP is a extensible rule-based tool to find problems in .NET
applications and libraries. Gendarme inspects programs and libraries that
contain code in ECMA CIL format (Mono and .NET) and looks for common
-problems with the code, problems that compilers do not typically check or
-have historically not checked.
+problems with the code, problems that compiler do not typically check or
+have not historically checked.
.SH OPTIONS
.TP
.I "--config configfile"
-Specify the rule sets and rule settings. Default is 'rules.xml'.
+Specify the configuration file. Default is 'rules.xml'.
.TP
.I "--set ruleset"
-Specify a rule set from configfile. Defaults to 'default'.
+Specify the set of rules to verify. Default is '*'.
.TP
.I "--log file"
-Save the report to the specified file. If none of --log, --xml, or --html are used
-then the report is written to stdout.
+Save the text output to the specified file.
.TP
.I "--xml file"
-Save the report, formatted as XML, to the specified file.
+Save the output, formatted as XML, to the specified file.
.TP
.I "--html file"
-Save the report, formatted as HTML, to the specified file.
+Save the output, formatted as HTML, to the specified file.
.TP
.I "--ignore ignore-file"
-Do not report defects listed in the specified file.
+Do not report the known defects that are part of the specified file.
.TP
.I "--limit N"
Stop reporting after N defects are found.
@@ -57,34 +55,31 @@ Filter the reported defects to include the specified confidence levels.
Default is 'normal+' (i.e. low level is ignored).
.TP
.I "--quiet"
-Used to disable progress and other information which is normally written to stdout.
+Display minimal output (results) from the runner.
.TP
.I "--v|verbose"
-When present additional progress information is written to stdout. May be used
-more than once to write even more info.
+Enable debugging output. You can supply several -v to augment debugging verbosity.
.TP
.I "--version"
-Display Gendarme's version number. This will match the Mono version number
-that this copy of Gendarme was released with.
+Display Gendarme's version number. This number match the Mono release
+where it was released.
.TP
.I "assemblies ..."
Specify the assemblies to verify. You can specify multiple filenames,
-including masks (? and *). You can also provide a file that lists several
-assemblies (one per line) by prefixing the filename with @ on the command
+including masks (? and *). You can also provide a file that list several
+assemblies (one by line) by prefixing the filename with @ on the command
line.
.SH FILES
.TP
-.I ignore-file
-This file is used to filter out defects from gendarme reports.
-.TP
.I rules.xml
-This file is used in conjunction with the --set option to control and configure the rules
-used by Gendarme. It contains a set of named rules (rule sets) and each rule set contains
-a list of rules.
-.TP
-.I gendarme.exe.config
-Used by debug versions of Gendarme to enable logging for rules. It is useful
-for Gendarme's developers (i.e. not meant for end-users).
+This files contains a list of all the rulesets available to Gendarme. Each
+ruleset includes a list of assemblies in which some, or all, rules can be
+verified (include) or not (exclude).
++.TP
++.I gendarme.exe.config
++Used by debug versions of Gendarme to enable logging for rules. A config
++file will be generated automatically by the make file. To enable logging
++for a rule add a switch using the rule's name and set the value to 1.
.SH ENVIRONMENT VARIABLES
.TP
.I GENDARME_COLOR
@@ -97,11 +92,11 @@ E.g.
GENDARME_COLOR=none gendarme ...
.fi
.SH COPYRIGHT
-Copyright (C) 2005-2009 Novell, Inc (http://www.novell.com)
+Copyright (C) 2005-2008 Novell, Inc (http://www.novell.com)
.SH MAILING LISTS
Mailing lists are listed at the
http://groups.google.com/group/gendarme
.SH WEB SITE
http://www.mono-project.com/Gendarme
.SH SEE ALSO
-.BR gendarme(5), mono(1)
+.BR mono(1)
View
Binary file not shown.

0 comments on commit 941cfab

Please sign in to comment.