update documentation and manpage

1 files changed, 65 insertions, 64 deletions

diff --git a/man/pylint.1 b/man/pylint.1
index 38b7a91..7fb46e8 100644
--- a/man/pylint.1
+++ b/man/pylint.1
@@ -1,4 +1,4 @@
-.TH pylint 1 "2010-5-25" pylint
+.TH pylint 1 "2010-11-15" pylint
 .SH NAME
 .B pylint
 \- python code static checker
@@ -26,6 +26,7 @@ and much more.
 
 Additionally, it is possible to write plugins to add your own checks.
 
+
 .SH OPTIONS
 .IP "--version"
 show program's version number and exit
@@ -62,7 +63,7 @@ Generate a sample configuration file according to the current configuration. You
 .IP "--enable=<msg ids>, -e <msg ids>"
 Enable the message, report, category or checker with the given id(s). You can either give multiple identifier separated by comma (,) or put this option multiple time.
 .IP "--disable=<msg ids>, -d <msg ids>"
-Disable the message, report, category or checker with the given id(s). You can either give multiple identifier separated by comma (,) or put this option multiple time.
+Disable the message, report, category or checker with the given id(s). You can either give multiple identifier separated by comma (,) or put this option multiple time (only on the command line, not in the configuration file where it should appear only once).
 
 .SH REPORTS
 .IP "--output-format=<format>, -f <format>"
@@ -78,6 +79,68 @@ Python expression which should return a note less than 10 (10 is the highest not
 .IP "--comment=<y_or_n>"
 Add a comment according to your evaluation note. This is used by the global evaluation report (RP0004). [current: no]
 
+.SH FORMAT
+.IP "--max-line-length=<int>"
+Maximum number of characters on a single line. [current: 80]
+.IP "--max-module-lines=<int>"
+Maximum number of lines in a module [current: 1000]
+.IP "--indent-string=<string>"
+String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1 tab). [current: '    ']
+
+.SH IMPORTS
+.IP "--deprecated-modules=<modules>"
+Deprecated modules which should not be used, separated by a comma [current: regsub,string,TERMIOS,Bastion,rexec]
+.IP "--import-graph=<file.dot>"
+Create a graph of every (i.e. internal and external) dependencies in the given file (report RP0402 must not be disabled) [current: none]
+.IP "--ext-import-graph=<file.dot>"
+Create a graph of external dependencies in the given file (report RP0402 must not be disabled) [current: none]
+.IP "--int-import-graph=<file.dot>"
+Create a graph of internal dependencies in the given file (report RP0402 must not be disabled) [current: none]
+
+.SH DESIGN
+.IP "--max-args=<int>"
+Maximum number of arguments for function / method [current: 5]
+.IP "--ignored-argument-names=<regexp>"
+Argument names that match this expression will be ignored. Default to name with leading underscore [current: _.*]
+.IP "--max-locals=<int>"
+Maximum number of locals for function / method body [current: 15]
+.IP "--max-returns=<int>"
+Maximum number of return / yield for function / method body [current: 6]
+.IP "--max-branchs=<int>"
+Maximum number of branch for function / method body [current: 12]
+.IP "--max-statements=<int>"
+Maximum number of statements in function / method body [current: 50]
+.IP "--max-parents=<num>"
+Maximum number of parents for a class (see R0901). [current: 7]
+.IP "--max-attributes=<num>"
+Maximum number of attributes for a class (see R0902). [current: 7]
+.IP "--min-public-methods=<num>"
+Minimum number of public methods for a class (see R0903). [current: 2]
+.IP "--max-public-methods=<num>"
+Maximum number of public methods for a class (see R0904). [current: 20]
+
+.SH MISCELLANEOUS
+.IP "--notes=<comma separated values>"
+List of note tags to take in consideration, separated by a comma. [current: FIXME,XXX,TODO]
+
+.SH VARIABLES
+.IP "--init-import=<y_or_n>"
+Tells whether we should check for unused import in __init__ files. [current: no]
+.IP "--dummy-variables-rgx=<regexp>"
+A regular expression matching the beginning of                   the name of dummy variables (i.e. not used). [current: _|dummy]
+.IP "--additional-builtins=<comma separated list>"
+List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [current: none]
+
+.SH TYPECHECK
+.IP "--ignore-mixin-members=<y_or_n>"
+Tells whether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [current: yes]
+.IP "--ignored-classes=<members names>"
+List of classes names for which member attributes should not be checked (useful for classes with attributes dynamically set). [current: SQLObject]
+.IP "--zope=<y_or_n>"
+When zope mode is activated, add a predefined set of Zope acquired attributes to generated-members. [current: no]
+.IP "--generated-members=<members names>"
+List of members which are set dynamically and missed by pylint inference system, and so shouldn't trigger E0201 when accessed. [current: REQUEST,acl_users,aq_parent]
+
 .SH BASIC
 .IP "--required-attributes=<attributes>"
 Required attributes for module, separated by a comma [current: none]
@@ -108,10 +171,6 @@ Bad variable names which should always be refused, separated by a comma [current
 .IP "--no-docstring-rgx=<regexp>"
 Regular expression which should only match functions or classes name which do not require a docstring [current: __.*__]
 
-.SH MISCELLANEOUS
-.IP "--notes=<comma separated values>"
-List of note tags to take in consideration, separated by a comma. [current: FIXME,XXX,TODO]
-
 .SH SIMILARITIES
 .IP "--min-similarity-lines=<int>"
 Minimum lines number of a similarity. [current: 4]
@@ -120,70 +179,12 @@ Ignore comments when computing similarities. [current: yes]
 .IP "--ignore-docstrings=<y or n>"
 Ignore docstrings when computing similarities. [current: yes]
 
-.SH IMPORTS
-.IP "--deprecated-modules=<modules>"
-Deprecated modules which should not be used, separated by a comma [current: regsub,string,TERMIOS,Bastion,rexec]
-.IP "--import-graph=<file.dot>"
-Create a graph of every (i.e. internal and external) dependencies in the given file (report RP0402 must not be disabled) [current: none]
-.IP "--ext-import-graph=<file.dot>"
-Create a graph of external dependencies in the given file (report RP0402 must not be disabled) [current: none]
-.IP "--int-import-graph=<file.dot>"
-Create a graph of internal dependencies in the given file (report RP0402 must not be disabled) [current: none]
-
-.SH TYPECHECK
-.IP "--ignore-mixin-members=<y_or_n>"
-Tells whether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [current: yes]
-.IP "--ignored-classes=<members names>"
-List of classes names for which member attributes should not be checked (useful for classes with attributes dynamically set). [current: SQLObject]
-.IP "--zope=<y_or_n>"
-When zope mode is activated, add a predefined set of Zope acquired attributes to generated-members. [current: no]
-.IP "--generated-members=<members names>"
-List of members which are set dynamically and missed by pylint inference system, and so shouldn't trigger E0201 when accessed. [current: REQUEST,acl_users,aq_parent]
-
 .SH CLASSES
 .IP "--ignore-iface-methods=<method names>"
 List of interface methods to ignore, separated by a comma. This is used for instance to not check methods defines in Zope's Interface base class. [current: isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by]
 .IP "--defining-attr-methods=<method names>"
 List of method names used to declare (i.e. assign) instance attributes. [current: __init__,__new__,setUp]
 
-.SH DESIGN
-.IP "--max-args=<int>"
-Maximum number of arguments for function / method [current: 5]
-.IP "--ignored-argument-names=<regexp>"
-Argument names that match this expression will be ignored. Default to name with leading underscore [current: _.*]
-.IP "--max-locals=<int>"
-Maximum number of locals for function / method body [current: 15]
-.IP "--max-returns=<int>"
-Maximum number of return / yield for function / method body [current: 6]
-.IP "--max-branchs=<int>"
-Maximum number of branch for function / method body [current: 12]
-.IP "--max-statements=<int>"
-Maximum number of statements in function / method body [current: 50]
-.IP "--max-parents=<num>"
-Maximum number of parents for a class (see R0901). [current: 7]
-.IP "--max-attributes=<num>"
-Maximum number of attributes for a class (see R0902). [current: 7]
-.IP "--min-public-methods=<num>"
-Minimum number of public methods for a class (see R0903). [current: 2]
-.IP "--max-public-methods=<num>"
-Maximum number of public methods for a class (see R0904). [current: 20]
-
-.SH VARIABLES
-.IP "--init-import=<y_or_n>"
-Tells whether we should check for unused import in __init__ files. [current: no]
-.IP "--dummy-variables-rgx=<regexp>"
-A regular expression matching matching the beginning of the name of dummy variables (i.e. not used). [current: _|dummy]
-.IP "--additional-builtins=<comma separated list>"
-List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [current: none]
-
-.SH FORMAT
-.IP "--max-line-length=<int>"
-Maximum number of characters on a single line. [current: 80]
-.IP "--max-module-lines=<int>"
-Maximum number of lines in a module [current: 1000]
-.IP "--indent-string=<string>"
-String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1 tab). [current: '    ']
-
 .SH ENVIRONMENT VARIABLES
 
 The following environment variables are used :