summaryrefslogtreecommitdiffstats
path: root/docs/sgml
diff options
context:
space:
mode:
authorgerv%gerv.net <>2002-05-09 06:16:36 +0200
committergerv%gerv.net <>2002-05-09 06:16:36 +0200
commit78e1dc6bd8beed4e3884875ae8a4f96753dab9cf (patch)
treed75ce3ff9bfbcfb008c0ce75eb514acb09eddb9b /docs/sgml
parentb23550bf70319f5c051acedadd35d8ce30a43363 (diff)
downloadbugzilla-78e1dc6bd8beed4e3884875ae8a4f96753dab9cf.tar.gz
bugzilla-78e1dc6bd8beed4e3884875ae8a4f96753dab9cf.tar.xz
The first installment of Gerv's spanking of the Bugzilla Guide. This is a work-in-progress.
Diffstat (limited to 'docs/sgml')
-rw-r--r--docs/sgml/administration.sgml8
-rw-r--r--docs/sgml/conventions.sgml8
-rw-r--r--docs/sgml/using.sgml745
3 files changed, 289 insertions, 472 deletions
diff --git a/docs/sgml/administration.sgml b/docs/sgml/administration.sgml
index 8794a0e2c..6789ca071 100644
--- a/docs/sgml/administration.sgml
+++ b/docs/sgml/administration.sgml
@@ -1373,12 +1373,14 @@ Group3, since he isn't in Group4.
make certain files world readable and/or writable. <emphasis>THIS IS
INSECURE!</emphasis>. This means that anyone who can get access to
your system can do whatever they want to your Bugzilla installation.
- <note>
+ </para>
+ <note>
+ <para>
This also means that if your webserver runs all cgi scripts as the
same user/group, anyone on the system who can run cgi scripts will
be able to take control of your Bugzilla installation.
- </note>
- </para>
+ </para>
+ </note>
<para>
On Apache, you can use .htaccess files to protect access
to these directories, as outlined in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ulink> for the localconfig file, and <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> Bug 65572</ulink> for adequate protection in your data/ and shadow/ directories.
diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml
index 71f2b0c5e..6382985b6 100644
--- a/docs/sgml/conventions.sgml
+++ b/docs/sgml/conventions.sgml
@@ -23,25 +23,25 @@
<row>
<entry>Warnings</entry>
<entry><caution>
- <para>Warnings.</para>
+ <para>Don't run with scissors!</para>
</caution></entry>
</row>
<row>
<entry>Hint</entry>
<entry><tip>
- <para>Hint.</para>
+ <para>Warm jar lids under the hot tap to loosen them.</para>
</tip></entry>
</row>
<row>
<entry>Notes</entry>
<entry><note>
- <para>Note.</para>
+ <para>Dear John...</para>
</note></entry>
</row>
<row>
<entry>Information requiring special attention</entry>
<entry><warning>
- <para>Warning.</para>
+ <para>Read this or the cat gets it.</para>
</warning></entry>
</row>
<row>
diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml
index 6cb301d61..892961729 100644
--- a/docs/sgml/using.sgml
+++ b/docs/sgml/using.sgml
@@ -55,54 +55,20 @@ system against which all others are measured.
<para>
Bugzilla has matured immensely, and now boasts many advanced features. These include:
<itemizedlist>
- <listitem>
- <para>
- integrated, product-based granular security schema
- </para>
- </listitem>
- <listitem>
- <para>
- inter-bug dependencies and dependency graphing
- </para>
- </listitem>
- <listitem>
- <para>
- advanced reporting capabilities
- </para>
- </listitem>
- <listitem>
- <para>
- a robust, stable RDBMS back-end
- </para>
- </listitem>
- <listitem>
- <para>
- extensive configurability
- </para>
- </listitem>
- <listitem>
- <para>
- a very well-understood and well-thought-out natural bug resolution protocol
- </para>
- </listitem>
- <listitem>
- <para>
- email, XML, console, and web interfaces
- </para>
- </listitem>
- <listitem>
- <para>
- available integration with automated software
- configuration management systems, including Perforce and
- CVS (through the Bugzilla email interface and
- checkin/checkout scripts)
- </para>
- </listitem>
- <listitem>
- <para>
- too many more features to list
- </para>
- </listitem>
+
+<listitem><para>Powerful searching</para></listitem>
+<listitem><para>User-configurable email notifications of bug changes</para></listitem>
+<listitem><para>Full change history</para></listitem>
+<listitem><para>Inter-bug dependency tracking and graphing</para></listitem>
+<listitem><para>Excellent attachment management</para></listitem>
+<listitem><para>Integrated, product-based, granular security schema</para></listitem>
+<listitem><para>Fully security-audited, and runs under Perl's taint mode</para></listitem>
+<listitem><para>A robust, stable RDBMS back-end</para></listitem>
+<listitem><para>Web, XML, email and console interfaces</para></listitem>
+<listitem><para>Completely customisable and/or localisable web user interface</para></listitem>
+<listitem><para>Extensive configurability</para></listitem>
+<listitem><para>Smooth upgrade pathway between versions</para></listitem>
+
</itemizedlist>
</para>
</section>
@@ -178,25 +144,16 @@ system against which all others are measured.
</epigraph>
<para>
- Bugzilla is a large, complex system. Describing how to use it
- requires some time. If you are only interested in installing or
- administering a Bugzilla installation, please consult the
+ This section contains information for end-users of Bugzilla.
+ If you are administering a Bugzilla installation, please consult the
Installing and Administering Bugzilla portions of this Guide.
- This section is principally aimed towards developing end-user
- mastery of Bugzilla, so you may fully enjoy the benefits
- afforded by using this reliable open-source bug-tracking
- software.
</para>
<para>
- Throughout this portion of the Guide, we will refer to user
- account options available at the Bugzilla test installation,
+ There is a Bugzilla test installation, called
<ulink url="http://landfill.tequilarista.org/">
- landfill.tequilarista.org</ulink>.
- Although Landfill serves as a great introduction to
- Bugzilla, it does not offer all the options you would have as a
- user on your own installation of Bugzilla, nor can it do more
- than serve as a general introduction to Bugzilla. Additionally,
- Landfill often runs cutting-edge versions of Bugzilla for
+ Landfill</ulink>, which you are welcome to play with.
+ However, it does not necessarily have all Bugzilla features
+ enabled, and often runs cutting-edge versions of Bugzilla for
testing, so some things may work slightly differently than
mentioned here.
</para>
@@ -207,21 +164,16 @@ system against which all others are measured.
If you want to use Bugzilla, first you
need to create an account. Consult with the administrator
responsible for your installation of Bugzilla for the URL you
- should use to access it. If you're test-driving the end-user
- Bugzilla experience, use this URL: <ulink
+ should use to access it. If you're test-driving Bugzilla,
+ use this URL: <ulink
url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink>
</para>
<orderedlist>
<listitem>
<para>
- Click the "Open a new Bugzilla account" link.
- </para>
- </listitem>
- <listitem>
- <para>
- Enter your "E-mail address" and "Real Name" (or whatever
- name you want to call yourself) in the spaces provided,
- then select the "Create Account" button.
+ Click the <quote>Open a new Bugzilla account</quote> link, enter your
+ email address and, optionally, your name in the spaces provided,
+ then click <quote>Create Account</quote>.
</para>
</listitem>
<listitem>
@@ -230,308 +182,289 @@ system against which all others are measured.
you provided above, which contains your login name
(generally the same as the email address), and a password
you can use to access your account. This password is
- randomly generated, and should be changed at your nearest
- opportunity (we'll go into how to do it later).
+ randomly generated, and can be changed to something more memorable.
</para>
</listitem>
<listitem>
<para>
Click the <quote>Log In</quote> link in the yellow area at
- the bottom of the page in your browser, then enter your
- <quote>E-mail address</quote> and <quote>Password</quote>
- you just received into the spaces provided, and select
+ the bottom of the page in your browser, enter your
+ email address and password into the spaces provided, and click
<quote>Login</quote>.
- <note>
- <para>
- If you ever forget your password, you can come back to
- this page, enter your <quote>E-mail address</quote>,
- then select the <quote>E-mail me a password</quote>
- button to have your password mailed to you again so
- that you can login.
- </para>
- </note>
</para>
</listitem>
</orderedlist>
<para>
- Congratulations! If you followed these directions, you now
- are the proud owner of a user account on
- landfill.tequilarista.org (Landfill) or your local Bugzilla
- install. You should now see in your browser a page called the
- <quote>Bugzilla Query Page</quote>. It may look daunting, but with this
- Guide to walk you through it, you will master it in no time.
+ You are now logged in. Bugzilla uses cookies for authentication, so
+ (unless your IP address changes) you should not have to log in again.
</para>
</section>
- <section id="query">
- <title>The Bugzilla Query Page</title>
- <para>
- The Bugzilla Query Page is the heart and soul of the Bugzilla
- user experience. It is the master interface where you can
- find any bug report, comment, or patch currently in the
- Bugzilla system. We'll go into how to create your own bug
- report later on.
- </para>
- <para>
- At this point, let's visit the query page.
- <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">
- landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>
- </para>
- <para>
- The first thing you need to notice about the Bugzilla Query
- Page is that nearly every box you see on your screen has a
- hyperlink nearby, explaining what it is or what it does. Near
- the upper-left-hand corner of your browser window you should
- see the word <quote>Status</quote> underlined. Select it.
- </para>
+ <section id="bug_page">
+ <title>Anatomy of a Bug</title>
<para>
- Notice the page that popped up? Every underlined word you see
- on your screen is a hyperlink that will take you to
- context-sensitive help. Click around for a while, and learn
- what everything here does. To return to the query interface
- after pulling up a help page, use the <quote>Back</quote>
- button in your browser.
+ The core of Bugzilla is the screen which displays a particular bug.
+ It's a good place to explain some Bugzilla concepts.
+ <ulink url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">Bug 1 on Landfill</ulink> is a good example. Note that the names of most fields
+ are hyperlinks; clicking them will take you to context-sensitive
+ help on that particular field.
</para>
- <para>
- I'm sure that after checking out the online help, you are now
- an expert on the Bugzilla Query Page. If, however, you feel
- you haven't mastered it yet, let me walk you through making a
- few successful queries to find out what there are in the
- Bugzilla bug-tracking system itself.
- </para>
- <orderedlist>
- <listitem>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ <emphasis>Product and Component</emphasis>:
+ Bugs are divided up by Product and Component, with a Product having one
+ or more Components in it. For example, bugzilla.mozilla.org's
+ "Bugzilla" Product is composed of several Components:
+ <simplelist>
+ <member><emphasis>Administration</emphasis>,
+ Administration of a bugzilla installation, including
+ <filename>editcomponents.cgi</filename>,
+ <filename>editgroups.cgi</filename>,
+ <filename>editkeywords.cgi</filename>,
+ <filename>editparams.cgi</filename>,
+ <filename>editproducts.cgi</filename>,
+ <filename>editusers.cgi</filename>,
+ <filename>editversions.cgi,</filename> and
+ <filename>sanitycheck.cgi</filename>.
+ </member>
+ <member><emphasis>Bugzilla-General</emphasis>,
+ Anything that doesn't fit in the other components, or spans
+ multiple components.
+ </member>
+ <member><emphasis>Creating/Changing Bugs</emphasis>,
+ Creating, changing, and viewing bugs.
+ <filename>enter_bug.cgi</filename>,
+ <filename>post_bug.cgi</filename>,
+ <filename>show_bug.cgi</filename> and
+ <filename>process_bug.cgi</filename>.
+ </member>
+ <member><emphasis>Documentation</emphasis>,
+ The bugzilla documentation, including anything in the
+ <filename>docs/</filename> directory and The Bugzilla Guide
+
+ </member>
+ <member><emphasis>Email</emphasis>,
+ Anything to do with email sent by Bugzilla.
+ <filename>processmail</filename>
+ </member>
+ <member><emphasis>Installation</emphasis>,
+ The installation process of Bugzilla. This includes
+ <filename>checksetup.pl</filename> and whatever else it evolves into.
+ </member>
+ <member><emphasis>Query/Buglist</emphasis>,
+ Anything to do with searching for bugs and viewing the buglists.
+ <filename>query.cgi</filename> and
+ <filename>buglist.cgi</filename>
+ </member>
+ <member><emphasis>Reporting/Charting</emphasis>,
+ Getting reports from Bugzilla.
+ <filename>reports.cgi</filename> and
+ <filename>duplicates.cgi</filename>
+ </member>
+ <member><emphasis>User Accounts</emphasis>,
+ Anything about managing a user account from the user's perspective.
+ <filename>userprefs.cgi</filename>, saved queries, creating accounts,
+ changing passwords, logging in, etc.
+ </member>
+ <member><emphasis>User Interface</emphasis>,
+ General issues having to do with the user interface cosmetics (not
+ functionality) including cosmetic issues, HTML templates, etc.
+ </member>
+ </simplelist>
+ </para>
+ </listitem>
+
+ <listitem>
<para>
- Ensure you are back on the <quote>Bugzilla Query
- Page</quote>. Do nothing in the boxes marked "Status",
- "Resolution", "Platform", "OpSys", "Priority", or
- "Severity". The default query for "Status" is to find all
- bugs that are NEW, ASSIGNED, or REOPENED, which is what we
- want. If you don't select anything in the other 5
- scrollboxes there, then you are saying that "any of these
- are OK"; we're not locking ourselves into only finding
- bugs on the "DEC" Platform, or "Windows 95" OpSys
- (Operating System). You're smart, I think you have it
- figured out.
+ <emphasis>Status and Resolution</emphasis>:
+ A bug passes through several Statuses in its lifetime, and ends up in the
+ RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.)
+ The different possible
+ values for Status and Resolution on your installation will be documented
+ in the context-sensitive help for those items.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Assigned To</emphasis>:
+ The person responsible for fixing the bug.
</para>
+ </listitem>
+
+ <listitem>
<para>
- Basically, selecting <emphasis>anything</emphasis> on the
- query page narrows your search down. Leaving stuff
- unselected, or text boxes unfilled, broadens your search.
+ <emphasis>URL</emphasis>:
+ A URL associated with the bug, if any.
</para>
- </listitem>
+ </listitem>
- <listitem>
+ <listitem>
<para>
- You see the box immediately below the top six boxes that
- contains an "Email" text box, with the words "matching
- as", a drop-down selection box, then some checkboxes with
- "Assigned To" checked by default? This allows you to
- filter your search down based upon email address. Let's
- put my email address in there, and see what happens.
+ <emphasis>Summary</emphasis>:
+ A one-sentence summary of the problem.
</para>
+ </listitem>
+
+ <listitem>
<para>
- Type "barnboy@trilobyte.net" in the top Email text box.
+ <emphasis>Status Whiteboard</emphasis>: (a.k.a. Whiteboard) A
+ free-form text area for adding short notes and tags to a bug.
</para>
- </listitem>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Keywords</emphasis>:
+ The administrator can define keywords which you can use to tag and
+ categorise bugs - e.g. The Mozilla Project has keywords like crash
+ and regression.
+ </para>
+ </listitem>
- <listitem>
+ <listitem>
<para>
- Let's narrow the search some more. Scroll down until you
- find the box with the word "Program" over the top of it.
- This is where we can narrow our search down to only
- specific products (software programs or product lines) in
- our Bugzilla database. Please notice the box is a
- <emphasis>scrollbox</emphasis>. Using the down arrow on
- the scrollbox, scroll down until you can see an entry
- called "Bugzilla". Select this entry.
+ <emphasis>Platform and OS</emphasis>:
+ These indicate the computing environment where the bug was found.
</para>
- </listitem>
- <listitem>
+ </listitem>
+
+ <listitem>
<para>
- Did you notice that some of the boxes to the right changed
- when you selected "Bugzilla"? Every Program (or Product)
- has different Versions, Components, and Target Milestones
- associated with it. A "Version" is the number of a
- software program.
- <example>
- <title>Some Famous Software Versions</title>
- <informalexample>
- <para>
- Do you remember the hype in 1995 when Microsoft
- Windows 95(r) was released? It may have been several
- years ago, but Microsoft(tm) spent over $300 Million
- advertising this new Version of their software.
- Three years later, they released Microsoft Windows
- 98(r), another new version, to great fanfare, and
- then in 2000 quietly released Microsoft Windows
- ME(Millenium Edition)(r).
- </para>
- <para>
- Software "Versions" help a manufacturer
- differentiate their current product from their
- previous products. Most do not identify their
- products by the year they were released. Instead,
- the "original" version of their software will often
- be numbered "1.0", with small bug-fix releases on
- subsequent tenths of a digit. In most cases, it's
- not a decimal number; for instance, often 1.9 is an
- <emphasis>older</emphasis> version of the software
- than 1.11, but is a <emphasis>newer</emphasis>
- version than 1.1.1.
- </para>
- <para>
- In general, a "Version" in Bugzilla should refer to
- <emphasis>released</emphasis> products, not products
- that have not yet been released to the public.
- Forthcoming products are what the Target Milestone
- field is for.
- </para>
- </informalexample>
- </example>
+ <emphasis>Version</emphasis>:
+ The "Version" field is usually used for versions of a product which have
+ been released, and is set to indicate which versions of a Component
+ have the particular problem the bug report is about.
</para>
+ </listitem>
+
+ <listitem>
<para>
- A "Component" is a piece of a Product.
- It may be a standalone program, or some other logical
- division of a Product or Program.
- Normally, a Component has a single Owner, who is responsible
- for overseeing efforts to improve that Component.
- <example>
- <title>Mozilla's Bugzilla Components</title>
- <informalexample>
- <para>
- Mozilla's "Bugzilla" Product is composed of several pieces (Components):
- <simplelist>
- <member><emphasis>Administration</emphasis>,
- Administration of a bugzilla installation, including
- <filename>editcomponents.cgi</filename>,
- <filename>editgroups.cgi</filename>,
- <filename>editkeywords.cgi</filename>,
- <filename>editparams.cgi</filename>,
- <filename>editproducts.cgi</filename>,
- <filename>editusers.cgi</filename>,
- <filename>editversions.cgi,</filename> and
- <filename>sanitycheck.cgi</filename>.
- </member>
- <member><emphasis>Bugzilla-General</emphasis>,
- Anything that doesn't fit in the other components, or spans
- multiple components.
- </member>
- <member><emphasis>Creating/Changing Bugs</emphasis>,
- Creating, changing, and viewing bugs.
- <filename>enter_bug.cgi</filename>,
- <filename>post_bug.cgi</filename>,
- <filename>show_bug.cgi</filename> and
- <filename>process_bug.cgi</filename>.
- </member>
- <member><emphasis>Documentation</emphasis>,
- The bugzilla documentation, including anything in the
- <filename>docs/</filename> directory and The Bugzilla Guide
- (This document :)
- </member>
- <member><emphasis>Email</emphasis>,
- Anything to do with email sent by Bugzilla.
- <filename>processmail</filename>
- </member>
- <member><emphasis>Installation</emphasis>,
- The installation process of Bugzilla. This includes
- <filename>checksetup.pl</filename> and whatever else it evolves into.
- </member>
- <member><emphasis>Query/Buglist</emphasis>,
- Anything to do with searching for bugs and viewing the buglists.
- <filename>query.cgi</filename> and
- <filename>buglist.cgi</filename>
- </member>
- <member><emphasis>Reporting/Charting</emphasis>,
- Getting reports from Bugzilla.
- <filename>reports.cgi</filename> and
- <filename>duplicates.cgi</filename>
- </member>
- <member><emphasis>User Accounts</emphasis>,
- Anything about managing a user account from the user's perspective.
- <filename>userprefs.cgi</filename>, saved queries, creating accounts,
- changing passwords, logging in, etc.
- </member>
- <member><emphasis>User Interface</emphasis>,
- General issues having to do with the user interface cosmetics (not
- functionality) including cosmetic issues, HTML templates, etc.
- </member>
- </simplelist>
- </para>
- </informalexample>
- </example>
+ <emphasis>Priority</emphasis>:
+ The bug assignee uses this field to prioritise his or her bugs. It's
+ a good idea not to change this on other people's bugs.
</para>
+ </listitem>
+
+ <listitem>
<para>
- A "Milestone", or "Target Milestone" is a often a planned
- future "Version" of a product. In many cases, though,
- Milestones simply represent significant dates for a
- developer. Having certain features in your Product is
- frequently tied to revenue (money) the developer will
- receive if the features work by the time she reaches the
- Target Milestone. Target Milestones are a great tool to
- organize your time. If someone will pay you $100,000 for
- incorporating certain features by a certain date, those
- features by that Milestone date become a very high
- priority. Milestones tend to be highly malleable
- creatures, though, that appear to be in reach but are out
- of reach by the time the important day arrives.
+ <emphasis>Severity</emphasis>:
+ This indicates how severe the problem is - from blocker ("application
+ unusable") to trivial ("minor cosmetic issue"). You can also use this
+ field to indicate whether a bug is an enhancement request.
</para>
+ </listitem>
+
+ <listitem>
<para>
- The Bugzilla Project has set up Milestones for future
- Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc. However, a
- Target Milestone can just as easily be a specific date,
- code name, or weird alphanumeric combination, like "M19".
+ <emphasis>Target</emphasis>:
+ (a.k.a. Target Milestone) A future version by which the bug is to be
+ fixed. e.g. The Bugzilla Project's milestones for future
+ Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are
+ not restricted to numbers, thought - you can use any text strings,
+ such as dates.
</para>
- </listitem>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Reporter</emphasis>:
+ The person who filed the bug.
+ </para>
+ </listitem>
- <listitem>
+ <listitem>
<para>
- OK, now let's select the "Bugzilla" component from its scrollbox.
+ <emphasis>CC list</emphasis>:
+ A list of people who get mail when the bug changes.
</para>
- </listitem>
- <listitem>
+ </listitem>
+
+ <listitem>
<para>
- Skip down the page a bit -- do you see the "submit query" button?
- Select it, and let's run
- this query!
+ <emphasis>Attachments</emphasis>:
+ You can attach files (e.g. testcases or patches) to bugs. If there are
+ any attachments, they are listed in this section.
</para>
- </listitem>
- <listitem>
+ </listitem>
+
+ <listitem>
<para>
- Congratulations! You've completed your first Query, and
- have before you the Bug List of the author of this Guide,
- Matthew P. Barnson (barnboy@trilobyte.net). If I'm doing
- well, you'll have a cryptic "Zarro Boogs Found" message on
- your screen. It is just a happy hacker's way of saying
- "Zero Bugs Found". However, I am fairly certain I will
- always have some bugs assigned to me that aren't done yet,
- so you won't often see that message!
+ <emphasis>Dependencies</emphasis>:
+ If this bug cannot be fixed unless other bugs are fixed (depends on), or
+ this bug stops other bugs being fixed (blocks), their numbers are
+ recorded here.
</para>
- </listitem>
- </orderedlist>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Votes</emphasis>:
+ Whether this bug has any votes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Additional Comments</emphasis>:
+ You can add your two cents to the bug discussion here, if you have
+ something worthwhile to say.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
+ <section id="query">
+ <title>Searching for Bugs</title>
<para>
- I encourage you to click the bug numbers in the left-hand
- column and examine my bugs. Also notice that if you click the
- underlined links near the top of this page, they do not take
- you to context-sensitive help here, but instead sort the
- columns of bugs on the screen! When you need to sort your bugs
- by priority, severity, or the people they are assigned to,
- this is a tremendous timesaver.
+ The Bugzilla Search page is is the interface where you can
+ find any bug report, comment, or patch currently in the
+ Bugzilla system. You can play with it here:
+ <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">
+ landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>.
+ </para>
+
+ <para>
+ The Search page has controls for selecting different possible values
+ for all of the fields in a bug, as described above. Once you've defined
+ a search, you can either run it, or save it as a Remembered Query, which
+ can optionally appear in the footer of your pages.
+ </para>
+
+ <para>
+ Highly advanced querying is done using Boolean Charts, which have their
+ own <ulink url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">context-sensitive help</ulink>.
+ </para>
+
+ </section>
+
+ <section id="list">
+ <title>Bug Lists</title>
+ <para>
+ If you run a search, a list of matching bugs will be returned.
+ The default search is to return all open bugs on the system -
+ don't try running this search on a Bugzilla installation with
+ a lot of bugs!
</para>
<para>
- A couple more interesting things about the Bug List page:
+ The format of the list is configurable. For example, it can be
+ sorted by clicking the column headings. Other useful features
+ can be accessed using the links at the bottom of the list:
<simplelist>
- <member><emphasis>Change Columns</emphasis>: by selecting
- this link, you can show all kinds of information in the
- Bug List</member>
+ <member><emphasis>Long Format</emphasis>: this gives you a large page
+ with a non-editable summary of the fields of each bug.</member>
+ <member><emphasis>Change Columns</emphasis>: change the bug
+ attributes which appear in the list.</member>
<member><emphasis>Change several bugs at once</emphasis>: If
- you have sufficient rights to change all the bugs shown in
- the Bug List, you can mass-modify them. This is a big
- time-saver.</member>
- <member><emphasis>Send mail to bug owners</emphasis>: If you
- have many related bugs, you can request an update from
- every person who owns the bugs in the Bug List asking them
- the status.</member>
+ your account is sufficiently empowered, you can make the same
+ change to all the bugs in the list - for example, changing their
+ owner.</member>
+ <member><emphasis>Send mail to bug owners</emphasis>: Sends mail
+ to the owners of all bugs on the list.</member>
<member><emphasis>Edit this query</emphasis>: If you didn't
get exactly the results you were looking for, you can
return to the Query page through this link and make small
@@ -539,172 +472,54 @@ system against which all others are measured.
accurate results.</member>
</simplelist>
</para>
- <note>
- <para>
- There are many more options to the Bugzilla Query Page and
- the Bug List than I have shown you. But this should be
- enough for you to learn to get around. I encourage you to
- check out the <ulink
- url="http://www.mozilla.org/bugs/">Bugzilla Home Page</ulink> to learn about the Anatomy and Life Cycle of a Bug before continuing.
- </para>
- </note>
</section>
<section id="bugreports">
- <title>Creating and Managing Bug Reports</title>
+ <title>Filing Bugs</title>
<epigraph>
<para>And all this time, I thought we were taking bugs <emphasis>out</emphasis>...</para>
</epigraph>
- <section id="bug-writing">
- <title>Writing a Great Bug Report</title>
- <para>
- Before we plunge into writing your first bug report, I
- encourage you to read some bug-writing guidelines. If you
- are reading this document as part of a Bugzilla CVS checkout
- or un-tarred Bugzilla distribution, you should be able to
- read them by clicking <ulink
- url="../../bugwritinghelp.html">here</ulink>. If you are reading this online, check out the Mozilla.org bug-writing guidelines at <ulink url="http://www.mozilla.org/quality/bug-writing-guidelines.html">http://www.mozilla.org/quality/bug-writing-guidelines.html</ulink>. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
- </para>
- <para>
- While you are at it, why not learn how to find previously
- reported bugs? Mozilla.org has published a great tutorial
- on finding duplicate bugs, available at <ulink
- url="http://www.mozilla.org/quality/help/beginning-duplicate-finding.html"> http://www.mozilla.org/quality/help/beginning-duplicate-finding.html</ulink>.
- </para>
<para>
- I realize this was a lot to read. However, understanding
- the mentality of writing great bug reports will help us on
- the next part!
+ Years of bug writing experience has been distilled for your reading
+ pleasure into the <ulink url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html">
+ Bug Writing Guidelines</ulink>.
+While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
</para>
+ <para>
+ The procedure for filing a test bug is as follows:
+ </para>
+
<orderedlist>
<listitem>
<para>
- Go back to <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink> in your browser.
- </para>
- </listitem>
- <listitem>
- <para>
- Select the <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink> link.
+ Go to <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/">Landfill</ulink>
+ in your browser and click
+ <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink>.
</para>
</listitem>
<listitem>
<para>
- Select a product.
- </para>
- </listitem>
- <listitem>
- <para>
- Now you should be at the "Enter Bug" form. The
- "reporter" should have been automatically filled out for
- you (or else Bugzilla prompted you to Log In again --
- you did keep the email with your username and password,
- didn't you?).
- </para>
- </listitem>
- <listitem>
- <para>
- Select a Component in the scrollbox.
+ Select a product - any one will do.
</para>
</listitem>
<listitem>
<para>
+ Fill in the fields.
Bugzilla should have made reasonable guesses, based upon
your browser, for the "Platform" and "OS" drop-down
- boxes. If those are wrong, change them -- if you're on
- an SGI box running IRIX, we want to know!
- </para>
- </listitem>
- <listitem>
- <para>
- Fill in the "Assigned To" box with the email address you
- provided earlier. This way you don't end up sending
- copies of your bug to lots of other people, since it's
- just a test bug.
- </para>
- </listitem>
- <listitem>
- <para>
- Leave the "CC" text box blank. Fill in the "URL" box
- with "http://www.mozilla.org".
- </para>
- </listitem>
- <listitem>
- <para>
- Enter "The Bugzilla Guide" in the Summary text box, and
- place any comments you have on this tutorial, or the
- Guide in general, into the Description box.
- </para>
- </listitem>
- </orderedlist>
- <para>
- Voila! Select "Commit" and send in your bug report! Next
- we'll look at resolving bugs.
- </para>
- </section>
-
- <section id="bug-manage">
- <title>Managing your Bug Reports</title>
- <para>
- OK, you should have a link to the bug you just created near
- the top of your page. It should say "Bug XXXX posted", with
- a link to the right saying "Back to BUG# XXXX". Select this
- link.
- </para>
- <orderedlist>
- <listitem>
- <para>
- Scroll down a bit on the subsequent page, until you see
- the "Resolve bug, changing resolution to (dropdown box).
- Normally, you would "Accept bug (change status to
- ASSIGNED)", fix it, and then resolve. But in this case,
- we're going to short-circuit the process because this
- wasn't a real bug. Change the dropdown next to "Resolve
- Bug" to "INVALID", make sure the radio button is marked
- next to "Resolve Bug", then click "Commit".
+ boxes. If they are wrong, change them.
</para>
</listitem>
<listitem>
<para>
- Hey! It said it couldn't take the change in a big red
- box! That's right, you must specify a Comment in order
- to make this change. Select the "Back" button in your
- browser, add a Comment, then try Resolving the bug with
- INVALID status again. This time it should work.
+ Select "Commit" and send in your bug report.
</para>
</listitem>
- </orderedlist>
- <para>
- You have now learned the basics of Bugzilla navigation,
- entering a bug, and bug maintenance. I encourage you to
- explore these features, and see what you can do with them!
- We'll spend no more time on individual Bugs or Queries from
- this point on, so you are on your own there.
- </para>
- <para>
- But I'll give a few last hints!
- </para>
- <para>
- There is a <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/help.html">CLUE</ulink> on the Query page that will teach you more how to use the form.
- </para>
- <para>
- If you click the hyperlink on the <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/describecomponents.cgi">Component</ulink> box of the Query page, you will be presented a form that will describe what all the components are.
- </para>
- <para>
- Possibly the most powerful feature of the Query page is the
- <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">Boolean Chart</ulink> section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests.
- </para>
- <para>
- Finally, you can build some nifty <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/reports.cgi">Reports</ulink> using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page.
- </para>
- </section>
+ </orderedlist>
</section>
</section>