[doc] redo some of my changes after rebasing nico's changes; rm former manual/quickstart

10 files changed, 60 insertions, 947 deletions

diff --git a/doc/Makefile b/doc/Makefile
index 52a24bf89..4d0a8a2fc 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -132,7 +132,7 @@ doctest:
 
 features.rst:
 	chmod u+w ${SRC}/features.txt
-	echo "PyLint features" > ${SRC}/features.txt
+	echo "Pylint features" > ${SRC}/features.txt
 	echo "===============" >> ${SRC}/features.txt
 	echo "" >> ${SRC}/features.txt
 	echo ".. generated by pylint --full-documentation" >> ${SRC}/features.txt
diff --git a/doc/contribute.rst b/doc/contribute.rst
index 762e3513d..20dd8e4b8 100644
--- a/doc/contribute.rst
+++ b/doc/contribute.rst
@@ -15,16 +15,16 @@ discuss Pylint issues, see below for more information about Pylint's related
 lists.
 
 You can check for already reported bugs, planned features on Pylint's tracker
-web page: http://www.logilab.org/project/pylint
+web page: https://bitbucket.org/logilab/pylint/issues
 
 Notice that if you don't find something you have expected in Pylint's
 tracker page, it may be on the tracker page of one of its dependencies, namely
 astng and common:
 
-* http://www.logilab.org/project/logilab-astng
+* https://bitbucket.org/logilab/astng/issues
 * http://www.logilab.org/project/logilab-common
 
-.. _`tracker page`: http://www.logilab.org/project/pylint
+.. _`tracker page`: https://bitbucket.org/logilab/pylint/issues
 
 Mailing lists
 -------------
@@ -51,17 +51,25 @@ generic forum-fr@logilab.org mailing list:
 Notice though that this list has a very low traffic since most Pylint related
 discussions are done on the python-projects mailing list.
 
+Development
+-----------
 
-Forge
------
+Pylint is developped using the mercurial_ version control system. This is a very
+cool distributed VCS and its usage is very similar to other ones such as cvs or
+subversion (though the distributed feature introduced some different usage
+patterns). See mercurial_ home page for installation on your computer and basic
+usage. Note that it's very easy to send us patches using `hg email` command ;).
 
-Pylint is developped using the mercurial_ distributed version control system.
+You can get the in-development Pylint source code from its bitbucket repository: ::
 
-You can clone Pylint and its dependencies from ::
+  hg clone https://bitbucket.org/logilab/pylint
 
-  hg clone http://www.logilab.org/src/pylint
-  hg clone http://www.logilab.org/src/logilab/astng
-  hg clone http://www.logilab.org/src/logilab/common
+The same is true for Pylint dependencies (if you use Pylint code from the
+repository, you should usually use code from the repository as well for astng
+and logilab-common): ::
+
+  hg clone https://bitbucket.org/logilab/astng
+  hg clone http://hg.logilab.org/logilab/common
 
 .. _mercurial: http://www.selenic.com/mercurial/
 
@@ -69,15 +77,19 @@ Got a patch for Pylint?  There a few steps you must take to make sure your
 patch gets accepted.
 
 * Test your code
+
     * Pylint keeps a set of unit tests in the /test directory. To get your
       patch accepted you must write (or change) a test input file and message
       file in the appropriate input and messages folders.
-    * In the test folder of Pylint run ``./fulltest.sh <python versions>``, make sure
+
+    * In the test folder of pylint run ./fulltest.sh (python version), make sure
       all tests pass before submitting a patch
-* Create a diff file
-    * To create a diff from the command line invoke (from a directory under
-      version control) ::
 
-            hg diff  > <yourname>.diff
+* Add an entry to the ChangeLog describing the change
+
+* Take care of the commit message
+
+* Relate your change to a tracker issue
 
-* E-mail the mailing list with your diff file
+If you don't want to bother with mercurial, you can still create a diff and
+post it to the mailing list or as attachment to a tracker issue.
diff --git a/doc/extend.rst b/doc/extend.rst
index 640ad682f..d8a3700a8 100644
--- a/doc/extend.rst
+++ b/doc/extend.rst
@@ -13,15 +13,15 @@ First, there are two kinds of checkers :
 * ast checkers, which are working on an ast representation of the module
 
 The ast representation used is an extension of the one provided with the
-standard Python distribution in the `compiler package`_. The extension
+standard python distribution in the `ast package`_. The extension
 adds additional information and methods on the tree nodes to ease
-navigation and code introspection.
+navigation and code introspection, as well as compatibility across various
+Python version.
 
 An AST checker is a visitor, and should implement
-visit_<lowered class name>
-leave_<lowered class name>
+`visit_<lowered class name>` and/or `leave_<lowered class name>`
 methods for the nodes it's interested in. To get description of the different
-classes used in an ast tree, look at the `compiler.ast documentation`.
+classes used in an ast tree, look at the `ast package`_ documentation.
 Checkers are ordered by priority. For each module, Pylint's engine:
 
 1. give the module source file as a stream to raw checkers
@@ -33,5 +33,4 @@ Notice that the source code is probably the best source of
 documentation, it should be clear and well documented. Don't hesitate to
 ask for any information on the python-projects mailing list.
 
-.. _`compiler package`: http://docs.python.org/library/compiler
-.. _`compiler.ast documentation`: http://docs.python.org/library/compiler#module-compiler.ast
+.. _`ast package`: http://docs.python.org/2/library/ast.html
diff --git a/doc/features.rst b/doc/features.rst
index 4b8d8077e..6726ba573 100644
--- a/doc/features.rst
+++ b/doc/features.rst
@@ -292,7 +292,7 @@ Messages
   Used when a variable is defined through the "global" statement but no
   assignment to this variable is done.
 :W0603 (global-statement): *Using the global statement*
-  Used when you use the "global" statement to update a global variable. PyLint
+  Used when you use the "global" statement to update a global variable. Pylint
   just try to discourage this usage. That doesn't mean you can not use it !
 :W0604 (global-at-module-level): *Using the global statement at the module level*
   Used when you use the "global" statement at the module level since it has no
@@ -581,10 +581,10 @@ Messages
   to "mcs"), recommended to easily differentiate them from regular instance
   methods.
 :F0202 (method-check-failed): *Unable to check methods signature (%s / %s)*
-  Used when PyLint has been unable to check methods signature compatibility for
+  Used when Pylint has been unable to check methods signature compatibility for
   an unexpected reason. Please report this kind if you don't make sense of it.
 :F0220 (unresolved-interface): *failed to resolve interfaces implemented by %s (%s)*
-  Used when a PyLint as failed to find interfaces implemented by a class
+  Used when a Pylint as failed to find interfaces implemented by a class
 
 
 design checker
@@ -771,7 +771,7 @@ Messages
   Used when another argument than the current class is given as first argument
   of the super builtin.
 :W1001 (property-on-old-class): *Use of "property" on an old style class*
-  Used when PyLint detect the use of the builtin "property" on an old style
+  Used when Pylint detect the use of the builtin "property" on an old style
   class while this is relying on new style classes features
 
 
diff --git a/doc/ide-integration.rst b/doc/ide-integration.rst
index 5645c1a49..3fe56c9d6 100644
--- a/doc/ide-integration.rst
+++ b/doc/ide-integration.rst
@@ -3,14 +3,14 @@
  IDE integration
 =================
 
-To use Pylint with Emacs, see http://www.emacswiki.org/emacs/PythonProgrammingInEmacs#toc8
+To use Pylint with emacs, see http://www.emacswiki.org/emacs/PythonProgrammingInEmacs#toc8
 
-To use Pylint with Vim, see
+To use Pylint with vim, see
 http://www.vim.org/scripts/script.php?script_id=891
 
-To use Pylint with Eclipse, see http://pydev.org
+To use Pylint with eclipse, see http://pydev.org
 
-To use Pylint with Komodo_, see
+To use Pylint with komodo_, see
 http://mateusz.loskot.net/2006/01/15/running-pylint-from-komodo/
 
 To use Pylint with gedit_, see
@@ -21,14 +21,14 @@ http://www.wingware.com/doc/edit/pylint
 
 Pylint is integrated in Eric_ IDE, see the `Project > Check` menu.
 
-Pylint is integrated in Spyder_, see http://packages.python.org/spyder/pylint.html
+Pylint is integrated in spyder_, see http://packages.python.org/spyder/pylint.html
 
 Pylint is integrated in pyscripter_, see the `Tool -> Tools` menu.
 
 .. _Eric: http://eric-ide.python-projects.org/
 .. _pyscripter: http://code.google.com/p/pyscripter/
 .. _pydev: http://pydev.org
-.. _Komodo: http://www.activestate.com/Products/Komodo/
+.. _komodo: http://www.activestate.com/Products/Komodo/
 .. _gedit: http://www.gnome.org/projects/gedit/
 .. _WingIDE: http://www.wingware.com/
 .. _spyder: http://code.google.com/p/spyderlib/
diff --git a/doc/installation.rst b/doc/installation.rst
index fac0c248d..e36e0ce67 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -1,21 +1,20 @@
-
 Installation
 ------------
 
 Dependencies
 ''''''''''''
-Pylint requires the latest `logilab-astng`_ and `logilab-common`_
-packages. It should be compatible with any Python version >= 2.5.
+Pylint requires the latest `astng`_ and `logilab-common`_
+packages. It should be compatible with any python version >= 2.5.
 
-.. _`logilab-astng`: http://www.logilab.org/project/name/astng
-.. _`logilab-common`: http://www.logilab.org/project/name/common
+.. _`astng`: https://bitbucket.org/logilab/astng
+.. _`logilab-common`: http://www.logilab.org/project/logilab-common
 
 
 Distributions
 '''''''''''''
-The source tarball is available at ftp://download.logilab.org/pub/pylint.
+The source tarball is available at http://download.logilab.org/pub/pylint.
 
-You may apt-get a well-tested debian or ubuntu package by adding one of::
+You may apt-get a well-tested Debian or Ubuntu package by adding one of::
 
     deb http://download.logilab.org/production unstable/
     deb http://download.logilab.org/production sid/
@@ -23,7 +22,7 @@ You may apt-get a well-tested debian or ubuntu package by adding one of::
     deb http://download.logilab.org/production lenny/
 
 to your */etc/apt/sources.list* file. Pylint is also available in the
-standard Debian distribution (but add our public debian repository
+standard Debian distribution (but add our public Debian repository
 anyway if you want to get the latest releases and upgrades earlier)
 
 Pylint is also available in Gentoo, Fedora 4, Ubuntu, FreeBSD, Darwin
@@ -32,14 +31,16 @@ Pylint is also available in Gentoo, Fedora 4, Ubuntu, FreeBSD, Darwin
 
 Source distribution installation
 ''''''''''''''''''''''''''''''''
-From the source distribution, extract the tarball, go to the extracted
-directory and simply run ::
+
+Pylint should be easily installable using easyinstall or pip. Though you may
+still install it from the source distribution: extract the tarball, go to the
+extracted directory and simply run ::
 
     python setup.py install
 
 You'll have to install dependencies in a similar way.
 
-Windows users may get valuable information about pylint installation on
+Windows users may get valuable information about Pylint installation on
 `this page`_.
 
 .. _`this page`: http://thinkhole.org/wp/2006/01/16/installing-pylint-on-windows/
@@ -72,7 +73,7 @@ necessary so that the new path statement will take effect when
 autoexec.bat is run), you will be able to invoke Pylint with
 pylint.bat on the command line.
 
-(3) is the best solution. Once done, you can call Pylint at the command
+(3) is the best solution. Once done, you can call pylint at the command
 line without the .bat, just as do non-Windows users by typing: ::
 
   pylint [options] module_or_package
diff --git a/doc/intro.rst b/doc/intro.rst
index f82547450..2b8b17c00 100644
--- a/doc/intro.rst
+++ b/doc/intro.rst
@@ -48,7 +48,7 @@ shouldn't expect Pylint to be totally quiet about your code, so don't
 necessarily be alarmed if it gives you a hell lot of messages for your project!
 
 :Quoting Alexandre Fayolle:
-  My usage pattern for Pylint is to generally run ``pylint -e`` quite often to
+  My usage pattern for Pylint is to generally run ``pylint -E`` quite often to
   get stupid errors flagged before launching an application (or before
   committing). I generally run Pylint with all the bells and whistles
   activated some time before a release, when I want to cleanup the code.
diff --git a/doc/manual.rst b/doc/manual.rst
deleted file mode 100644
index 17daf8dd5..000000000
--- a/doc/manual.rst
+++ /dev/null
@@ -1,687 +0,0 @@
-.. -*- coding: utf-8 -*-
-
-==================
-Pylint User Manual
-==================
-
-:Author: Sylvain Thénault
-:Author: Alexandre Fayolle
-:Organization: Logilab
-
-.. contents::
-
-
-This document is meant to be the reference user manual for Pylint_.  This is a
-work in progress so some sections or parts may be missing (sometimes marked by a
-XXX).  If you think it's lacking some important information, please talk about
-it on the python-projects mailing list (see the `Mailing lists`_ section for
-more information about the list).
-
-.. _Pylint: http://www.pylint.org
-
-
-Introduction
-============
-
-What is pylint?
----------------
-
-Pylint is a tool that checks for errors in python code, tries to enforce a
-coding standard and looks for smelling code. This is similar but nevertheless
-different from what pychecker_ provides, especially since pychecker explicitly
-does not bother with coding style. The default coding style used by Pylint is
-close to `PEP 008`_ (aka `Guido's style guide`_). For more information about
-code smells, refer to Martin Fowler's `refactoring book`_
-
-One important thing to note is that Pylint isn't smarter than you are: it may
-warn you about things that you have conscientiously done. That's for example
-because it tries to detect things that may be dangerous in a context, but maybe
-not in others, or because it checks for some things that you don't care
-about. Generally, you shouldn't expect Pylint to be totally quiet about your
-code, so don't necessarily be alarmed if it gives you a hell lot of messages for
-your proudly(XXX) project ;)
-
-Pylint will display a number of messages as it analyzes the code, as well as
-some statistics about the number of warnings and errors found in different
-files. The messages are classified under various categories such as errors and
-warnings (more below). If you run pylint twice, it will display the statistics
-from the previous run together with the ones from the current run, so that you
-can see if the code has improved or not.
-
-Last but not least, the code is given an overall mark, based on the number an
-severity of the warnings and errors. This has proven to be very motivating for
-programmers.
-
-.. _pychecker: http://pychecker.sf.net
-.. _`PEP 008`: http://www.python.org/dev/peps/pep-0008/
-.. _`Guido's style guide`: http://www.python.org/doc/essays/styleguide.html
-.. _`refactoring book`: http://www.refactoring.com/
-
-Installation
-------------
-
-Dependencies
-''''''''''''
-Pylint requires the latest `astng`_ and `logilab-common`_
-packages. It should be compatible with any python version >= 2.5.
-
-.. _`astng`: https://bitbucket.org/logilab/astng
-.. _`logilab-common`: http://www.logilab.org/project/name/common
-
-
-Distributions
-'''''''''''''
-The source tarball is available at http://download.logilab.org/pub/pylint.
-
-You may apt-get a well-tested Debian or Ubuntu package by adding one of::
-
-    deb http://download.logilab.org/production unstable/
-    deb http://download.logilab.org/production sid/
-    deb http://download.logilab.org/production squeeze/
-    deb http://download.logilab.org/production lenny/
-
-to your */etc/apt/sources.list* file. Pylint is also available in the
-standard Debian distribution (but add our public Debian repository
-anyway if you want to get the latest releases and upgrades earlier)
-
-Pylint is also available in Gentoo, Fedora 4, Ubuntu, FreeBSD, Darwin
-(and maybe others, if you know about more OSes, please drop us a note!).
-
-
-Source distribution installation
-''''''''''''''''''''''''''''''''
-
-Pylint should be easily installable using easyinstall or pip. Though you may
-still install it from the source distribution: extract the tarball, go to the
-extracted directory and simply run ::
-
-    python setup.py install
-
-You'll have to install dependencies in a similar way.
-
-Windows users may get valuable information about Pylint installation on
-`this page`_.
-
-.. _`this page`: http://thinkhole.org/wp/2006/01/16/installing-pylint-on-windows/
-
-
-Note for Windows users
-''''''''''''''''''''''
-
-On Windows, once you have installed Pylint, the command line usage is ::
-
-  pylint.bat [options] module_or_package
-
-But this will only work if *pylint.bat* is either in the current
-directory, or on your system path. (*setup.py* install install *python.bat*
-to the *Scripts* subdirectory of your Python installation -- e.g.
-C:\Python24\Scripts.) You can do any of the following to solve this:
-
-1. change to the appropriate directory before running pylint.bat
-
-2. add the Scripts directory to your path statement in your autoexec.bat
-   file (this file is found in the root directory of your boot-drive)
-
-3. create a 'redirect' batch file in a directory actually on your
-   systems path
-
-To effect (2), simply append the appropriate directory name to the PATH=
-statement in autoexec.bat. Be sure to use the Windows directory
-separator of ';' between entries. Then, once you have rebooted (this is
-necessary so that the new path statement will take effect when
-autoexec.bat is run), you will be able to invoke Pylint with
-pylint.bat on the command line.
-
-(3) is the best solution. Once done, you can call pylint at the command
-line without the .bat, just as do non-Windows users by typing: ::
-
-  pylint [options] module_or_package
-
-To effect option (3), simply create a plain text file pylint.bat with
-the single line: ::
-
-  C:\PythonDirectory\Scripts\pylint.bat
-
-(where PythonDirectory is replaced by the actual Python installation
-directory on your system -- e.g. C:\Python24\Scripts\pylint.bat).
-
-
-Invoking pylint
----------------
-
-Pylint is meant to be called from the command line. The usage is ::
-
-   pylint [options] module_or_package
-
-You should give pylint the name of a Python package or module. Pylint
-will ``import`` this package or module, so you should pay attention to
-your ``PYTHONPATH``, since it is a common error to analyze an
-installed version of a module instead of the development version.
-
-It is also possible to analyze python files, with a few
-restriction. The thing to keep in mind is that Pylint will try to
-convert the file name to a module name, and only be able to process
-the file if it succeeds.  ::
-
-  pylint mymodule.py
-
-should always work since the current working
-directory is automatically added on top of the python path ::
-
-  pylint directory/mymodule.py
-
-will work if "directory" is a python package (i.e. has an __init__.py
-file) or if "directory" is in the python path.
-
-For more details on this see the Frequently Asked Questions.
-
-You can also start a thin gui around Pylint (require TkInter) by
-typing ::
-
-  pylint-gui
-
-This should open a window where you can enter the name of the package
-or module to check, at Pylint messages will be displayed in the user
-interface.
-
-It is also possible to call Pylint from an other Python program,
-thanks to ``py_run()`` function in ``lint`` module,
-assuming Pylint options are stored in ``pylint_options`` string, as ::
-
-  from pylint import epylint as lint
-  lint.py_run( pylint_options)
-
-To silently run Pylint on a ``module_name.py`` module,
-and get its standart output and error::
-
-  from pylint import epylint as lint
-  (pylint_stdout, pylint_stderr) = lint.py_run( 'module_name.py', True)
-
-
-Pylint output
--------------
-
-The default format for the output is raw text. But passing pylint the
-``--output-format=html`` or ``-f html`` option will produce an HTML document.
-
-There are several sections in Pylint's output.
-
-Source code analysis section
-''''''''''''''''''''''''''''
-For each python module,
-Pylint will first display a few '*' characters followed by the name
-of the module. Then, a number of messages with the following
-format: ::
-
-  MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
-
-You can get another output format, useful since it's recognized by
-most editors or other development tools using the ``--output-format=parseable``
-option.
-
-The message type can be:
-
-  * [R]efactor for a "good practice" metric violation
-  * [C]onvention for coding standard violation
-  * [W]arning for stylistic problems, or minor programming issues
-  * [E]rror for important programming issues (i.e. most probably bug)
-  * [F]atal for errors which prevented further processing
-
-Sometimes the line of code which caused the error is displayed with
-a caret pointing to the error. This may be generalized in future
-versions of Pylint.
-
-Example (extracted from a run of Pylint on itself...):
-
-::
-
-  ************* Module pylint.checkers.format
-  W: 50: Too long line (86/80)
-  W:108: Operator not followed by a space
-       print >>sys.stderr, 'Unable to match %r', line
-              ^
-  W:141: Too long line (81/80)
-  W: 74:searchall: Unreachable code
-  W:171:FormatChecker.process_tokens: Redefining built-in (type)
-  W:150:FormatChecker.process_tokens: Too many local variables (20/15)
-  W:150:FormatChecker.process_tokens: Too many branches (13/12)
-
-
-Reports section
-'''''''''''''''
-Following the analysis message, Pylint will display a set of reports,
-each one focusing on a particular aspect of the project, such as number
-of messages by categories, modules dependencies...
-
-For instance, the metrics report displays summaries gathered from the
-current run.
-
-  * the number of processed modules
-  * for each module, the percentage of errors and warnings
-  * the total number of errors and warnings
-  * percentage of classes, functions and modules with docstrings, and
-    a comparison from the previous run
-  * percentage of classes, functions and modules with correct name
-    (according to the coding standard), and a comparison from the
-    previous run
-  * a list of external dependencies found in the code, and where they appear
-
-Also, a global evaluation for the code is computed, and an
-optional witty comment is displayed (if ``--comment=y`` was
-specified on the command line).
-
-
-
-Command line options
---------------------
-
-First of all, we have two basic (but useful) options.
-
---version             show program's version number and exit
--h, --help            show help about the command line options
-
-Pylint is architectured around several checkers. By default all
-checkers are enabled. You can disable a specific checker or some of its
-messages or messages categories by specifying
-``--disable=<id>``. A more general disable can be enabled with
-or disable all checkers using
-``--enable=w<id>``. See the list of available features_ for a
-description of provided checkers with their functionalities.
-The ``--disable`` and ``--enable`` options can be used with comma separated lists
-mixing checkers, message ids and categories like ``-d C,W,E0611,design``
-
-It is possible to disable all messages with ``--disable=all``. This is
-useful to enable only a few checkers or a few messages by first
-disabling everything, and then re-enabling only what you need. 
-
-Each checker has some specific options, which can take either a yes/no
-value, an integer, a python regular expression, or a comma separated
-list of values (which are generally used to override a regular
-expression in special cases). For a full list of options, use ``--help``
-
-Specifying all the options suitable for your setup and coding
-standards can be tedious, so it is possible to use a rc file to
-specify the default values. Pylint looks for /etc/pylintrc and
-~/.pylintrc. The ``--generate-rcfile`` option will generate a
-commented configuration file according to the current configuration on
-standard output and exit. You can put other options before this one to
-use them in the configuration, or start with the default values and
-hand tune the configuration.
-
-Other useful global options include:
-
---zope                   Initialize Zope products before starting
---ignore=file            Add <file> (may be a directory) to the black
-                          list. It should be a base name, not a path.
-                          You may set this option multiple times.
---statistics=y_or_n      Compute statistics on collected data.
---persistent=y_or_n      Pickle collected data for later comparisons.
---comment=y_or_n         Add a comment according to your evaluation note.
---output-format=format   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.
---list-msgs              Generate pylint's messages.
---full-documentation     Generate pylint's full documentation, in reST format.
---include_ids=y_or_n     Show numeric ids of messages (like 'C0301')
---symbols=y_or_n         Show symbolic ids of messsages (like 'line-too-long')
-
-
-.. _features: features.html
-
-Daily Pylint usage
-------------------
-What Pylint says is not to be taken as gospel. While getting as
-few false positives for errors as possible is a goal for us -- and
-python makes it hard enough, it is not the case for warnings.
-
-:Quoting Alexandre Fayolle:
-  My usage pattern for Pylint is to generally run `pylint -e` quite often to
-  get stupid errors flagged before launching an application (or before
-  committing). I generally run pylint with all the bells and whistles
-  activated some time before a release, when I want to cleanup the code.
-  And when I do that I simply ignore tons of the false warnings (and I
-  can do that without being driven mad by this dumb program which is not
-  smart enough to understand the dynamicity of Python because I only run
-  it once or twice a week in this mode)
-
-:Quoting Marteen Ter Huurne:
-  In our project we just accepted that we have to make some modifications in our
-  code to please Pylint:
-
-  - stick to more naming conventions (unused variables ending in underscores,
-    mix-in class names ending in "Mixin")
-  - making all abstract methods explicit (rather than just not defining them in
-    the superclass)
-  - for messages which are useful in general, but not in a specific case: add "#
-    pylint: disable=X0123" comments
-  - for Pylint bugs: add "#pylint: disable=X0123" comments
-  - for Pylint limitations: add "#pylint: disable=X0123" comments
-    (for instance Twisted's modules create a lot of definitions dynamically so
-    Pylint does not know about them)
-
-  The effort is worth it, since Pylint helps us a lot in keeping the code clean
-  and finding errors early. Although most errors found by Pylint would also be
-  found by the regression tests, by fixing them before committing, we save time.
-  And our regression tests do not cover all code either, just the most complex
-  parts.
-
-
-Bug reports, feedback
----------------------
-You think you have found a bug in Pylint? Well, this may be the case
-since Pylint is under development. Please take the time to send a bug
-report to python-projects@logilab.org if you've not found it already reported on
-the `tracker page`_. This mailing list is also a nice place to
-discuss Pylint issues, see below for more information about Pylint's related
-lists.
-
-You can check for already reported bugs, planned features on Pylint's tracker
-web page: https://bitbucket.org/logilab/pylint/issues
-
-Notice that if you don't find something you have expected in Pylint's
-tracker page, it may be on the tracker page of one of its dependencies, namely
-astng and common:
-
-* https://bitbucket.org/logilab/astng/issues
-* http://www.logilab.org/project/name/logilab-common
-
-.. _`tracker page`: https://bitbucket.org/logilab/pylint/issues
-
-Mailing lists
--------------
-Use the python-projects@logilab.org mailing list for anything related
-to Pylint. This is in most cases better than sending an email directly
-to the author, since others will benefit from the exchange, and you'll
-be more likely answered by someone subscribed to the list. This is a
-moderated mailing list, so if you're not subscribed email you send will have to
-be validated first before actually being sent on the list.
-
-You can subscribe to this mailing list at
-http://lists.logilab.org/mailman/listinfo/python-projects
-
-Archives are available at
-http://lists.logilab.org/pipermail/python-projects/
-
-If you prefer speaking French instead of English, you can use the
-generic forum-fr@logilab.org mailing list:
-
-* (un)subscribe: http://lists.logilab.org/mailman/listinfo/forum-fr
-* archives: http://lists.logilab.org/pipermail/forum-fr
-
-Notice though that this list has a very low traffic since most Pylint related
-discussions are done on the python-projects mailing list.
-
-
-
-Advanced usage
-==============
-
-Base configuration
-------------------
-
-To be written...
-
-Environment
------------
-
-To be written...
-
-Messages control
-----------------
-
-An example available from the examples directory:
-
-.. sourcecode:: python
-
-    """pylint option block-disable"""
-
-    __revision__ = None
-
-    class Foo(object):
-        """block-disable test"""
-
-        def __init__(self):
-            pass
-
-        def meth1(self, arg):
-            """this issues a message"""
-            print self
-
-        def meth2(self, arg):
-            """and this one not"""
-            # pylint: disable=W0613
-            print self\
-                  + "foo"
-
-        def meth3(self):
-            """test one line disabling"""
-            # no error
-            print self.bla # pylint: disable=E1101
-            # error
-            print self.blop
-
-        def meth4(self):
-            """test re-enabling"""
-            # pylint: disable=E1101
-            # no error
-            print self.bla
-            print self.blop
-            # pylint: enable=E1101
-            # error
-            print self.blip
-
-        def meth5(self):
-            """test IF sub-block re-enabling"""
-            # pylint: disable=E1101
-            # no error
-            print self.bla
-            if self.blop:
-                # pylint: enable=E1101
-                # error
-                print self.blip
-            else:
-                # no error
-                print self.blip
-            # no error
-            print self.blip
-
-        def meth6(self):
-            """test TRY/EXCEPT sub-block re-enabling"""
-            # pylint: disable=E1101
-            # no error
-            print self.bla
-            try:
-                 pylint: enable=E1101
-                # error
-                print self.blip
-            except UndefinedName: # pylint: disable=E0602
-                # no error
-                print self.blip
-            # no error
-            print self.blip
-
-        def meth7(self):
-            """test one line block opening disabling"""
-            if self.blop: # pylint: disable=E1101
-                # error
-                print self.blip
-            else:
-                # error
-                print self.blip
-            # error
-            print self.blip
-
-
-        def meth8(self):
-            """test late disabling"""
-            # error
-            print self.blip
-            # pylint: disable=E1101
-            # no error
-            print self.bla
-            print self.blop
-
-
-
-About analysis
-==============
-
-Pylint heuristics
------------------
-
-To be written...
-
-About astng inference
----------------------
-
-To be written...
-
-
-
-Enhancing Pylint
-================
-
-Writing your own checker
-------------------------
-You can find some simple examples in the examples
-directory of the distribution (custom.py and custom_raw.py). I'll try to
-quickly explain the essentials here.
-
-First, there are two kinds of checkers :
-* raw checkers, which are analysing each module as a raw file stream
-* ast checkers, which are working on an ast representation of the module
-
-The ast representation used is an extension of the one provided with the
-standard python distribution in the `ast package`_. The extension
-adds additional information and methods on the tree nodes to ease
-navigation and code introspection, as well as compatibility across various
-Python version.
-
-An AST checker is a visitor, and should implement
-`visit_<lowered class name>` and/or `leave_<lowered class name>`
-methods for the nodes it's interested in. To get description of the different
-classes used in an ast tree, look at the `ast package`_ documentation.
-Checkers are ordered by priority. For each module, Pylint's engine:
-
-1. give the module source file as a stream to raw checkers
-2. get an ast representation for the module
-3. make a depth first descent of the tree, calling visit_<> on each AST
-   checker when entering a node, and living_<> on the back traversal
-
-Notice that the source code is probably the best source of
-documentation, it should be clear and well documented. Don't hesitate to
-ask for any information on the python-projects mailing list.
-
-.. _`ast package`: http://docs.python.org/2/library/ast.html
-
-
-Contribute !
-------------
-All our software is developped using the mercurial_ version control
-system. This is a very cool distributed vcs and its usage is very similar to
-other ones such as cvs or subversion (though the distributed feature introduced
-some different usage patterns). See mercurial home page for installation on
-your computer and basic usage. Note that it's very easy to send us patches using
-`hg email` command ;).
-
-You can get the in-development Pylint source code from its bitbucket repository:
-
-https://bitbucket.org/logilab/pylint
-
-The same is true for Pylint dependencies (if you use Pylint code from the
-repository, you should usually use code from the repository as well for astng
-and common):
-
-https://bitbucket.org/logilab/astng
-http://www.logilab.org/src/logilab/common
-
-.. _mercurial: http://www.selenic.com/mercurial/
-
-Contribution Instructions
---------------------------
-
-Got a patch for Pylint?  There a few steps you must take to make sure your
-patch gets accepted.
-
-* Test your code
-    * Pylint keeps a set of unit tests in the /test directory. To get your
-      patch accepted you must write (or change) a test input file and message
-      file in the appropriate input and messages folders.
-    * In the test folder of pylint run ./fulltest.sh (python version), make sure
-      all tests pass before submitting a patch
-
-* Create a diff file
-    * To create a diff from the command line invoke (from a directory under
-      version control) ::
-
-            hg diff  > <yourname>.diff
-
-* E-mail the mailing list with your diff file
-
-Other information
-=================
-
-IDE integration
----------------
-
-To use Pylint with emacs, see http://www.emacswiki.org/emacs/PythonProgrammingInEmacs#toc8
-
-To use Pylint with vim, see
-http://www.vim.org/scripts/script.php?script_id=891
-
-To use Pylint with eclipse, see http://pydev.org
-
-To use Pylint with komodo_, see
-http://mateusz.loskot.net/2006/01/15/running-pylint-from-komodo/
-
-To use Pylint with gedit_, see
-http://live.gnome.org/Gedit/PylintPlugin
-
-To use Pylint with WingIDE_, see
-http://www.wingware.com/doc/edit/pylint
-
-Pylint is integrated in Eric_ IDE, see the `Project > Check` menu.
-
-Pylint is integrated in spyder_, see http://packages.python.org/spyder/pylint.html
-
-Pylint is integrated in pyscripter_, see the `Tool -> Tools` menu.
-
-.. _Eric: http://eric-ide.python-projects.org/
-.. _pyscripter: http://code.google.com/p/pyscripter/
-.. _pydev: http://pydev.org
-.. _komodo: http://www.activestate.com/Products/Komodo/
-.. _gedit: http://www.gnome.org/projects/gedit/
-.. _WingIDE: http://www.wingware.com/
-.. _spyder: http://code.google.com/p/spyderlib/
-
-
-Some projects using Pylint
---------------------------
-The following projects are known to use Pylint to help develop better
-code:
-
-* OSAF Chandler (http://www.osafoundation.org/)
-* Xen (http://www.xensource.com/)
-* CPS (http://www.nuxeo.org)
-* ERP5 (http://www.erp5.org/)
-* pyxmpp (http://pyxmpp.jabberstudio.org/)
-* mercurial
-* eXe (http://exelearning.org/)
-* PrimaGIS (http://www.primagis.org)
-* python-cdd (https://projetos.ossystems.com.br/projects/python-cdd)
-* CDSWare (http://cdsware.cern.ch/)
-* ASE (http://dcwww.camp.dtu.dk/campos/ASE/intro.html)
-* RunJob (http://projects.fnal.gov/runjob/)
-* Slugathon (http://slugathon.python-hosting.com/)
-* Topographica (http://topographica.org/Home/index.html) (at least they intend to do so)
-* http://browsershots.org
-* many more...
-
-Also notice that the CheeseCake_ kwalitee reporting tool uses Pylint to
-analyze the source code.
-
-.. _CheeseCake: http://cheesecake.sourceforge.net/
-
-
-
-
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
deleted file mode 100644
index e9de68c4e..000000000
--- a/doc/quickstart.rst
+++ /dev/null
@@ -1,212 +0,0 @@
-=================
-Pylint Quickstart
-=================
-
-:Author: Alexandre Fayolle
-:Organization: Logilab
-
-.. contents::
-
-
-This document is meant to get you started with Pylint. It assumes that
-you have installed Pylint following the instructions in the README
-document found in the source documentation.
-
-
-What is Pylint?
----------------
-
-Pylint is a tool that checks for errors in python code, tries to
-enforce a coding standard and looks for bad code smells. This is
-similar but nevertheless different from what pychecker_ provides,
-especially since pychecker explicitly does not bother with coding
-style. The default coding style used by Pylint is close to
-`Guido's style guide`_. For more information about code smells, refer
-to Martin Fowler's `refactoring book`_
-
-Pylint will display a number of errors and warnings as it analyzes the
-code, as well as some statistics about the number of warnings and
-errors found in different files. If you run pylint twice, it will
-display the statistics from the previous run together with the ones
-from the current run, so that you can see if the code has improved or
-not.
-
-Last but not least, the code is given an overall mark, based on the
-number an severity of the warnings and errors. This has proven to
-be very motivating for programmers.
-
-
-Invoking pylint
----------------
-
-Pylint is meant to be called from the command line. The usage is ::
-
-   pylint [options] module_or_package
-
-You should give pylint the name of a Python package or module. Pylint
-will ``import`` this package or module, so you should pay attention to
-your ``PYTHONPATH``, since it is a common error to analyze an
-installed version of a module instead of the development version.
-
-It is also possible to analyze python files, with a few
-restrictions. The thing to keep in mind is that Pylint will try to
-convert the file name to a module name, and only be able to process
-the file if it succeeds.  ::
-
-  pylint mymodule.py
-
-should always works since the current working
-directory is automatically added on top  of the python path ::
-
-  pylint directory/mymodule.py
-
-will work if "directory" is a python package (i.e. has an __init__.py
-file) or if "directory" is in the python path.
-
-For more details on this see the FAQ_.
-
-You can also start a thin gui around Pylint (require TkInter) by
-typing ::
-
-  pylint-gui
-
-This should open a window where you can enter the name of the package
-or module to check, at Pylint messages will be displayed in the user
-interface.
-
-
-Pylint output
--------------
-
-The default format for the output is raw text. But passing pylint the
-``--output-format=html`` or ``-f html`` option will produce an HTML document.
-
-There are several sections in Pylint's output.
-
-Source code analysis section
-''''''''''''''''''''''''''''
-
-For each python module,
-Pylint will first display a few '*' characters followed by the name
-of the module. Then, a number of messages with the following
-format: ::
-
-  MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
-
-You can get another output format, useful since it's recognized by
-most editors or other development tools using the ``--output-format=parseable``
-option.
-
-The message type can be:
-
-  * [R]efactor for a "good practice" metric violation
-  * [C]onvention for coding standard violation
-  * [W]arning for stylistic problems, or minor programming issues
-  * [E]rror for important programming issues (i.e. most probably bug)
-  * [F]atal for errors which prevented further processing
-
-Sometimes the line of code which caused the error is displayed with
-a caret pointing to the error. This may be generalized in future
-versions of Pylint.
-
-Example (extracted from a run of pylint on itself...):
-
-::
-
-  ************* Module pylint.checkers.format
-  W: 50: Too long line (86/80)
-  W:108: Operator not followed by a space
-       print >>sys.stderr, 'Unable to match %r', line
-              ^
-  W:141: Too long line (81/80)
-  W: 74:searchall: Unreachable code
-  W:171:FormatChecker.process_tokens: Redefining built-in (type)
-  W:150:FormatChecker.process_tokens: Too many local variables (20/15)
-  W:150:FormatChecker.process_tokens: Too many branches (13/12)
-
-
-Reports section
-'''''''''''''''
-
-Following the analysis message, Pylint will display a set of reports,
-each one focusing on a particular aspect of the project, such as number
-of messages by categories, modules dependencies...
-
-For instance, the metrics report displays summaries gathered from the
-current run.
-
-  * the number of processed modules
-  * for each module, the percentage of errors and warnings
-  * the total number of errors and warnings
-  * percentage of classes, functions and modules with docstrings, and
-    a comparison from the previous run
-  * percentage of classes, functions and modules with correct name
-    (according to the coding standard), and a comparison from the
-    previous run
-  * a list of external dependencies found in the code, and where they appear
-
-Also, a global evaluation for the code is computed, and an
-optional witty comment is displayed (if ``--comment=y`` was
-specified on the command line).
-
-
-Command line options
---------------------
-
-First of all, we have two basic (but useful) options.
-
---version             show program's version number and exit
--h, --help            show help about the command line options
-
-Pylint is architectured around several checkers. By default all
-checkers are enabled. You can disable a specific checker or some of its
-messages or messages categories by specifying
-``--disable=<id>``. If you want to enable only some checkers or some
-message ids, first use ``--disable=all`` then
-``--enable=<id>`` with <id> being a comma separated list of checker
-names and message identifiers. See the list of available features_ for a
-description of provided checkers with their functionalities.
-The ``--disable`` and ``--enable`` options can be used with comma separated lists
-mixing checkers, message ids and categories like ``-d C,W,E0611,design``
-
-Each checker has some specific options, which can take either a yes/no
-value, an integer, a python regular expression, or a comma separated
-list of values (which are generally used to override a regular
-expression in special cases). For a full list of options, use ``--help``
-
-Specifying all the options suitable for your setup and coding
-standards can be tedious, so it is possible to use a rc file to
-specify the default values. Pylint looks for /etc/pylintrc and
-~/.pylintrc. The ``--generate-rcfile`` option will generate a
-commented configuration file according to the current configuration on
-standard output and exit. You can put other options before this one to
-use them in the configuration, or start with the default values and
-hand tune the configuration.
-
-Other useful global options include:
-
---zope                   Initialize Zope products before starting
---ignore=file            Add <file> (may be a directory) to the black
-                         list. It should be a base name, not a path.
-                         You may set this option multiple times.
---statistics=y_or_n      Compute statistics on collected data.
---persistent=y_or_n      Pickle collected data for later comparisons.
---comment=y_or_n         Add a comment according to your evaluation note.
---output-format=<format> 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.
-
-Bug reports
------------
-
-You think you have found a bug in Pylint? Well, this may be the case
-since Pylint is under development. Please take the time to send a bug
-report to python-projects@logilab.org. This mailing list is also a
-nice place to discuss Pylint issues.
-
-
-.. _pychecker: http://pychecker.sf.net
-.. _features: features.html
-.. _FAQ: FAQ.html
-.. _`Guido's style guide`: http://www.python.org/doc/essays/styleguide.html
-.. _`refactoring book`: http://www.refactoring.com/
diff --git a/doc/wiki.rst b/doc/wiki.rst
index 346a71ceb..154957088 100644
--- a/doc/wiki.rst
+++ b/doc/wiki.rst
@@ -1,5 +1,5 @@
 ======================
- PyLint messages Wiki
+ Pylint messages Wiki
 ======================
 
 http://pylint-messages.wikidot.com/