regenerate generated documentation

1 files changed, 61 insertions, 49 deletions

diff --git a/man/pylint.1 b/man/pylint.1
index 29b91d967..b190e6857 100644
--- a/man/pylint.1
+++ b/man/pylint.1
@@ -1,4 +1,4 @@
-.TH pylint 1 "2010-11-15" pylint
+.TH pylint 1 "2013-4-16" pylint
 .SH NAME
 .B pylint
 \- python code static checker
@@ -26,6 +26,8 @@ and much more.
 
 Additionally, it is possible to write plugins to add your own checks.
 
+Pylint is shipped with "pylint-gui", "pyreverse" (UML diagram generator)
+and "symilar" (an independent similarities checker).
 
 .SH OPTIONS
 .IP "--version"
@@ -43,7 +45,7 @@ Python code to execute, usually for sys.path manipulation such as pygtk.require(
 .IP "--errors-only, -E"
 In error mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default
 .IP "--ignore=<file>[,<file>...]"
-Add files or directories to the blacklist. They should be base names, not paths.
+Add files or directories to the blacklist. They should be base names, not paths. [current: CVS]
 .IP "--persistent=<y_or_n>"
 Pickle collected data for later comparisons. [current: yes]
 .IP "--load-plugins=<modules>"
@@ -61,15 +63,17 @@ Generate a sample configuration file according to the current configuration. You
 
 .SH MESSAGES CONTROL
 .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.
+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. See also the "--disable" option for examples.
 .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 (only on the command line, not in the configuration file where it should appear only once).
+Disable the message, report, category or checker with the given id(s). You can either give multiple identifiers separated by comma (,) or put this option multiple times (only on the command line, not in the configuration file where it should appear only once).You can also use "--disable=all" to disable everything first and then reenable specific checks. For example, if you want to run only the similarities checker, you can use "--disable=all --enable=similarities". If you want to run only the classes checker, but have no Warning level messages displayed, use"--disable=all --enable=classes --disable=W"
 
 .SH REPORTS
 .IP "--output-format=<format>, -f <format>"
-Set the output format. Available formats are text,                 parseable, colorized, msvs (visual studio) and html [current: text]
+Set the output format. Available formats are text, parseable, colorized, msvs (visual studio) and html. You can also give a reporter class, eg mypackage.mymodule.MyReporterClass. [current: text]
 .IP "--include-ids=<y_or_n>, -i <y_or_n>"
 Include message's id in output [current: no]
+.IP "--symbols=<y_or_n>, -s <y_or_n>"
+Include symbolic ids of messages in output [current: no]
 .IP "--files-output=<y_or_n>"
 Put messages in a separate file for each module / package specified on the command line instead of printing them on stdout. Reports (if any) will be written in a file name "pylint_global.[txt|html]". [current: no]
 .IP "--reports=<y_or_n>, -r <y_or_n>"
@@ -79,14 +83,6 @@ 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]
@@ -119,27 +115,13 @@ 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 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 BASIC
 .IP "--required-attributes=<attributes>"
@@ -178,26 +160,57 @@ Minimum lines number of a similarity. [current: 4]
 Ignore comments when computing similarities. [current: yes]
 .IP "--ignore-docstrings=<y or n>"
 Ignore docstrings when computing similarities. [current: yes]
+.IP "--ignore-imports=<y or n>"
+Ignore imports when computing similarities. [current: no]
+
+.SH MISCELLANEOUS
+.IP "--notes=<comma separated values>"
+List of note tags to take in consideration, separated by a comma. [current: FIXME,XXX,TODO]
+
+.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. Python regular expressions are accepted. [current: REQUEST,acl_users,aq_parent]
+
+.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 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]
+.IP "--valid-classmethod-first-arg=<argument names>"
+List of valid names for the first argument in a class method. [current: cls]
+.IP "--valid-metaclass-classmethod-first-arg=<argument names>"
+List of valid names for the first argument in a metaclass class method. [current: mcs]
+
+.SH EXCEPTIONS
+.IP "--overgeneral-exceptions=<comma-separated class names>"
+Exceptions that will emit a warning when being caught. Defaults to "Exception" [current: Exception]
 
 .SH ENVIRONMENT VARIABLES
 
-The following environment variables are used :                                 
-    * PYLINTHOME                                                               
-    path to the directory where data of persistent run will be stored. If not
-found, it defaults to ~/.pylint.d/ or .pylint.d (in the current working
-directory).
-    * PYLINTRC                                                                 
-    path to the configuration file. If not found, it will use the first        
-existent file in ~/.pylintrc, /etc/pylintrc.
+The following environment variables are used:                                   
+    * PYLINTHOME                                                                
+    path to the directory where data of persistent run will be stored. If not 
+found, it defaults to ~/.pylint.d/ or .pylint.d (in the current working 
+directory).                                                                     
+    * PYLINTRC                                                                  
+    path to the configuration file. If not found, it will use the first         
+existing file among (~/.pylintrc, /etc/pylintrc).
 
 .SH OUTPUT
-
 Using the default text output, the message format is :                          
                                                                                 
         MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE                                
@@ -209,9 +222,8 @@ There are 5 kind of message types :
     * (E) error, for probable bugs in the code                                  
     * (F) fatal, if an error occurred which prevented pylint from doing further
 processing.
-        
-.SH OUTPUT STATUS CODE
 
+.SH OUTPUT STATUS CODE
 Pylint should leave with following status code:                                 
     * 0 if everything went fine                                                 
     * 1 if a fatal message was issued                                           
@@ -223,13 +235,10 @@ Pylint should leave with following status code:
                                                                                 
 status 1 to 16 will be bit-ORed so you can know which different categories has
 been issued by analysing pylint output status code
-        
+
 .SH SEE ALSO
 /usr/share/doc/pythonX.Y-pylint/
 
-.SH COPYRIGHT
-Logilab S.A.
-
 .SH BUGS
 Please report bugs on the project's mailing list:
 mailto://python-projects@lists.logilab.org
@@ -237,3 +246,6 @@ mailto://python-projects@lists.logilab.org
 .SH AUTHOR
 Logilab <python-projects@lists.logilab.org>
 
+.SH COPYRIGHT
+Logilab S.A.
+