Skip to content

bugzilla
bugzilla
Commit 850da7d0 authored by vladd%bugzilla.org's avatar vladd%bugzilla.org
Browse files
Options

Documentation patch for bug 355302: Documentation for the "clone bug" feature;…

Documentation patch for bug 355302: Documentation for the "clone bug" feature; patch by victory(_RSZ_) <bmo2007@rsz.jp>, r=vladd.
parent 94149638
Hide whitespace changes
Inline Side-by-side
Showing with 114 additions and 95 deletions
docs/xml/using.xml
View file @ 850da7d0
...@@ -689,108 +689,111 @@ ...@@ -689,108 +689,111 @@
<section id="bugreports"> <section id="bugreports">
<title>Filing Bugs</title> <title>Filing Bugs</title>
<para>Years of bug writing experience has been distilled for your <section id="fillingbugs">
reading pleasure into the <title>Reporting a New Bug</title>
<ulink
url="&landfillbase;page.cgi?id=bug-writing.html"> <para>Years of bug writing experience has been distilled for your
Bug Writing Guidelines</ulink>. reading pleasure into the
While some of the advice is Mozilla-specific, the basic principles of <ulink
reporting Reproducible, Specific bugs, isolating the Product you are url="&landfillbase;page.cgi?id=bug-writing.html">
using, the Version of the Product, the Component which failed, the Bug Writing Guidelines</ulink>.
Hardware Platform, and Operating System you were using at the time of While some of the advice is Mozilla-specific, the basic principles of
the failure go a long way toward ensuring accurate, responsible fixes reporting Reproducible, Specific bugs, isolating the Product you are
for the bug that bit you.</para> using, the Version of the Product, the Component which failed, the
Hardware Platform, and Operating System you were using at the time of
<para>The procedure for filing a bug is as follows:</para> the failure go a long way toward ensuring accurate, responsible fixes
for the bug that bit you.</para>
<para>The procedure for filing a bug is as follows:</para>
<orderedlist>
<listitem>
<para>
Click the <quote>New</quote> link available in the footer
of pages, or the <quote>Enter a new bug report</quote> link
displayed on the home page of the Bugzilla installation.
</para>
<orderedlist> <note>
<listitem> <para>
<para> If you want to file a test bug to see how Bugzilla works,
Click the <quote>New</quote> link available in the footer you can do it on one of our test installations on
of pages, or the <quote>Enter a new bug report</quote> link <ulink url="&landfillbase;">Landfill</ulink>.
displayed on the home page of the Bugzilla installation. </para>
</para> </note>
</listitem>
<note> <listitem>
<para> <para>
If you want to file a test bug to see how Bugzilla works, You first have to select the product in which you found a bug.
you can do it on one of our test installations on
<ulink url="&landfillbase;">Landfill</ulink>.
</para> </para>
</note> </listitem>
</listitem>
<listitem> <listitem>
<para> <para>
You first have to select the product in which you found a bug. You now see a form where you can specify the component (part of
</para> the product which is affected by the bug you discovered; if you have
</listitem> no idea, just select <quote>General</quote> if such a component exists),
the version of the program you were using, the Operarting System and
platform your program is running on and the severity of the bug (if the
bug you found crashes the program, it's probably a major or a critical
bug; if it's a typo somewhere, that's something pretty minor; if it's
something you would like to see implemented, then that's an enhancement).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
You now see a form where you can specify the component (part of You now have to give a short but descriptive summary of the bug you found.
the product which is affected by the bug you discovered; if you have <quote>My program is crashing all the time</quote> is a very poor summary
no idea, just select <quote>General</quote> if such a component exists), and doesn't help developers at all. Try something more meaningful or
the version of the program you were using, the Operarting System and your bug will probably be ignored due to a lack of precision.
platform your program is running on and the severity of the bug (if the The next step is to give a very detailed list of steps to reproduce
bug you found crashes the program, it's probably a major or a critical the problem you encountered. Try to limit these steps to a minimum set
bug; if it's a typo somewhere, that's something pretty minor; if it's required to reproduce the problem. This will make the life of
something you would like to see implemented, then that's an enhancement). developers easier, and the probability that they consider your bug in
</para> a reasonable timeframe will be much higher.
</listitem> </para>
<listitem> <note>
<para> <para>
You now have to give a short but descriptive summary of the bug you found. Try to make sure that everything in the summary is also in the first
<quote>My program is crashing all the time</quote> is a very poor summary comment. Summaries are often updated and this will ensure your original
and doesn't help developers at all. Try something more meaningful or information is easily accessible.
your bug will probably be ignored due to a lack of precision. </para>
The next step is to give a very detailed list of steps to reproduce </note>
the problem you encountered. Try to limit these steps to a minimum set </listitem>
required to reproduce the problem. This will make the life of
developers easier, and the probability that they consider your bug in
a reasonable timeframe will be much higher.
</para>
<note> <listitem>
<para> <para>
Try to make sure that everything in the summary is also in the first As you file the bug, you can also attach a document (testcase, patch,
comment. Summaries are often updated and this will ensure your original or screenshot of the problem).
information is easily accessible.
</para> </para>
</note> </listitem>
</listitem>
<listitem>
<para>
As you file the bug, you can also attach a document (testcase, patch,
or screenshot of the problem).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Depending on the Bugzilla installation you are using and the product in Depending on the Bugzilla installation you are using and the product in
which you are filing the bug, you can also request developers to consider which you are filing the bug, you can also request developers to consider
your bug in different ways (such as requesting review for the patch you your bug in different ways (such as requesting review for the patch you
just attached, requesting your bug to block the next release of the just attached, requesting your bug to block the next release of the
product, and many other product specific requests). product, and many other product specific requests).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Now is a good time to read your bug report again. Remove all misspellings, Now is a good time to read your bug report again. Remove all misspellings,
otherwise your bug may not be found by developers running queries for some otherwise your bug may not be found by developers running queries for some
specific words, and so your bug would not get any attention. specific words, and so your bug would not get any attention.
Also make sure you didn't forget any important information developers Also make sure you didn't forget any important information developers
should know in order to reproduce the problem, and make sure your should know in order to reproduce the problem, and make sure your
description of the problem is explicit and clear enough. description of the problem is explicit and clear enough.
When you think your bug report is ready to go, the last step is to When you think your bug report is ready to go, the last step is to
click the <quote>Commit</quote> button to add your report into the database. click the <quote>Commit</quote> button to add your report into the database.
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para> <para>
You do not need to put "any" or similar strings in the URL field. You do not need to put "any" or similar strings in the URL field.
...@@ -803,6 +806,22 @@ ...@@ -803,6 +806,22 @@
the bug it was duped to. Feel free to CC the person who duped it the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed. if they are not already CCed.
</para> </para>
</section>
<section id="cloningbugs">
<title>Clone an Existing Bug</title>
<para>
Starting with version 2.20, Bugzilla has a feature that allows you
to clone an existing bug. The newly created bug will inherit
most settings from the old bug. This allows you to track more
easily similar concerns in a new bug. To use this, go to the bug
that you want to clone, then click the <quote>Clone This Bug</quote>
link on the bug page. This will take you to the <quote>Enter Bug</quote>
page that is filled with the values that the old bug has.
You can change those values and/or texts if needed.
</para>
</section>
</section> </section>
...@@ -931,7 +950,7 @@ ...@@ -931,7 +950,7 @@
<section id="hintsandtips"> <section id="hintsandtips">
<title>Hints and Tips</title> <title>Hints and Tips</title>
<para>This section distills some Bugzilla tips and best practices <para>This section distills some Bugzilla tips and best practices
that have been developed.</para> that have been developed.</para>
...@@ -955,7 +974,7 @@ ...@@ -955,7 +974,7 @@
<member>Most other sorts of URL</member> <member>Most other sorts of URL</member>
</simplelist> </simplelist>
</para> </para>
<para>A corollary here is that if you type a bug number in a comment, <para>A corollary here is that if you type a bug number in a comment,
you should put the word "bug" before it, so it gets autolinkified you should put the word "bug" before it, so it gets autolinkified
for the convenience of others. for the convenience of others.
...@@ -974,14 +993,14 @@ ...@@ -974,14 +993,14 @@
and add a comment saying "Adding self to CC", then that person and add a comment saying "Adding self to CC", then that person
gets a pointless piece of mail they would otherwise have avoided. gets a pointless piece of mail they would otherwise have avoided.
</para> </para>
<para> <para>
Don't use sigs in comments. Signing your name ("Bill") is acceptable, Don't use sigs in comments. Signing your name ("Bill") is acceptable,
if you do it out of habit, but full mail/news-style if you do it out of habit, but full mail/news-style
four line ASCII art creations are not. four line ASCII art creations are not.
</para> </para>
</section> </section>
<section id="dependencytree"> <section id="dependencytree">
<title>Dependency Tree</title> <title>Dependency Tree</title>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment