Mercurial > cpython-lru_cache-weakref

annotate Doc/bugs.rst @ 79675:c0a2294de787 2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Issue #16199: Backport 2to3 typo fix from 3.2.
author Chris Jerdonek <chris.jerdonek@gmail.com>
date Thu, 11 Oct 2012 16:15:46 -0700
parents e9f517f8ee87
children b39270c6b8d1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
1 .. _reporting-bugs:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
2
60878
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
3 **************
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
4 Reporting Bugs
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
5 **************
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
6
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
7 Python is a mature programming language which has established a reputation for
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
8 stability. In order to maintain this reputation, the developers would like to
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
9 know of any deficiencies you find in Python.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
10
60878
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
11
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
12 Documentation bugs
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
13 ==================
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
14
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
15 If you find a bug in this documentation or would like to propose an improvement,
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
16 please send an e-mail to docs@python.org describing the bug and where you found
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
17 it. If you have a suggestion how to fix it, include that as well.
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
18
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
19 docs@python.org is a mailing list run by volunteers; your request will be
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
20 noticed, even if it takes a while to be processed.
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
21
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
22 Of course, if you want a more persistent record of your issue, you can use the
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
23 issue tracker for documentation bugs as well.
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
24
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
25
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
26 Using the Python issue tracker
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
27 ==============================
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
28
a8e093a24094 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
Georg Brandl <georg@python.org>
parents: 59182
diff changeset
29 Bug reports for Python itself should be submitted via the Python Bug Tracker
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
30 (http://bugs.python.org/). The bug tracker offers a Web form which allows
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
31 pertinent information to be entered and submitted to the developers.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
32
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
33 The first step in filing a report is to determine whether the problem has
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
34 already been reported. The advantage in doing so, aside from saving the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
35 developers time, is that you learn what has been done to fix it; it may be that
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
36 the problem has already been fixed for the next release, or additional
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
37 information is needed (in which case you are welcome to provide it if you can!).
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
38 To do this, search the bug database using the search box on the top of the page.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
39
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
40 If the problem you're reporting is not already in the bug tracker, go back to
59182
d62bdd84df0a Link to http://www.python.org/dev/workflow/ from bugs page.
Georg Brandl <georg@python.org>
parents: 54350
diff changeset
41 the Python Bug Tracker and log in. If you don't already have a tracker account,
d62bdd84df0a Link to http://www.python.org/dev/workflow/ from bugs page.
Georg Brandl <georg@python.org>
parents: 54350
diff changeset
42 select the "Register" link or, if you use OpenID, one of the OpenID provider
d62bdd84df0a Link to http://www.python.org/dev/workflow/ from bugs page.
Georg Brandl <georg@python.org>
parents: 54350
diff changeset
43 logos in the sidebar. It is not possible to submit a bug report anonymously.
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
44
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
45 Being now logged in, you can submit a bug. Select the "Create New" link in the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
46 sidebar to open the bug reporting form.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
47
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
48 The submission form has a number of fields. For the "Title" field, enter a
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
49 *very* short description of the problem; less than ten words is good. In the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
50 "Type" field, select the type of your problem; also select the "Component" and
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
51 "Versions" to which the bug relates.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
52
46664
031dfe455585 Merged revisions 62425-62429,62434-62436,62441,62444,62446-62448,62450-62455,62463,62465-62466,62469,62474,62476-62478,62480,62485,62492,62497-62498,62500,62507,62513-62514,62516,62521,62531,62535,62545-62546,62548-62551,62553-62559,62569,62574,62577,62593,62595,62604-62606,62608,62616,62626-62627,62636,62638,62644-62645,62647-62648,62651-62653,62656,62661,62663,62680,62686-62687,62696,62699-62703,62711 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45764
diff changeset
53 In the "Comment" field, describe the problem in detail, including what you
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
54 expected to happen and what did happen. Be sure to include whether any
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
55 extension modules were involved, and what hardware and software platform you
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
56 were using (including version information as appropriate).
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
57
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
58 Each bug report will be assigned to a developer who will determine what needs to
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
59 be done to correct the problem. You will receive an update each time action is
74210
e9f517f8ee87 fix some broken URLs
Sandro Tosi <sandro.tosi@gmail.com>
parents: 60878
diff changeset
60 taken on the bug.
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
61
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
62
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
63 .. seealso::
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
64
74210
e9f517f8ee87 fix some broken URLs
Sandro Tosi <sandro.tosi@gmail.com>
parents: 60878
diff changeset
65 `Python Developer's Guide <http://docs.python.org/devguide/>`_
e9f517f8ee87 fix some broken URLs
Sandro Tosi <sandro.tosi@gmail.com>
parents: 60878
diff changeset
66 Detailed description of the issue workflow and developers tools.
e9f517f8ee87 fix some broken URLs
Sandro Tosi <sandro.tosi@gmail.com>
parents: 60878
diff changeset
67
44856
df22e6180e67 Use original location of document, which has translations.
Georg Brandl <georg@python.org>
parents: 42604
diff changeset
68 `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
69 Article which goes into some detail about how to create a useful bug report.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
70 This describes what kind of information is useful and why it is useful.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
71
45764
c07c5c7a914e Fix lots of broken links in the docs, found by Sphinx' external link checker.
Georg Brandl <georg@python.org>
parents: 44856
diff changeset
72 `Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
73 Information about writing a good bug report. Some of this is specific to the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
74 Mozilla project, but describes general good practices.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
75