2007-08-15 14:28:22 +00:00
|
|
|
.. _reporting-bugs:
|
|
|
|
|
|
|
|
|
|
************************
|
|
|
|
|
Reporting Bugs in Python
|
|
|
|
|
************************
|
|
|
|
|
|
|
|
|
|
Python is a mature programming language which has established a reputation for
|
|
|
|
|
stability. In order to maintain this reputation, the developers would like to
|
|
|
|
|
know of any deficiencies you find in Python.
|
|
|
|
|
|
|
|
|
|
If you find errors in the documentation, please use either the "Add a comment"
|
|
|
|
|
or the "Suggest a change" features of the relevant page in the most recent
|
|
|
|
|
online documentation at http://docs.python.org/.
|
|
|
|
|
|
|
|
|
|
All other bug reports should be submitted via the Python Bug Tracker
|
|
|
|
|
(http://bugs.python.org/). The bug tracker offers a Web form which allows
|
|
|
|
|
pertinent information to be entered and submitted to the developers.
|
|
|
|
|
|
|
|
|
|
The first step in filing a report is to determine whether the problem has
|
|
|
|
|
already been reported. The advantage in doing so, aside from saving the
|
|
|
|
|
developers time, is that you learn what has been done to fix it; it may be that
|
|
|
|
|
the problem has already been fixed for the next release, or additional
|
|
|
|
|
information is needed (in which case you are welcome to provide it if you can!).
|
|
|
|
|
To do this, search the bug database using the search box on the top of the page.
|
|
|
|
|
|
|
|
|
|
If the problem you're reporting is not already in the bug tracker, go back to
|
|
|
|
|
the Python Bug Tracker. If you don't already have a tracker account, select the
|
|
|
|
|
"Register" link in the sidebar and undergo the registration procedure.
|
|
|
|
|
Otherwise, if you're not logged in, enter your credentials and select "Login".
|
|
|
|
|
It is not possible to submit a bug report anonymously.
|
|
|
|
|
|
|
|
|
|
Being now logged in, you can submit a bug. Select the "Create New" link in the
|
|
|
|
|
sidebar to open the bug reporting form.
|
|
|
|
|
|
|
|
|
|
The submission form has a number of fields. For the "Title" field, enter a
|
|
|
|
|
*very* short description of the problem; less than ten words is good. In the
|
|
|
|
|
"Type" field, select the type of your problem; also select the "Component" and
|
|
|
|
|
"Versions" to which the bug relates.
|
|
|
|
|
|
|
|
|
|
In the "Change Note" field, describe the problem in detail, including what you
|
|
|
|
|
expected to happen and what did happen. Be sure to include whether any
|
|
|
|
|
extension modules were involved, and what hardware and software platform you
|
|
|
|
|
were using (including version information as appropriate).
|
|
|
|
|
|
|
|
|
|
Each bug report will be assigned to a developer who will determine what needs to
|
|
|
|
|
be done to correct the problem. You will receive an update each time action is
|
|
|
|
|
taken on the bug.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. seealso::
|
|
|
|
|
|
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r60151 | christian.heimes | 2008-01-21 14:11:15 +0100 (Mon, 21 Jan 2008) | 1 line
A bunch of header files were not listed as dependencies for object files. Changes to files like Parser/parser.h weren't picked up by make.
........
r60152 | georg.brandl | 2008-01-21 15:16:46 +0100 (Mon, 21 Jan 2008) | 3 lines
#1087741: make mmap.mmap the type of mmap objects, not a
factory function. Allow it to be subclassed.
........
r60153 | georg.brandl | 2008-01-21 15:18:14 +0100 (Mon, 21 Jan 2008) | 2 lines
mmap is an extension module.
........
r60154 | georg.brandl | 2008-01-21 17:28:13 +0100 (Mon, 21 Jan 2008) | 2 lines
Fix example.
........
r60155 | georg.brandl | 2008-01-21 17:34:07 +0100 (Mon, 21 Jan 2008) | 2 lines
#1555501: document plistlib and move it to the general library.
........
r60156 | georg.brandl | 2008-01-21 17:36:00 +0100 (Mon, 21 Jan 2008) | 2 lines
Add a stub for bundlebuilder documentation.
........
r60157 | georg.brandl | 2008-01-21 17:46:58 +0100 (Mon, 21 Jan 2008) | 2 lines
Removing bundlebuilder docs again -- it's not to be used anymore (see #779825).
........
r60158 | georg.brandl | 2008-01-21 17:51:51 +0100 (Mon, 21 Jan 2008) | 2 lines
#997912: acknowledge nested scopes in tutorial.
........
r60159 | vinay.sajip | 2008-01-21 18:02:26 +0100 (Mon, 21 Jan 2008) | 1 line
Fix: #1836: Off-by-one bug in TimedRotatingFileHandler rollover calculation. Patch thanks to Kathryn M. Kowalski.
........
r60161 | georg.brandl | 2008-01-21 18:13:03 +0100 (Mon, 21 Jan 2008) | 2 lines
Adapt pydoc to new doc URLs.
........
r60162 | georg.brandl | 2008-01-21 18:17:00 +0100 (Mon, 21 Jan 2008) | 2 lines
Fix old link.
........
r60163 | georg.brandl | 2008-01-21 18:22:06 +0100 (Mon, 21 Jan 2008) | 2 lines
#1726198: replace while 1: fp.readline() with file iteration.
........
r60164 | georg.brandl | 2008-01-21 18:29:23 +0100 (Mon, 21 Jan 2008) | 2 lines
Clarify $ behavior in re docstring. #1631394.
........
r60165 | vinay.sajip | 2008-01-21 18:39:22 +0100 (Mon, 21 Jan 2008) | 1 line
Minor documentation change - hyperlink tidied up.
........
r60166 | georg.brandl | 2008-01-21 18:42:40 +0100 (Mon, 21 Jan 2008) | 2 lines
#1530959: change distutils build dir for --with-pydebug python builds.
........
r60167 | vinay.sajip | 2008-01-21 19:16:05 +0100 (Mon, 21 Jan 2008) | 1 line
Updated to include news on recent logging fixes and documentation changes.
........
r60168 | georg.brandl | 2008-01-21 19:35:49 +0100 (Mon, 21 Jan 2008) | 3 lines
Issue #1882: when compiling code from a string, encoding cookies in the
second line of code were not always recognized correctly.
........
r60170 | georg.brandl | 2008-01-21 19:36:51 +0100 (Mon, 21 Jan 2008) | 2 lines
Add NEWS entry for #1882.
........
r60172 | georg.brandl | 2008-01-21 19:41:24 +0100 (Mon, 21 Jan 2008) | 2 lines
Use original location of document, which has translations.
........
r60173 | walter.doerwald | 2008-01-21 21:18:04 +0100 (Mon, 21 Jan 2008) | 2 lines
Follow PEP 8 in module docstring.
........
r60175 | georg.brandl | 2008-01-21 21:20:53 +0100 (Mon, 21 Jan 2008) | 2 lines
Adapt to latest doctools refactoring.
........
2008-01-21 20:36:10 +00:00
|
|
|
`How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
|
2007-08-15 14:28:22 +00:00
|
|
|
Article which goes into some detail about how to create a useful bug report.
|
|
|
|
|
This describes what kind of information is useful and why it is useful.
|
|
|
|
|
|
|
|
|
|
`Bug Writing Guidelines <http://www.mozilla.org/quality/bug-writing-guidelines.html>`_
|
|
|
|
|
Information about writing a good bug report. Some of this is specific to the
|
|
|
|
|
Mozilla project, but describes general good practices.
|
|
|
|
|
|