[gimp-help-2] Update Bugzilla description
- From: Ulf-D. Ehlert <ulfehlert src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gimp-help-2] Update Bugzilla description
- Date: Tue, 25 Aug 2009 10:44:08 +0000 (UTC)
commit 927b7466eca1769dcec9c4cf1c64477e1138a651
Author: Ulf-D. Ehlert <ulfehlert svn gnome org>
Date: Tue Aug 25 12:43:29 2009 +0200
Update Bugzilla description
Add new screenshots and update description due to the recent
Bugzilla upgrade.
images/C/misc/bugzilla/advanced-search.png | Bin 0 -> 29694 bytes
images/C/misc/bugzilla/enter-bug-info.png | Bin 6251 -> 0 bytes
images/C/misc/bugzilla/enter-bug.png | Bin 37958 -> 25746 bytes
images/C/misc/bugzilla/find-specific-bug.png | Bin 0 -> 16192 bytes
images/C/misc/bugzilla/pick-product.png | Bin 25037 -> 0 bytes
images/C/misc/bugzilla/query-complicated.png | Bin 45476 -> 0 bytes
images/C/misc/bugzilla/query-short.png | Bin 7045 -> 0 bytes
images/C/misc/bugzilla/simple-bug-guide.png | Bin 23478 -> 0 bytes
src/appendix/bugs.xml | 461 ++++++++++----------------
9 files changed, 175 insertions(+), 286 deletions(-)
---
diff --git a/images/C/misc/bugzilla/advanced-search.png b/images/C/misc/bugzilla/advanced-search.png
new file mode 100644
index 0000000..b4b63dc
Binary files /dev/null and b/images/C/misc/bugzilla/advanced-search.png differ
diff --git a/images/C/misc/bugzilla/enter-bug.png b/images/C/misc/bugzilla/enter-bug.png
index d1c6d97..43161e8 100644
Binary files a/images/C/misc/bugzilla/enter-bug.png and b/images/C/misc/bugzilla/enter-bug.png differ
diff --git a/images/C/misc/bugzilla/find-specific-bug.png b/images/C/misc/bugzilla/find-specific-bug.png
new file mode 100644
index 0000000..1be638d
Binary files /dev/null and b/images/C/misc/bugzilla/find-specific-bug.png differ
diff --git a/src/appendix/bugs.xml b/src/appendix/bugs.xml
index 974e0be..3517ec3 100644
--- a/src/appendix/bugs.xml
+++ b/src/appendix/bugs.xml
@@ -2,6 +2,7 @@
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.docbook.org/xml/4.3/docbookx.dtd";>
<!-- section history:
+ 2009-08-25 ude: updated again due to the recent Bugzilla upgrade
2009-06-25 ude: updated (incl. new screenshots)
2006-10-21 lexa: added german translation
2006-02-27 no added by kolbjoern stuestoel
@@ -55,7 +56,7 @@
that 148633.
</para>
- <sect1>
+ <sect1 id="gimp-bug-confirm">
<title>Making sure it's a Bug</title>
<para>
The first thing you should do, before reporting a bug, is to make
@@ -101,67 +102,55 @@
thing.
</para>
<para>
- There are two forms you can use for searching bugs: a simple
- <quote>short</quote> form, and an advanced <quote>complicated</quote>
- form.
+ There are two forms you can use for searching bugs: a simple form to
+ <quote>Find a Specific Bug</quote>, and an <quote>Advanced
+ Search</quote>.
</para>
- <simplesect id="bugzilla-query-short">
- <title>The Short Bug Search Form</title>
+ <simplesect id="bugzilla-find-specific-bug">
+ <title>Find a Specific Bug</title>
<figure>
- <title>Bugzilla: Short Bug Search Form</title>
+ <title>Bugzilla: Find a Specific Bug</title>
<mediaobject>
<imageobject>
<imagedata format="PNG"
- fileref="images/misc/bugzilla/query-short.png"/>
+ fileref="images/misc/bugzilla/find-specific-bug.png"/>
</imageobject>
<caption>
- <para>Searching for bugs using the short bug search form</para>
+ <para>Searching for bugs using the simple bug search form</para>
</caption>
</mediaobject>
</figure>
<para>
- Using the short form, you just have to enter some (space separated)
- search terms, e.g.
+ Using this form, you first should select the
+ <guilabel>Product</guilabel> <quote>GIMP</quote> (classified as
+ <quote>Other</quote>) using the drop down list. Then you just have to
+ enter some (space separated) search terms, e.g.
<blockquote>
<para>
- <userinput>gimp filter crash</userinput>
+ <userinput>filter crash</userinput>
</para>
</blockquote>
- in the text box and click on <guilabel>Search</guilabel>. Even
- elaborate terms like
- <blockquote>
- <para>
- <userinput>product:gimp severity>=major</userinput>
- </para>
- </blockquote>
- are possible.
+ in the text box and click on <guibutton>Search</guibutton>.
</para>
- <tip>
- <para>
- Clicking on <quote>Help</quote> will lead you to an excellent help
- page, including some instructive <quote>Examples with
- Explanations</quote>.
- </para>
- </tip>
</simplesect>
- <simplesect id="bugzilla-query-complicated">
- <title>The Complicated Bug Search Form</title>
+ <simplesect id="bugzilla-advanced-search">
+ <title>The Advanced Bug Search Form</title>
<para>
The alternative form, the advanced query page, allows you to search
the bug database in a variety of ways:
</para>
<figure>
- <title>Bugzilla: Complicated Bug Search Form</title>
+ <title>Bugzilla: Advanced Search</title>
<mediaobject>
<imageobject>
<imagedata format="PNG"
- fileref="images/misc/bugzilla/query-complicated.png"/>
+ fileref="images/misc/bugzilla/advanced-search.png"/>
</imageobject>
<caption>
<para>
- Searching for bugs using the complicated bug search form
+ Searching for bugs using the advanced bug search form
</para>
</caption>
</mediaobject>
@@ -273,7 +262,7 @@
</simplesect>
</sect1>
- <sect1>
+ <sect1 id="gimp-bug-report">
<title>Reporting the Bug</title>
<para>
Okay, so you have done everything you could to make sure, and you still
@@ -287,265 +276,165 @@
won't even get any spam as a result.
</para>
</note>
- <para>
- There are two ways to file a bug report: a simple way using a guided
- tour, or a more advanced way using a single page.
- </para>
-
- <simplesect id="bugzilla-simple-bug-guide">
- <title>The Simple Bug Guide</title>
- <para>
- If you go to
- <ulink url=" http://bugzilla.gnome.org/simple-bug-guide.cgi"/>,
- you have to login, of course, and then you start a guided tour
- with the following dialog:
- </para>
- <figure>
- <title>Bugzilla: Simple Bug Guide</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/misc/bugzilla/simple-bug-guide.png"/>
- </imageobject>
- <caption>
- <para>First dialog window of the simple bug guide</para>
- </caption>
- </mediaobject>
- </figure>
- <para>
- First you will have to answer a few questions, that is you just have
- to select one of several choices. As you can see in the above figure,
- you will always get some useful explanations.
- </para>
- <variablelist>
- <para>You will be asked for</para>
- <varlistentry>
- <term>Bug type</term>
- <listitem>
- <para>
- <quote>Normal</quote> is usually a good choice (but have a look
- at the explanations).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Classification and Application</term>
- <listitem>
- <para>
- Select Classification <quote>Other</quote>, and Application
- <quote>GIMP</quote>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Component</term>
- <listitem>
- <para>
- Set this to the part of <acronym>GIMP</acronym> that the bug
- affects. You have to pick something here, but if you aren't
- sure, make a guess and don't worry about it.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Severity</term>
- <listitem>
- <para>
- In most cases you should either leave this as
- <quote>Normal</quote> or set it to <quote>Enhancement</quote>,
- if it is an enhancement request rather than a malfunction. The
- maintainers will adjust the severity if they think it is
- warranted.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Version</term>
- <listitem>
- <para>
- Set this to the version of <acronym>GIMP</acronym> that you are
- using. See
- <menuchoice>
- <guimenu>Help</guimenu>
- <guimenuitem>About</guimenuitem>
- </menuchoice>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- Then you get to the guided bug report form, which you should fill out
- as follows:
- </para>
- <figure>
- <title>Bugzilla: Enter bug information</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/misc/bugzilla/enter-bug-info.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <variablelist id="bugzilla-bug-information">
- <varlistentry>
- <term>Summary</term>
- <listitem>
- <para>
- Give a one-sentence summary that is descriptive enough so that
- somebody searching for similar bugs would find your bug report on
- the basis of the words this summary contains.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Description</term>
- <listitem>
- <para>
- Describe the problem. Be as specific as you can, and include all
- information that you think might possibly be relevant. The
- classic totally useless bug report is, <quote>GIMP crashes. This
- program sucks</quote>. There is no hope that the developers can
- solve a problem if they can't tell what it is.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Steps to reproduce the bug</term>
- <listitem>
- <para>
- If at all possible, give a procedure that will reliably
- reproduce the buggy behavior, and give it in enough detail so
- that a moron could follow it.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Additional information</term>
- <listitem>
- <para>
- Here you may add any additional information that might be
- relevant, but it's not necessary to duplicate your previous
- reports.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </simplesect>
+ <procedure>
+ <step>
+ <title>Bugzilla: Select Classification</title>
+ <para>
+ Go to <ulink url="http://bugzilla.gnome.org/enter_bug.cgi"/>, and
+ select the classification <quote>Other</quote>.
+ </para>
+ <!-- IMHO a screenshot is not useful here (ude 2009-08-25) -->
+ <para>
+ If you are not logged in, you are automatically redirected to the
+ login page. After entering your user name (login) and password,
+ you get back to the <quote>Select Classification</quote> page.
+ </para>
+ </step>
- <simplesect id="bugzilla-advanced-bugreport">
- <title>The Advanced Bugreport</title>
- <para>
- To use the advanced bug form, go to
- <ulink url="http://bugzilla.gnome.org/enter_bug.cgi"/>,
- and scroll down the page until you can select the product
- <quote>GIMP</quote>.
- </para>
- <figure>
- <title>Bugzilla: Enter Bug (pick a product)</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/misc/bugzilla/pick-product.png"/>
- </imageobject>
- <caption>
- <para>Select the product: <acronym>GIMP</acronym></para>
- </caption>
- </mediaobject>
- </figure>
- <tip>
+ <step>
+ <title>Bugzilla: Pick Product</title>
<para>
- You can skip this step by using
- <ulink url="http://bugzilla.gnome.org/enter_bug.cgi?product=GIMP"/>.
+ Scroll down the next page until you can select the product
+ <quote>GIMP</quote>.
</para>
- </tip>
+ <!-- IMHO a screenshot is not useful here (ude 2009-08-25) -->
+ <tip>
+ <para>
+ You can skip the above steps and go directly to
+ <ulink url="http://bugzilla.gnome.org/enter_bug.cgi?product=GIMP"/>
+ (You still have to login, of course.)
+ </para>
+ </tip>
+ </step>
- <para>
- Selecting <quote>GIMP</quote> as product takes you to the following
- bug report form, which you should fill out as follows. Note that most
- of the information you enter can be changed later by the developers if
- you get it wrong, so try to get it right but don't be obsessive about
- it.
- </para>
- <figure>
- <title>Bugzilla: Enter Bug (<acronym>GIMP</acronym>)</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/misc/bugzilla/enter-bug.png"/>
- </imageobject>
- <caption>
- <para>The main bugreport page</para>
- </caption>
- </mediaobject>
- </figure>
- <variablelist>
- <varlistentry>
- <term>Version, Severity</term>
- <listitem>
- <para>
- See <link linkend="bugzilla-simple-bug-guide">Simple Bug
- Guide</link>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Operating System</term>
- <listitem>
- <para>
- Set this to your OS unless you have a very good reason for
- thinking that the bug applies to all operating systems.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Summary, Description</term>
- <listitem>
- <para>
- See <link linkend="bugzilla-bug-information">Enter bug
- information</link>.
- </para>
- </listitem>
- </varlistentry>
- <!--
- <varlistentry>
- <term>Priority</term>
- <listitem>
- <para>
- In most cases you should leave this at <quote>Normal</quote>,
- and allow the maintainers to adjust it. Setting the priority to
- <quote>Immediate</quote> or <quote>Urgent</quote> usually just
- manages to annoy people.
- </para>
- </listitem>
- </varlistentry>
- -->
- </variablelist>
- <para>
- You can ignore the rest. When you have filled out all of these things,
- press the <guilabel>Commit</guilabel> button and your bug report will
- be submitted. It will be assigned a number, which you may want to make
- note of; you will, however, be emailed any time somebody makes a
- comment on your bug report or otherwise alters it, so you will receive
- reminders in any case. You can see the current state of your bug
- report at any time by going to
- <ulink url="http://bugzilla.gnome.org"/> and, at the
- bottom of the page, in the <quote>Actions:</quote> area, entering the
- bug number and pressing the <guilabel>Find</guilabel> button.
- </para>
- <para>
- Sometimes it is very helpful to augment a bug report with a screenshot
- or some other type of data. If you need to do this, go to the web page
- for your bug report, click on the link <quote>Create a New
- Attachment</quote>, and follow the directions. But please don't do
- this unless you think the attachment is really going to be
- useful—and if you need to attach a screenshot, don't make it any
- larger than necessary. Bug reports are likely to remain on the system
- for years, so there is no sense in wasting memory.
- </para>
- </simplesect>
+ <step>
+ <title>Bugzilla: Enter Bug: <acronym>GIMP</acronym></title>
+ <para>
+ Selecting <quote>GIMP</quote> as product takes you to the
+ following bug report form, which you should fill out as follows.
+ Note that most of the information you enter can be changed later
+ by the developers if you get it wrong, so try to get it right but
+ don't be obsessive about it.
+ </para>
+ <screenshot>
+ <screeninfo>2009-08-25</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG"
+ fileref="images/misc/bugzilla/enter-bug.png"/>
+ </imageobject>
+ <caption>
+ <para>Enter Bug: <acronym>GIMP</acronym></para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ <variablelist>
+ <varlistentry>
+ <term>Component</term>
+ <listitem>
+ <para>
+ Set this to the part of <acronym>GIMP</acronym> that the bug
+ affects. Note that you get a short
+ <quote>Component Description</quote> in the text box next
+ to the list when you select a component.
+ </para>
+ <para>
+ You have to pick something here, but if you aren't sure, make
+ a guess and don't worry about it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Version</term>
+ <listitem>
+ <para>
+ Set this to the version of <acronym>GIMP</acronym> that you
+ are using. You always find the version in the menu of the
+ image window:
+ <menuchoice>
+ <guimenu>Help</guimenu>
+ <guimenuitem>About</guimenuitem>
+ </menuchoice>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Severity</term>
+ <listitem>
+ <para>
+ In most cases you should either leave this as
+ <quote>Normal</quote> or set it to <quote>Enhancement</quote>,
+ if it is an enhancement request rather than a malfunction. The
+ maintainers will adjust the severity if they think it is
+ warranted.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>OS (Operating System)</term>
+ <listitem>
+ <para>
+ Set this to your OS unless you have a very good reason for
+ thinking that the bug applies to all operating systems.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Summary</term>
+ <listitem>
+ <para>
+ Give a one-sentence summary that is descriptive enough so that
+ somebody searching for similar bugs would find your bug report
+ on the basis of the words this summary contains.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Description</term>
+ <listitem>
+ <para>
+ Describe the problem. Be as specific as you can, and include
+ all information that you think might possibly be relevant.
+ The classic totally useless bug report is, <quote>GIMP
+ crashes. This program sucks</quote>. There is no hope that the
+ developers can solve a problem if they can't tell what it is.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ There are more fields which are hidden by default. (Click
+ <quote>Show Advanced Fields</quote> to show them.) You can ignore
+ them, so we won't describe these fields here.
+ </para>
+ <para>
+ Sometimes it is very helpful to augment a bug report with a
+ screenshot or some other type of data. If you need to do this, click
+ on the button <guibutton>Add an attachment</guibutton>,
+ and follow the directions. But please don't do this unless you think
+ the attachment is really going to be useful—and if you need to
+ attach a screenshot, don't make it any larger than necessary. Bug
+ reports are likely to remain on the system for years, so there is no
+ sense in wasting memory.
+ </para>
+ <para>
+ When you have filled out all of these things, press the
+ <guibutton>Commit</guibutton> button and your bug report will be
+ submitted. It will be assigned a number, which you may want to make
+ note of; you will, however, be emailed any time somebody makes a
+ comment on your bug report or otherwise alters it, so you will
+ receive reminders in any case. You can see the current state of your
+ bug report at any time by going to
+ <ulink url="http://bugzilla.gnome.org"/>, entering the bug number in
+ one of the entry boxes and pressing the
+ <guibutton>Find</guibutton> or <guibutton>Quick Search</guibutton>
+ button.
+ </para>
+ </step>
+ </procedure>
</sect1>
- <sect1>
+ <sect1 id="gimp-bug-submitted">
<title>What Happens to a Bug Report after you Submit it</title>
<para>
At any time after it is submitted, a bug report has a
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
