summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorAdrien Di Mascio <Adrien.DiMascio@logilab.fr>2006-08-10 15:49:01 +0200
committerAdrien Di Mascio <Adrien.DiMascio@logilab.fr>2006-08-10 15:49:01 +0200
commit99a0a91c910d48b1d60859be3d3b3f26ca366b2f (patch)
tree80f5fcd7e94550b282425d5d0d2d3234552dcdea /man
parent9a5b95085ca2469c4e0a36a0055ba190ad196ba8 (diff)
downloadpylint-git-99a0a91c910d48b1d60859be3d3b3f26ca366b2f.tar.gz
prepared new version
Diffstat (limited to 'man')
-rw-r--r--man/pylint.1255
1 files changed, 80 insertions, 175 deletions
diff --git a/man/pylint.1 b/man/pylint.1
index eefa920f8..7c519be0d 100644
--- a/man/pylint.1
+++ b/man/pylint.1
@@ -1,4 +1,4 @@
-.TH pylint 1 "2006-4-20" pylint
+.TH pylint 1 "2006-8-10" pylint
.SH NAME
.B pylint
\- python code static checker
@@ -33,20 +33,6 @@ show program's version number and exit
show this help message and exit
.SH MASTER
-lint Python modules using external checkers.
-
- This is the main checker controling the other ones and the reports
- generation. It is itself both a raw checker and an astng checker in order
- to:
- * handle message activation / deactivation at the module level
- * handle some basic but necessary stats'data (number of classes, methods...)
-
-This checker also defines the following reports:
- * R0001: Total errors / warnings
- * R0002: % errors / warnings by module
- * R0003: Messages
- * R0004: Global evaluation
-
.IP "--rcfile=<file>"
Specify a configuration file.
.IP "--disable-all"
@@ -73,7 +59,6 @@ Set the cache size for astng objects.
List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers.
.SH REPORTS
-Options related to messages / statistics reporting
.IP "--reports=<y_or_n>, -r<y_or_n>"
Tells wether to display a full report or only the messages
.IP "--html=<y_or_n>"
@@ -103,46 +88,65 @@ Enable the report with the given id.
.IP "--disable-report=<rpt ids>"
Disable the report with the given id.
-.SH DESIGN
-checks for sign of poor/misdesign:
- * number of methods, attributes, local variables...
- * size, complexity of functions, methods
-
-.IP "--enable-design=<y_or_n>"
+.SH EXCEPTIONS
+.IP "--enable-exceptions=<y_or_n>"
Enable / disable this checker
-.IP "--max-args=<int>"
-Maximum number of arguments for function / method
-.IP "--max-locals=<int>"
-Maximum number of locals for function / method body
-.IP "--max-returns=<int>"
-Maximum number of return / yield for function / method body
-.IP "--max-branchs=<int>"
-Maximum number of branch for function / method body
-.IP "--max-statements=<int>"
-Maximum number of statements in function / method body
-.IP "--max-parents=<num>"
-Maximum number of parents for a class (see R0901).
-.IP "--max-attributes=<num>"
-Maximum number of attributes for a class (see R0902).
-.IP "--min-public-methods=<num>"
-Minimum number of public methods for a class (see R0903).
-.IP "--max-public-methods=<num>"
-Maximum number of public methods for a class (see R0904).
-.SH BASIC
-checks for :
- * doc strings
- * modules / classes / functions / methods / arguments / variables name
- * number of arguments, local variables, branchs, returns and statements in
-functions, methods
- * required module attributes
- * dangerous default values as arguments
- * redefinition of function / method / class
- * uses of the global statement
-
-This checker also defines the following reports:
- * R0101: Statistics by type
+.SH VARIABLES
+.IP "--enable-variables=<y_or_n>"
+Enable / disable this checker
+.IP "--init-import=<y_or_n>"
+Tells wether we should check for unused import in __init__ files.
+.IP "--dummy-variables-rgx=<regexp>"
+A regular expression matching names used for dummy variables (i.e. not used).
+.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.
+
+.SH CLASSES
+.IP "--enable-classes=<y_or_n>"
+Enable / disable this checker
+.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.
+.IP "--defining-attr-methods=<method names>"
+List of method names used to declare (i.e. assign) instance attributes.
+.SH IMPORTS
+.IP "--enable-imports=<y_or_n>"
+Enable / disable this checker
+.IP "--deprecated-modules=<modules>"
+Deprecated modules which should not be used, separated by a comma
+.IP "--import-graph=<file.dot>"
+Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled)
+.IP "--ext-import-graph=<file.dot>"
+Create a graph of external dependencies in the given file (report R0402 must not be disabled)
+.IP "--int-import-graph=<file.dot>"
+Create a graph of internal dependencies in the given file (report R0402 must not be disabled)
+
+.SH TYPECHECK
+.IP "--enable-typecheck=<y_or_n>"
+Enable / disable this checker
+.IP "--ignore-mixin-members=<y_or_n>"
+Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive).
+.IP "--zope=<y_or_n>"
+When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes.
+.IP "--acquired-members=<members names>"
+List of members which are usually get through zope's acquisition mecanism and so shouldn't trigger E0201 when accessed (need zope=yes to be considered.
+
+.SH METRICS
+.IP "--enable-metrics=<y_or_n>"
+Enable / disable this checker
+
+.SH SIMILARITIES
+.IP "--enable-similarities=<y_or_n>"
+Enable / disable this checker
+.IP "--min-similarity-lines=<int>"
+Minimum lines number of a similarity.
+.IP "--ignore-comments=<y or n>"
+Ignore comments when computing similarities.
+.IP "--ignore-docstrings=<y or n>"
+Ignore docstrings when computing similarities.
+
+.SH BASIC
.IP "--enable-basic=<y_or_n>"
Enable / disable this checker
.IP "--required-attributes=<attributes>"
@@ -174,54 +178,33 @@ Bad variable names which should always be refused, separated by a comma
.IP "--bad-functions=<builtin function names>"
List of builtins function names that should not be used, separated by a comma
-.SH CLASSES
-checks for :
- * methods without self as first argument
- * overriden methods signature
- * access only to existant members via self
- * attributes not defined in the __init__ method
- * supported interfaces implementation
- * unreachable code
-
-.IP "--enable-classes=<y_or_n>"
-Enable / disable this checker
-.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.
-.IP "--defining-attr-methods=<method names>"
-List of method names used to declare (i.e. assign) instance attributes.
-
-.SH SIMILARITIES
-checks for similarities and duplicated code. This computation may be
- memory / CPU intensive, so you should disable it if you experiments some
- problems.
-
-This checker also defines the following reports:
- * R0801: Duplication
-
-.IP "--enable-similarities=<y_or_n>"
+.SH NEWSTYLE
+.IP "--enable-newstyle=<y_or_n>"
Enable / disable this checker
-.IP "--min-similarity-lines=<int>"
-Minimum lines number of a similarity.
-.IP "--ignore-comments=<y or n>"
-Ignore comments when computing similarities.
-.IP "--ignore-docstrings=<y or n>"
-Ignore docstrings when computing similarities.
-.SH EXCEPTIONS
-checks for
- * excepts without exception filter
- * string exceptions
-
-.IP "--enable-exceptions=<y_or_n>"
+.SH DESIGN
+.IP "--enable-design=<y_or_n>"
Enable / disable this checker
+.IP "--max-args=<int>"
+Maximum number of arguments for function / method
+.IP "--max-locals=<int>"
+Maximum number of locals for function / method body
+.IP "--max-returns=<int>"
+Maximum number of return / yield for function / method body
+.IP "--max-branchs=<int>"
+Maximum number of branch for function / method body
+.IP "--max-statements=<int>"
+Maximum number of statements in function / method body
+.IP "--max-parents=<num>"
+Maximum number of parents for a class (see R0901).
+.IP "--max-attributes=<num>"
+Maximum number of attributes for a class (see R0902).
+.IP "--min-public-methods=<num>"
+Minimum number of public methods for a class (see R0903).
+.IP "--max-public-methods=<num>"
+Maximum number of public methods for a class (see R0904).
.SH FORMAT
-checks for :
- * unauthorized constructions
- * strict indentation
- * line length
- * use of <> instead of !=
-
.IP "--enable-format=<y_or_n>"
Enable / disable this checker
.IP "--max-line-length=<int>"
@@ -231,97 +214,19 @@ Maximum number of lines in a module
.IP "--indent-string=<string>"
String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).
-.SH IMPORTS
-checks for
- * external modules dependencies
- * relative / wildcard imports
- * cyclic imports
- * uses of deprecated modules
-
-This checker also defines the following reports:
- * R0401: External dependencies
- * R0402: Modules dependencies graph
-
-.IP "--enable-imports=<y_or_n>"
-Enable / disable this checker
-.IP "--deprecated-modules=<modules>"
-Deprecated modules which should not be used, separated by a comma
-.IP "--import-graph=<file.dot>"
-Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled)
-.IP "--ext-import-graph=<file.dot>"
-Create a graph of external dependencies in the given file (report R0402 must not be disabled)
-.IP "--int-import-graph=<file.dot>"
-Create a graph of internal dependencies in the given file (report R0402 must not be disabled)
-
.SH MISCELLANEOUS
-checks for:
- * warning notes in the code like FIXME, XXX
- * PEP 263: source code with non ascii character but no encoding declaration
-
.IP "--enable-miscellaneous=<y_or_n>"
Enable / disable this checker
.IP "--notes=<comma separated values>"
List of note tags to take in consideration, separated by a comma. Default to FIXME, XXX, TODO
-.SH NEWSTYLE
-checks for usage of new style capabilities on old style classes and
- other new/old styles conflicts problems
- * use of property, __slots__, super
- * "super" usage
- * raising a new style class as exception
-
-.IP "--enable-newstyle=<y_or_n>"
-Enable / disable this checker
-
-.SH METRICS
-does not check anything but gives some raw metrics :
- * total number of lines
- * total number of code lines
- * total number of docstring lines
- * total number of comments lines
- * total number of empty lines
-
-This checker also defines the following reports:
- * R0701: Raw metrics
-
-.IP "--enable-metrics=<y_or_n>"
-Enable / disable this checker
-
-.SH TYPECHECK
-try to find bugs in the code using type inference
-
-.IP "--enable-typecheck=<y_or_n>"
-Enable / disable this checker
-.IP "--ignore-mixin-members=<y_or_n>"
-Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive).
-.IP "--zope=<y_or_n>"
-When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes.
-.IP "--acquired-members=<members names>"
-List of members which are usually get through zope's acquisition mecanism and so shouldn't trigger E0201 when accessed (need zope=yes to be considered.
-
-.SH VARIABLES
-checks for
- * unused variables / imports
- * undefined variables
- * redefinition of variable from builtins or from an outer scope
- * use of variable before assigment
-
-.IP "--enable-variables=<y_or_n>"
-Enable / disable this checker
-.IP "--init-import=<y_or_n>"
-Tells wether we should check for unused import in __init__ files.
-.IP "--dummy-variables-rgx=<regexp>"
-A regular expression matching names used for dummy variables (i.e. not used).
-.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.
-
.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) . The current PYLINTHOME is /home/syt/.pylint.d.
+directory) . The current PYLINTHOME is /home/adim/.pylint.d.
* PYLINTRC
path to the configuration file. If not found, it will use the first
existant file in ~/.pylintrc, /etc/pylintrc. The current PYLINTRC is