[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / api / reporting-bugs.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="api.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="api.html" title='Python/C API Reference Manual' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node83.html" />
<link rel="prev" href="newTypes.html" />
<link rel="parent" href="api.html" />
<link rel="next" href="node83.html" />
<meta name='aesop' content='information' />
<title>A. Reporting Bugs</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.9 Supporting Cyclic Garbage"
  href="supporting-cycle-detection.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Python/C API Reference Manual"
  href="api.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="B. History and License"
  href="node83.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="supporting-cycle-detection.html">10.9 Supporting Cyclic Garbage</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="api.html">Python/C API Reference Manual</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node83.html">B. History and License</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0013000000000000000000">
A. Reporting Bugs</A>
</H1>
<A NAME="reporting-bugs"></A>
<P>
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
or its documentation.

<P>
Before submitting a report, you will be required to log into SourceForge;
this will make it possible for the developers to contact you
for additional information if needed.  It is not possible to submit a
bug report anonymously.

<P>
All bug reports should be submitted via the Python Bug Tracker on
SourceForge (<a class="url" href="http://sourceforge.net/bugs/?group_id=5470">http://sourceforge.net/bugs/?group_id=5470</a>).  The
bug tracker offers a Web form which allows pertinent information to be
entered and submitted to the developers.

<P>
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 left side of the page.

<P>
If the problem you're reporting is not already in the bug tracker, go
back to the Python Bug Tracker
(<a class="url" href="http://sourceforge.net/bugs/?group_id=5470">http://sourceforge.net/bugs/?group_id=5470</a>).  Select the
``Submit a Bug'' link at the top of the page to open the bug reporting
form.

<P>
The submission form has a number of fields.  The only fields that are
required are the ``Summary'' and ``Details'' fields.  For the summary,
enter a <em>very</em> short description of the problem; less than ten
words is good.  In the Details field, describe the problem in detail,
including what you expected to happen and what did happen.  Be sure to
include the version of Python you used, whether any extension modules
were involved, and what hardware and software platform you were using
(including version information as appropriate).

<P>
The only other field that you may want to set is the ``Category''
field, which allows you to place the bug report into a broad category
(such as ``Documentation'' or ``Library'').

<P>
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.

<P>
<div class="seealso">
  <p class="heading">See Also:</p>

  <dl compact="compact" class="seetitle">
    <dt><em class="citetitle"><a href="http://www-mice.cs.ucl.ac.uk/multimedia/software/documentation/ReportingBugs.html"
        >How
        to Report Bugs Effectively</a></em></dt>
    <dd>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.</dd>
  </dl>

<P>
<dl compact="compact" class="seetitle">
    <dt><em class="citetitle"><a href="http://www.mozilla.org/quality/bug-writing-guidelines.html"
        >Bug
        Writing Guidelines</a></em></dt>
    <dd>Information about writing a good bug
        report.  Some of this is specific to the Mozilla project, but
        describes general good practices.</dd>
  </dl>
</div>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.9 Supporting Cyclic Garbage"
  href="supporting-cycle-detection.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Python/C API Reference Manual"
  href="api.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="B. History and License"
  href="node83.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="supporting-cycle-detection.html">10.9 Supporting Cyclic Garbage</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="api.html">Python/C API Reference Manual</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node83.html">B. History and License</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="api.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="api.html" title='Python/C API Reference Manual' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="node83.html" />
	13	<link rel="prev" href="newTypes.html" />
	14	<link rel="parent" href="api.html" />
	15	<link rel="next" href="node83.html" />
	16	<meta name='aesop' content='information' />
	17	<title>A. Reporting Bugs</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="10.9 Supporting Cyclic Garbage"
	25	href="supporting-cycle-detection.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="Python/C API Reference Manual"
	28	href="api.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="B. History and License"
	31	href="node83.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python/C API Reference Manual</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><img src='../icons/blank.png'
	38	border='0' height='32' alt='' width='32' /></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="supporting-cycle-detection.html">10.9 Supporting Cyclic Garbage</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="api.html">Python/C API Reference Manual</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="node83.html">B. History and License</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION0013000000000000000000">
	56	A. Reporting Bugs</A>
	57	</H1>
	58	<A NAME="reporting-bugs"></A>
	59	<P>
	60	Python is a mature programming language which has established a
	61	reputation for stability. In order to maintain this reputation, the
	62	developers would like to know of any deficiencies you find in Python
	63	or its documentation.
	64
65	<P>
66	Before submitting a report, you will be required to log into SourceForge;
67	this will make it possible for the developers to contact you
68	for additional information if needed. It is not possible to submit a
69	bug report anonymously.
70
71	<P>
72	All bug reports should be submitted via the Python Bug Tracker on
73	SourceForge (<a class="url" href="http://sourceforge.net/bugs/?group_id=5470">http://sourceforge.net/bugs/?group_id=5470</a>). The
74	bug tracker offers a Web form which allows pertinent information to be
75	entered and submitted to the developers.
76
77	<P>
78	The first step in filing a report is to determine whether the problem
79	has already been reported. The advantage in doing so, aside from
80	saving the developers time, is that you learn what has been done to
81	fix it; it may be that the problem has already been fixed for the next
82	release, or additional information is needed (in which case you are
83	welcome to provide it if you can!). To do this, search the bug
84	database using the search box on the left side of the page.
85
86	<P>
87	If the problem you're reporting is not already in the bug tracker, go
88	back to the Python Bug Tracker
89	(<a class="url" href="http://sourceforge.net/bugs/?group_id=5470">http://sourceforge.net/bugs/?group_id=5470</a>). Select the
90	``Submit a Bug'' link at the top of the page to open the bug reporting
91	form.
92
93	<P>
94	The submission form has a number of fields. The only fields that are
95	required are the ``Summary'' and ``Details'' fields. For the summary,
96	enter a <em>very</em> short description of the problem; less than ten
97	words is good. In the Details field, describe the problem in detail,
98	including what you expected to happen and what did happen. Be sure to
99	include the version of Python you used, whether any extension modules
100	were involved, and what hardware and software platform you were using
101	(including version information as appropriate).
102
103	<P>
104	The only other field that you may want to set is the ``Category''
105	field, which allows you to place the bug report into a broad category
106	(such as ``Documentation'' or ``Library'').
107
108	<P>
109	Each bug report will be assigned to a developer who will determine
110	what needs to be done to correct the problem. You will
111	receive an update each time action is taken on the bug.
112
113	<P>
114	<div class="seealso">
115	<p class="heading">See Also:</p>
116
117	<dl compact="compact" class="seetitle">
118	<dt><em class="citetitle"><a href="http://www-mice.cs.ucl.ac.uk/multimedia/software/documentation/ReportingBugs.html"
119	>How
120	to Report Bugs Effectively</a></em></dt>
121	<dd>Article which goes into some
122	detail about how to create a useful bug report. This
123	describes what kind of information is useful and why it is
124	useful.</dd>
125	</dl>
126
127	<P>
128	<dl compact="compact" class="seetitle">
129	<dt><em class="citetitle"><a href="http://www.mozilla.org/quality/bug-writing-guidelines.html"
130	>Bug
131	Writing Guidelines</a></em></dt>
132	<dd>Information about writing a good bug
133	report. Some of this is specific to the Mozilla project, but
134	describes general good practices.</dd>
135	</dl>
136	</div>
137
138	<P>
139
140	<DIV CLASS="navigation">
141	<div class='online-navigation'>
142	<p></p><hr />
143	<table align="center" width="100%" cellpadding="0" cellspacing="2">
144	<tr>
145	<td class='online-navigation'><a rel="prev" title="10.9 Supporting Cyclic Garbage"
146	href="supporting-cycle-detection.html"><img src='../icons/previous.png'
147	border='0' height='32' alt='Previous Page' width='32' /></A></td>
148	<td class='online-navigation'><a rel="parent" title="Python/C API Reference Manual"
149	href="api.html"><img src='../icons/up.png'
150	border='0' height='32' alt='Up One Level' width='32' /></A></td>
151	<td class='online-navigation'><a rel="next" title="B. History and License"
152	href="node83.html"><img src='../icons/next.png'
153	border='0' height='32' alt='Next Page' width='32' /></A></td>
154	<td align="center" width="100%">Python/C API Reference Manual</td>
155	<td class='online-navigation'><a rel="contents" title="Table of Contents"
156	href="contents.html"><img src='../icons/contents.png'
157	border='0' height='32' alt='Contents' width='32' /></A></td>
158	<td class='online-navigation'><img src='../icons/blank.png'
159	border='0' height='32' alt='' width='32' /></td>
160	<td class='online-navigation'><a rel="index" title="Index"
161	href="genindex.html"><img src='../icons/index.png'
162	border='0' height='32' alt='Index' width='32' /></A></td>
163	</tr></table>
164	<div class='online-navigation'>
165	<b class="navlabel">Previous:</b>
166	<a class="sectref" rel="prev" href="supporting-cycle-detection.html">10.9 Supporting Cyclic Garbage</A>
167	<b class="navlabel">Up:</b>
168	<a class="sectref" rel="parent" href="api.html">Python/C API Reference Manual</A>
169	<b class="navlabel">Next:</b>
170	<a class="sectref" rel="next" href="node83.html">B. History and License</A>
171	</div>
172	</div>
173	<hr />
174	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
175	</DIV>
176	<!--End of Navigation Panel-->
177	<ADDRESS>
178	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
179	</ADDRESS>
180	</BODY>
181	</HTML>