Bommels05/Mozilla
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merging new docs from 2.16 branch.

Browse Source 
git-svn-id: svn://10.0.0.236/trunk@125947 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
gerv%gerv.net
2002-07-27 22:01:14 +00:00
parent ed6384eef4
commit f88c3c8f3a
104 changed files with 23573 additions and 37683 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
mozilla/webtools/bugzilla/docs/xml/Bugzilla-Guide.xml
View File

@@ -16,7 +16,7 @@
<!ENTITY database SYSTEM "database.sgml">
<!ENTITY patches SYSTEM "patches.sgml">
<!ENTITY variants SYSTEM "variants.sgml">
<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml">
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.bugzilla.org/">
@@ -61,33 +61,35 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<title>The Bugzilla Guide</title>
<authorgroup>
<author>
<firstname>Matthew</firstname>
<othername>P.</othername>
<surname>Barnson</surname>
<affiliation>
<address><email>mbarnson@sisna.com</email></address>
</affiliation>
<firstname>Matthew</firstname>
<othername>P.</othername>
<surname>Barnson</surname>
</author>
<author>
<firstname>The</firstname>
<othername>Bugzilla</othername>
<surname>Team</surname>
</author>
</authorgroup>
<abstract>
<para>
This is the documentation for Bugzilla, the mozilla.org
bug-tracking system.
Bugzilla is an enterprise-class piece of software
that powers issue-tracking for hundreds of
organizations around the world, tracking millions of bugs.
This is the documentation for Bugzilla, the mozilla.org
bug-tracking system.
Bugzilla is an enterprise-class piece of software
that powers issue-tracking for hundreds of
organizations around the world, tracking millions of bugs.
</para>
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or SGML diffs, attached
to a Bugzilla bug.
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or SGML diffs, attached
to a bug filed in
<ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation">mozilla.org's Bugzilla</ulink>.
</para>
</abstract>
<keywordset>
<keyword>Bugzilla</keyword>
<keyword>Guide</keyword>
@@ -104,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- About This Guide -->
&about;
<!-- Introduction -->
&introduction;
<!-- Using Bugzilla -->
&using;
@@ -113,26 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Administering Bugzilla -->
&administration;
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
<!-- Major Bugzilla Variants -->
&variants;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
<!-- Appendix: Required Bugzilla Software Links -->
&requiredsoftware;
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Custom Patches -->
&patches;
<!-- Appendix: The GNU Free Documentation License -->
&gfdl;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Glossary -->
&glossary;

104
mozilla/webtools/bugzilla/docs/xml/about.xml
View File

@@ -4,40 +4,6 @@
<chapter id="about">
<title>About This Guide</title>
<section id="aboutthisguide">
<title>Purpose and Scope of this Guide</title>
<para>
Bugzilla is simply the best piece of bug-tracking software the
world has ever seen. This document is intended to be the
comprehensive guide to the installation, administration,
maintenance, and use of the Bugzilla bug-tracking system.
</para>
<para>
This release of the Bugzilla Guide is the
<emphasis>&bzg-ver;</emphasis> release. It is so named that it
may match the current version of Bugzilla. The numbering
tradition stems from that used for many free software projects,
in which <emphasis>even-numbered</emphasis> point releases (1.2,
1.14, etc.) are considered "stable releases", intended for
public consumption; on the other hand,
<emphasis>odd-numbered</emphasis> point releases (1.3, 2.09,
etc.) are considered unstable <emphasis>development</emphasis>
releases intended for advanced users, systems administrators,
developers, and those who enjoy a lot of pain.
</para>
<para>
Newer revisions of the Bugzilla Guide follow the numbering
conventions of the main-tree Bugzilla releases, available at
<ulink url="&bz;">&bz;</ulink>. Intermediate releases will have
a minor revision number following a period. The current version
of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
something were seriously wrong with that edition of the Guide,
subsequent releases would receive an additional dotted-decimal
digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
Got it? Good.
</para>
</section>
<section id="copyright">
<title>Copyright Information</title>
<blockquote>
@@ -48,8 +14,7 @@
License, Version 1.1 or any later version published by the
Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and with no Back-Cover Texts. A copy of
the license is included in the section entitled "GNU Free
Documentation License".
the license is included below.
</para>
</blockquote>
<para>
@@ -57,6 +22,11 @@
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;.
</para>
<!-- The GNU Free Documentation License -->
&gfdl;
</section>
<section id="disclaimer">
@@ -64,12 +34,11 @@
<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
As this is a new edition of this document, there may be errors
and inaccuracies that may damage your system. Use of this
document may cause your girlfriend to leave you, your cats to
pee on your furniture and clothing, your computer to cease
functioning, your boss to fire you, and global thermonuclear
war. Proceed with caution.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
pee on your furniture and clothing, and global thermonuclear
war. Proceed with caution.
</para>
<para>
All copyrights are held by their respective owners, unless
@@ -100,7 +69,7 @@
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
product, and are responsible for auditing it yourself to insure
product, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
@@ -110,7 +79,8 @@
<section id="newversions">
<title>New Versions</title>
<para>
This is the &bzg-ver; version of The Bugzilla Guide. If you are
This is the &bzg-ver; version of The Bugzilla Guide. It is so named
to match the current version of Bugzilla. If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
@@ -134,9 +104,16 @@
</itemizedlist>
</para>
<para>
The latest version of this document can be checked out via CVS.
Please follow the instructions available at <ulink
url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch.
The latest version of this document can always be checked out via CVS.
Please follow the instructions available at
<ulink url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>,
and check out the <filename>mozilla/webtools/bugzilla/docs/</filename>
subtree.
</para>
<para>
The Bugzilla Guide is currently only available in English.
If you would like to volunteer to translate it, please contact
<ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>.
</para>
</section>
@@ -144,13 +121,14 @@
<title>Credits</title>
<para>
The people listed below have made enormous contributions to the
creation of this Guide, through their dedicated hacking efforts,
creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
<para>
<ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink>
for pulling together the Bugzilla Guide and shepherding it to 2.14.
for the Herculaean task of pulling together the Bugzilla Guide and
shepherding it to 2.14.
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
@@ -158,13 +136,13 @@
README upon which the UNIX installation documentation is largely based.
</para>
<para>
<ulink url="mailto://tara@tequilarista.org">Tara
Hernandez</ulink> for keeping Bugzilla development going
strong after Terry left Mozilla.org
<ulink url="mailto://tara@tequilarista.org">Tara Hernandez</ulink>
for keeping Bugzilla development going
strong after Terry left mozilla.org
</para>
<para>
<ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for
providing insight into the key differences between Red Hat's
<ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink>
for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the "Red
Hat Bugzilla" appendix
</para>
@@ -174,8 +152,8 @@
questions and arguments on irc.mozilla.org in #mozwebtools
</para>
<para>
Last but not least, all the members of the <ulink
url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
Last but not least, all the members of the
<ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
</para>
<para>
Thanks also go to the following people for significant contributions
@@ -183,19 +161,7 @@
</para>
<para>
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
</para>
</section>
<section id="translations">
<title>Translations</title>
<para>
The Bugzilla Guide needs translators! Please volunteer your
translation into the language of your choice. If you will
translate this Guide, please notify the members of the
mozilla-webtools mailing list at
<email>mozilla-webtools@mozilla.org</email>, and arrange with
&bzg-auth; to check it into CVS.
Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
</para>
</section>

1628
mozilla/webtools/bugzilla/docs/xml/administration.xml
View File

File diff suppressed because it is too large Load Diff

15
mozilla/webtools/bugzilla/docs/xml/conventions.xml
View File

@@ -6,7 +6,7 @@
<primary>conventions</primary>
</indexterm>
<para>This document uses the following conventions</para>
<para>This document uses the following conventions:</para>
<informaltable frame="none">
<tgroup cols="2">
@@ -34,7 +34,7 @@
<entry>
<tip>
<para>Warm jar lids under the hot tap to loosen them.</para>
<para>Would you like a breath mint?</para>
</tip>
</entry>
</row>
@@ -63,7 +63,7 @@
<entry>File Names</entry>
<entry>
<filename>file.extension</filename>
<filename>filename</filename>
</entry>
</row>
@@ -138,12 +138,9 @@
<entry>Code Example</entry>
<entry>
<programlisting>
<sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag>
</programlisting>
<programlisting><sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag></programlisting>
</entry>
</row>
</tbody>

466
mozilla/webtools/bugzilla/docs/xml/database.xml
View File

@@ -123,10 +123,10 @@
! You should have locked your security down like the installation
instructions told you to. You can find details on locking down
your database in the Bugzilla FAQ in this directory (under
"Security"), or more robust security generalities in the MySQL
searchable documentation at
http://www.mysql.com/php/manual.php3?section=Privilege_system
.</para>
"Security"), or more robust security generalities in the
<ulink url="http://www.mysql.com/php/manual.php3?section=Privilege_system">MySQL
searchable documentation</ulink>.
</para>
</listitem>
<listitem>
@@ -150,13 +150,6 @@
<command>use bugs;</command>
</para>
<note>
<para>Don't forget the
<quote>;</quote>
at the end of each line, or you'll be kicking yourself
later.</para>
</note>
</listitem>
</orderedlist>
</para>
@@ -169,273 +162,212 @@
<para>
<prompt>mysql&gt;</prompt>
<command>show tables from bugs;</command>
</para>
<para>you'll be able to see all the
<para>you'll be able to see the names of all the
<quote>spreadsheets</quote>
(tables) in your database.</para>
(tables) in your database. It is similar to a file system, only
faster and more robust for certain types of operations.</para>
<para>From the command issued above, ou should have some
output that looks like this:
<programlisting>
+-------------------+
| Tables in bugs |
+-------------------+
| attachments |
| bugs |
| bugs_activity |
| cc |
| components |
| dependencies |
| fielddefs |
| groups |
| keyworddefs |
| keywords |
| logincookies |
| longdescs |
| milestones |
| namedqueries |
| products |
| profiles |
| profiles_activity |
| shadowlog |
| tokens |
| versions |
| votes |
| watch |
+-------------------+
</programlisting>
</para>
<para>From the command issued above, ou should have some output that
looks like this:
<programlisting>+-------------------+ | Tables in bugs |
+-------------------+ | attachments | | bugs | | bugs_activity | | cc
| | components | | dependencies | | fielddefs | | groups | |
keyworddefs | | keywords | | logincookies | | longdescs | |
milestones | | namedqueries | | products | | profiles | |
profiles_activity | | shadowlog | | tokens | | versions | | votes | |
watch | +-------------------+</programlisting>
</para>
<literallayout>
Here's an overview of what each table does. Most columns in each table have
descriptive names that make it fairly trivial to figure out their jobs.
<literallayout>Here's an overview of what each table does. Most
columns in each table have descriptive names that make it fairly
trivial to figure out their jobs. attachments: This table stores all
attachments to bugs. It tends to be your largest table, yet also
generally has the fewest entries because file attachments are so
(relatively) large. bugs: This is the core of your system. The bugs
table stores most of the current information about a bug, with the
exception of the info stored in the other tables. bugs_activity: This
stores information regarding what changes are made to bugs when -- a
history file. cc: This tiny table simply stores all the CC
information for any bug which has any entries in the CC field of the
bug. Note that, like most other tables in Bugzilla, it does not refer
to users by their user names, but by their unique userid, stored as a
primary key in the profiles table. components: This stores the
programs and components (or products and components, in newer
Bugzilla parlance) for Bugzilla. Curiously, the "program" (product)
field is the full name of the product, rather than some other unique
identifier, like bug_id and user_id are elsewhere in the database.
dependencies: Stores data about those cool dependency trees.
fielddefs: A nifty table that defines other tables. For instance,
when you submit a form that changes the value of "AssignedTo" this
table allows translation to the actual field name "assigned_to" for
entry into MySQL. groups: defines bitmasks for groups. A bitmask is a
number that can uniquely identify group memberships. For instance,
say the group that is allowed to tweak parameters is assigned a value
of "1", the group that is allowed to edit users is assigned a "2",
and the group that is allowed to create new groups is assigned the
bitmask of "4". By uniquely combining the group bitmasks (much like
the chmod command in UNIX,) you can identify a user is allowed to
tweak parameters and create groups, but not edit users, by giving him
a bitmask of "5", or a user allowed to edit users and create groups,
but not tweak parameters, by giving him a bitmask of "6" Simple, huh?
If this makes no sense to you, try this at the mysql prompt:
mysql&gt; select * from groups; You'll see the list, it makes much
more sense that way. keyworddefs: Definitions of keywords to be used
keywords: Unlike what you'd think, this table holds which keywords
are associated with which bug id's. logincookies: This stores every
login cookie ever assigned to you for every machine you've ever
logged into Bugzilla from. Curiously, it never does any housecleaning
-- I see cookies in this file I've not used for months. However,
since Bugzilla never expires your cookie (for convenience' sake), it
makes sense. longdescs: The meat of bugzilla -- here is where all
user comments are stored! You've only got 2^24 bytes per comment
(it's a mediumtext field), so speak sparingly -- that's only the
amount of space the Old Testament from the Bible would take
(uncompressed, 16 megabytes). Each comment is keyed to the bug_id to
which it's attached, so the order is necessarily chronological, for
comments are played back in the order in which they are received.
milestones: Interesting that milestones are associated with a
specific product in this table, but Bugzilla does not yet support
differing milestones by product through the standard configuration
interfaces. namedqueries: This is where everybody stores their
"custom queries". Very cool feature; it beats the tar out of having
to bookmark each cool query you construct. products: What products
you have, whether new bug entries are allowed for the product, what
milestone you're working toward on that product, votes, etc. It will
be nice when the components table supports these same features, so
you could close a particular component for bug entry without having
to close an entire product... profiles: Ahh, so you were wondering
where your precious user information was stored? Here it is! With the
passwords in plain text for all to see! (but sshh... don't tell your
users!) profiles_activity: Need to know who did what when to who's
profile? This'll tell you, it's a pretty complete history. shadowlog:
I could be mistaken here, but I believe this table tells you when
your shadow database is updated and what commands were used to update
it. We don't use a shadow database at our site yet, so it's pretty
empty for us. versions: Version information for every product votes:
Who voted for what when watch: Who (according to userid) is watching
who's bugs (according to their userid). === THE DETAILS === Ahh, so
you're wondering just what to do with the information above? At the
mysql prompt, you can view any information about the columns in a
table with this command (where "table" is the name of the table you
wish to view): mysql&gt; show columns from table; You can also view
all the data in a table with this command: mysql&gt; select * from
table; -- note: this is a very bad idea to do on, for instance, the
"bugs" table if you have 50,000 bugs. You'll be sitting there a while
until you ctrl-c or 50,000 bugs play across your screen. You can
limit the display from above a little with the command, where
"column" is the name of the column for which you wish to restrict
information: mysql&gt; select * from table where (column = "some
info"); -- or the reverse of this mysql&gt; select * from table where
(column != "some info"); Let's take our example from the
introduction, and assume you need to change the word "verified" to
"approved" in the resolution field. We know from the above
information that the resolution is likely to be stored in the "bugs"
table. Note we'll need to change a little perl code as well as this
database change, but I won't plunge into that in this document. Let's
verify the information is stored in the "bugs" table: mysql&gt; show
columns from bugs (exceedingly long output truncated here) |
bug_status|
enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL
| UNCONFIRMED|| Sorry about that long line. We see from this that the
"bug status" column is an "enum field", which is a MySQL peculiarity
where a string type field can only have certain types of entries.
While I think this is very cool, it's not standard SQL. Anyway, we
need to add the possible enum field entry 'APPROVED' by altering the
"bugs" table. mysql&gt; ALTER table bugs CHANGE bug_status bug_status
-&gt; enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
-&gt; "VERIFIED", "APPROVED", "CLOSED") not null; (note we can take
three lines or more -- whatever you put in before the semicolon is
evaluated as a single expression) Now if you do this: mysql&gt; show
columns from bugs; you'll see that the bug_status field has an extra
"APPROVED" enum that's available! Cool thing, too, is that this is
reflected on your query page as well -- you can query by the new
status. But how's it fit into the existing scheme of things? Looks
like you need to go back and look for instances of the word
"verified" in the perl code for Bugzilla -- wherever you find
"verified", change it to "approved" and you're in business (make sure
that's a case-insensitive search). Although you can query by the enum
field, you can't give something a status of "APPROVED" until you make
the perl changes. Note that this change I mentioned can also be done
by editing checksetup.pl, which automates a lot of this. But you need
to know this stuff anyway, right? I hope this database tutorial has
been useful for you. If you have comments to add, questions,
concerns, etc. please direct them to mbarnson@excitehome.net. Please
direct flames to /dev/null :) Have a nice day! === LINKS === Great
MySQL tutorial site:
http://www.devshed.com/Server_Side/MySQL/</literallayout>
attachments: This table stores all attachments to bugs. It tends to be your
largest table, yet also generally has the fewest entries because file
attachments are so (relatively) large.
bugs: This is the core of your system. The bugs table stores most of the
current information about a bug, with the exception of the info stored in the
other tables.
bugs_activity: This stores information regarding what changes are made to bugs
when -- a history file.
cc: This tiny table simply stores all the CC information for any bug which has
any entries in the CC field of the bug. Note that, like most other tables in
Bugzilla, it does not refer to users by their user names, but by their unique
userid, stored as a primary key in the profiles table.
components: This stores the programs and components (or products and
components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
(product) field is the full name of the product, rather than some other unique
identifier, like bug_id and user_id are elsewhere in the database.
dependencies: Stores data about those cool dependency trees.
fielddefs: A nifty table that defines other tables. For instance, when you
submit a form that changes the value of "AssignedTo" this table allows
translation to the actual field name "assigned_to" for entry into MySQL.
groups: defines bitmasks for groups. A bitmask is a number that can uniquely
identify group memberships. For instance, say the group that is allowed to
tweak parameters is assigned a value of "1", the group that is allowed to edit
users is assigned a "2", and the group that is allowed to create new groups is
assigned the bitmask of "4". By uniquely combining the group bitmasks (much
like the chmod command in UNIX,) you can identify a user is allowed to tweak
parameters and create groups, but not edit users, by giving him a bitmask of
"5", or a user allowed to edit users and create groups, but not tweak
parameters, by giving him a bitmask of "6" Simple, huh?
If this makes no sense to you, try this at the mysql prompt:
mysql> select * from groups;
You'll see the list, it makes much more sense that way.
keyworddefs: Definitions of keywords to be used
keywords: Unlike what you'd think, this table holds which keywords are
associated with which bug id's.
logincookies: This stores every login cookie ever assigned to you for every
machine you've ever logged into Bugzilla from. Curiously, it never does any
housecleaning -- I see cookies in this file I've not used for months. However,
since Bugzilla never expires your cookie (for convenience' sake), it makes
sense.
longdescs: The meat of bugzilla -- here is where all user comments are stored!
You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
sparingly -- that's only the amount of space the Old Testament from the Bible
would take (uncompressed, 16 megabytes). Each comment is keyed to the
bug_id to which it's attached, so the order is necessarily chronological, for
comments are played back in the order in which they are received.
milestones: Interesting that milestones are associated with a specific product
in this table, but Bugzilla does not yet support differing milestones by
product through the standard configuration interfaces.
namedqueries: This is where everybody stores their "custom queries". Very
cool feature; it beats the tar out of having to bookmark each cool query you
construct.
products: What products you have, whether new bug entries are allowed for the
product, what milestone you're working toward on that product, votes, etc. It
will be nice when the components table supports these same features, so you
could close a particular component for bug entry without having to close an
entire product...
profiles: Ahh, so you were wondering where your precious user information was
stored? Here it is! With the passwords in plain text for all to see! (but
sshh... don't tell your users!)
profiles_activity: Need to know who did what when to who's profile? This'll
tell you, it's a pretty complete history.
shadowlog: I could be mistaken here, but I believe this table tells you when
your shadow database is updated and what commands were used to update it. We
don't use a shadow database at our site yet, so it's pretty empty for us.
versions: Version information for every product
votes: Who voted for what when
watch: Who (according to userid) is watching who's bugs (according to their
userid).
===
THE DETAILS
===
Ahh, so you're wondering just what to do with the information above? At the
mysql prompt, you can view any information about the columns in a table with
this command (where "table" is the name of the table you wish to view):
mysql> show columns from table;
You can also view all the data in a table with this command:
mysql> select * from table;
-- note: this is a very bad idea to do on, for instance, the "bugs" table if
you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
50,000 bugs play across your screen.
You can limit the display from above a little with the command, where
"column" is the name of the column for which you wish to restrict information:
mysql> select * from table where (column = "some info");
-- or the reverse of this
mysql> select * from table where (column != "some info");
Let's take our example from the introduction, and assume you need to change
the word "verified" to "approved" in the resolution field. We know from the
above information that the resolution is likely to be stored in the "bugs"
table. Note we'll need to change a little perl code as well as this database
change, but I won't plunge into that in this document. Let's verify the
information is stored in the "bugs" table:
mysql> show columns from bugs
(exceedingly long output truncated here)
| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
Sorry about that long line. We see from this that the "bug status" column is
an "enum field", which is a MySQL peculiarity where a string type field can
only have certain types of entries. While I think this is very cool, it's not
standard SQL. Anyway, we need to add the possible enum field entry
'APPROVED' by altering the "bugs" table.
mysql> ALTER table bugs CHANGE bug_status bug_status
-> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
-> "VERIFIED", "APPROVED", "CLOSED") not null;
(note we can take three lines or more -- whatever you put in before the
semicolon is evaluated as a single expression)
Now if you do this:
mysql> show columns from bugs;
you'll see that the bug_status field has an extra "APPROVED" enum that's
available! Cool thing, too, is that this is reflected on your query page as
well -- you can query by the new status. But how's it fit into the existing
scheme of things?
Looks like you need to go back and look for instances of the word "verified"
in the perl code for Bugzilla -- wherever you find "verified", change it to
"approved" and you're in business (make sure that's a case-insensitive search).
Although you can query by the enum field, you can't give something a status
of "APPROVED" until you make the perl changes. Note that this change I
mentioned can also be done by editing checksetup.pl, which automates a lot of
this. But you need to know this stuff anyway, right?
</literallayout>
</section>
</section>
</section>
<section id="granttables">
<title>MySQL Permissions &amp; Grant Tables</title>
<note>
<para>The following portion of documentation comes from my answer to an
old discussion of Keystone, a cool product that does trouble-ticket
tracking for IT departments. I wrote this post to the Keystone support
group regarding MySQL grant table permissions, and how to use them
effectively. It is badly in need of updating, as I believe MySQL has
added a field or two to the grant tables since this time, but it serves
as a decent introduction and troubleshooting document for grant table
issues. I used Keynote to track my troubles until I discovered
Bugzilla, which gave me a whole new set of troubles to work on : )
Although it is of limited use, it still has SOME use, thus it's still
included.</para>
<para>Please note, however, that I was a relatively new user to MySQL
at the time. Some of my suggestions, particularly in how to set up
security, showed a terrible lack of security-related database
experience.</para>
</note>
<literallayout>From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999
Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson
matt_barnson@singletrac.com To: keystone-users@homeport.org Subject:
[keystone-users] Grant Tables FAQ [The following text is in the
"iso-8859-1" character set] [Your display is set for the "US-ASCII"
character set] [Some characters may be displayed incorrectly] Maybe we
can include this rambling message in the Keystone FAQ? It gets asked a
lot, and the only option current listed in the FAQ is
"--skip-grant-tables". Really, you can't go wrong by reading section 6 of
the MySQL manual, at http://www.mysql.com/Manual/manual.html. I am sure
their description is better than mine. MySQL runs fine without
permissions set up correctly if you run the mysql daemon with the
"--skip-grant-tables" option. Running this way denies access to nobody.
Unfortunately, unless you've got yourself firewalled it also opens the
potential for abuse if someone knows you're running it. Additionally, the
default permissions for MySQL allow anyone at localhost access to the
database if the database name begins with "test_" or is named "test"
(i.e. "test_keystone"). You can change the name of your database in the
keystone.conf file ($sys_dbname). This is the way I am doing it for some
of my databases, and it works fine. The methods described below assume
you're running MySQL on the same box as your webserver, and that you
don't mind if your $sys_dbuser for Keystone has superuser access. See
near the bottom of this message for a description of what each field
does. Method #1: 1. cd /var/lib #location where you'll want to run
/usr/bin/mysql_install_db shell script from to get it to work. 2. ln -s
mysql data # soft links the "mysql" directory to "data", which is what
mysql_install_db expects. Alternately, you can edit mysql_install_db and
change all the "./data" references to "./mysql". 3. Edit
/usr/bin/mysql_install_db with your favorite text editor (vi, emacs, jot,
pico, etc.) A) Copy the "INSERT INTO db VALUES
('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately
after itself. Chage the 'test\_%' value to 'keystone', or the value of
$sys_dbname in keystone.conf. B) If you are running your keystone
database with any user, you'll need to copy the "INSERT INTO user VALUES
('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line
after itself and change 'root' to the name of the keystone database user
($sys_dbuser) in keystone.conf. # adds entries to the script to create
grant tables for specific hosts and users. The user you set up has
super-user access ($sys_dbuser) -- you may or may not want this. The
layout of mysql_install_db is really very uncomplicated. 4.
/usr/bin/mysqladmin shutdown # ya gotta shut it down before you can
reinstall the grant tables! 5. rm -i /var/lib/mysql/mysql/*.IS?' and
answer 'Y' to the deletion questions. # nuke your current grant tables.
This WILL NOT delete any other databases than your grant tables. 6.
/usr/bin/mysql_install_db # run the script you just edited to install
your new grant tables. 7. mysqladmin -u root password (new_password) #
change the root MySQL password, or else anyone on localhost can login to
MySQL as root and make changes. You can skip this step if you want
keystone to connect as root with no password. 8. mysqladmin -u
(webserver_user_name) password (new_password) # change the password of
the $sys_dbuser. Note that you will need to change the password in the
keystone.conf file as well in $sys_dbpasswd, and if your permissions are
set up incorrectly anybody can type the URL to your keystone.conf file
and get the password. Not that this will help them much if your
permissions are set to @localhost. Method #2: easier, but a pain
reproducing if you have to delete your grant tables. This is the
"recommended" method for altering grant tables in MySQL. I don't use it
because I like the other way :) shell&gt; mysql --user=root keystone
mysql&gt; GRANT
SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS,
FILE, ON keystone.* TO &lt;$sys_dbuser name&gt;@localhost IDENTIFIED BY
'(password)' WITH GRANT OPTION; OR mysql&gt; GRANT ALL PRIVILEGES ON
keystone.* TO &lt;$sys_dbuser name&gt;@localhost IDENTIFIED BY
'(password)' WITH GRANT OPTION; # this grants the required permissions to
the keystone ($sys_dbuser) account defined in keystone.conf. However, if
you are runnning many different MySQL-based apps, as we are, it's
generally better to edit the mysql_install_db script to be able to
quickly reproduce your permissions structure again. Note that the FILE
privelege and WITH GRANT OPTION may not be in your best interest to
include. GRANT TABLE FIELDS EXPLANATION: Quick syntax summary: "%" in
MySQL is a wildcard. I.E., if you are defining your DB table and in the
'host' field and enter '%', that means that any host can access that
database. Of course, that host must also have a valid db user in order to
do anything useful. 'db'=name of database. In our case, it should be
"keystone". "user" should be your "$sys_dbuser" defined in keystone.conf.
Note that you CANNOT add or change a password by using the "INSERT INTO
db (X)" command -- you must change it with the mysql -u command as
defined above. Passwords are stored encrypted in the MySQL database, and
if you try to enter it directly into the table they will not match.
TABLE: USER. Everything after "password" is a privelege granted (Y/N).
This table controls individual user global access rights.
'host','user','password','select','insert','update','delete','index','alter'
,'create','drop','grant','reload','shutdown','process','file' TABLE: DB.
This controls access of USERS to databases.
'host','db','user','select','insert','update','delete','index','alter','crea
te','drop','grant' TABLE: HOST. This controls which HOSTS are allowed
what global access rights. Note that the HOST table, USER table, and DB
table are very closely connected -- if an authorized USER attempts an SQL
request from an unauthorized HOST, she's denied. If a request from an
authorized HOST is not an authorized USER, it is denied. If a globally
authorized USER does not have rights to a certain DB, she's denied. Get
the picture?
'host','db','select','insert','update','delete','index','alter','create','dr
op','grant' You should now have a working knowledge of MySQL grant
tables. If there is anything I've left out of this answer that you feel
is pertinent, or if my instructions don't work for you, please let me
know and I'll re-post this letter again, corrected. I threw it together
one night out of exasperation for all the newbies who don't know squat
about MySQL yet, so it is almost guaranteed to have errors. Once again,
you can't go wrong by reading section 6 of the MySQL manual. It is more
detailed than I! http://www.mysql.com/Manual/manual.html.</literallayout>
</section>
</appendix>
<!-- Keep this comment at the end of the file

263
mozilla/webtools/bugzilla/docs/xml/faq.xml
View File

@@ -3,6 +3,10 @@
<appendix id="faq">
<title>The Bugzilla FAQ</title>
<para>
This FAQ includes questions not covered elsewhere in the Guide.
</para>
<qandaset>
@@ -121,9 +125,9 @@
</question>
<answer>
<para>
A year has gone by, and I <emphasis>still</emphasis> can't
find any head-to-head comparisons of Bugzilla against
other defect-tracking software. However, from my personal
We can't find any head-to-head comparisons of Bugzilla against
other defect-tracking software. If you know of one, please
get in touch. However, from the author's personal
experience with other bug-trackers, Bugzilla offers
superior performance on commodity hardware, better price
(free!), more developer- friendly features (such as stored
@@ -133,24 +137,9 @@
</para>
<para>
If you happen to be a commercial bug-tracker vendor, please
step forward with a rebuttal so I can include it in the
FAQ. We're not in pursuit of Bugzilla ueber alles; we
simply love having a powerful, open-source tool to get our
jobs done.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
How do I change my user name (email address) in Bugzilla?
</para>
</question>
<answer>
<para>
New in 2.16 - go to the Account section of the Preferences. You will
be emailed at both addresses for confirmation.
step forward with a list of advantages your product has over
Bugzilla. We'd be happy to include it in the "Competitors"
section.
</para>
</answer>
</qandaentry>
@@ -184,7 +173,7 @@
<question>
<para>
Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL?
Oracle/Sybase/Msql/PostgreSQL/MSSQL.
</para>
</question>
<answer>
@@ -204,42 +193,41 @@
</question>
<answer>
<para>
Mozilla.org uses /usr/bonsaitools/bin/perl. The prime rule in making
submissions is "don't break bugzilla.mozilla.org". If it breaks it, your
patch will be reverted faster than you can do a diff.
</para>
<para>
Here's Terry Weissman's comment, for some historical context:
<blockquote>
<para>
[This was] purely my own convention. I wanted a place to put a version of
Perl and other tools that was strictly under my control for the
various webtools, and not subject to anyone else. Edit it to point
to whatever you like.
</para>
<note>
Mozilla.org uses /usr/bonsaitools/bin/perl, because originally
Terry wanted a place to put a version of Perl and other tools
that was strictly under his control.
</para>
<para>
We always recommend that, if possible, you keep the path
as /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools
and /usr/bonsaitools/bin directory, then symlink your version
of perl to /usr/bonsaitools/bin/perl. This will make upgrading
as /usr/bonsaitools/bin/perl, and simply add symlink.
This will make upgrading
your Bugzilla much easier in the future.
</para>
</note>
</blockquote>
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Is there an easy way to change the Bugzilla cookie name?
</para>
</question>
<answer>
<para>
At present, no.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-phb">
<title>Pointy-Haired-Boss Questions</title>
<title>Managerial Questions</title>
<para>
<note>
<para>
The title of this section doesn't mean you're a PHB -- it just means
you probably HAVE a PHB who wants to know this :)
Questions likely to be asked by managers. :-)
</para>
</note>
</para>
@@ -247,8 +235,8 @@
<qandaentry>
<question>
<para>
Is Bugzilla web-based or do you have to have specific software or
specific operating system on your machine?
Is Bugzilla web-based, or do you have to have specific software or
a specific operating system on your machine?
</para>
</question>
<answer>
@@ -262,7 +250,7 @@
<qandaentry>
<question>
<para>
Has anyone you know of already done any Bugzilla integration with
Can Bugzilla integrate with
Perforce (SCM software)?
</para>
</question>
@@ -282,11 +270,10 @@
</question>
<answer>
<para>
Absolutely! You can track up to a "soft-limit" of around
64 individual "Products", that can each be composed of as
many "Components" as you want. Check the Administration
section of the Bugzilla Guide for more information regarding
setting up Products and Components.
Absolutely! You can track any number of Products (although you
are limited to about 55 or so if
you are using Product-Based Groups), that can each be composed of any
number of Components.
</para>
</answer>
</qandaentry>
@@ -308,7 +295,7 @@
<qandaentry>
<question>
<para>
Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes,
Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
are there any that are NOT allowed?
</para>
</question>
@@ -346,19 +333,6 @@
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
The index.html page doesn't show the footer. It's really annoying to have
to go to the querypage just to check my "my bugs" link.
</para>
</question>
<answer>
<para>If you upgrade to 2.16, the index page has a footer.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
@@ -370,7 +344,7 @@
<para>
Yes. Look at <ulink url="http://bugzilla.mozilla.org/reports.cgi">
http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting
facilities.
and graphing facilities.
</para>
<para>
For more advanced reporting, I recommend hooking up a professional
@@ -387,7 +361,7 @@
<question>
<para>
Is there email notification and if so, what do you see when you get an
email? Do you see bug number and title or is it only the number?
email?
</para>
</question>
<answer>
@@ -416,7 +390,7 @@
<qandaentry>
<question>
<para>
If there is email notification, do users have to have any particular
Do users have to have any particular
type of email application?
</para>
</question>
@@ -438,24 +412,6 @@
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
If I just wanted to track certain bugs, as they go through life, can I
set it up to alert me via email whenever that bug changes, whether it be
owner, status or description etc.?
</para>
</question>
<answer>
<para>
Yes. Place yourself in the "cc" field of the bug you wish to monitor.
Then change your "Notify me of changes to" field in the Email Settings
tab of the User Preferences screen in Bugzilla to the "Only those
bugs which I am listed on the CC line" option.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
@@ -520,33 +476,6 @@
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Can a user re-run a report with a new project, same query?
</para>
</question>
<answer>
<para>
Yes.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Can a user modify an existing report and then save it into another name?
</para>
</question>
<answer>
<para>
You can save an unlimited number of queries in Bugzilla. You are free
to modify them and rename them to your heart's desire.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
@@ -562,20 +491,6 @@
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Can the admin person establish separate group and individual user
privileges?
</para>
</question>
<answer>
<para>
Yes.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
@@ -635,9 +550,8 @@
</question>
<answer>
<para>
If Bugzilla is set up correctly from the start, continuing maintenance needs
are minimal and can be completed by unskilled labor. Things like rotate
backup tapes and check log files for the word "error".
If Bugzilla is set up correctly from the start, continuing maintenance
needs are minimal and can be done easily using the web interface.
</para>
<para>
Commercial Bug-tracking software typically costs somewhere upwards
@@ -686,52 +600,6 @@
</qandaentry>
</qandadiv>
<qandadiv id="faq-install">
<title>Bugzilla Installation</title>
<qandaentry>
<question>
<para>
How do I download and install Bugzilla?
</para>
</question>
<answer>
<para>
Check <ulink url="http://www.bugzilla.org/">
http://www.bugzilla.org/</ulink> for details.
Read the other parts of this Guide for installation instructions.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
How do I install Bugzilla on Windows NT?
</para>
</question>
<answer>
<para>
Installation on Windows NT has its own section in
this document.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Is there an easy way to change the Bugzilla cookie name?
</para>
</question>
<answer>
<para>
At present, no.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-security">
<title>Bugzilla Security</title>
@@ -739,15 +607,14 @@
<question>
<para>
How do I completely disable MySQL security if it's giving me problems
(I've followed the instructions in the installation section of this guide!)?
(I've followed the instructions in the installation section of this guide)?
</para>
</question>
<answer>
<para>
Run MySQL like this: "mysqld --skip-grant-tables". Please remember <emphasis>this
makes MySQL as secure as taping a $100 to the floor of a football stadium
bathroom for safekeeping.</emphasis> Please read the Security section of the
Administration chapter of "The Bugzilla Guide" before proceeding.
bathroom for safekeeping.</emphasis>
</para>
</answer>
</qandaentry>
@@ -815,8 +682,8 @@
</question>
<answer>
<para>
Edit the "changedmail" param. Replace "To:" with "X-Real-To:",
replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)".
Edit the "changedmail" Param. Replace "To:" with "X-Real-To:",
replace "Cc:" with "X-Real-CC:", and add a "To: &lt;youremailaddress&gt;".
</para>
</answer>
</qandaentry>
@@ -1002,7 +869,7 @@
<qandaentry>
<question>
<para>
I think I've set up MySQL permissions correctly, but bugzilla still can't
I think I've set up MySQL permissions correctly, but Bugzilla still can't
connect.
</para>
</question>
@@ -1159,6 +1026,20 @@
<qandadiv id="faq-use">
<title>Bugzilla Usage</title>
<qandaentry>
<question>
<para>
How do I change my user name (email address) in Bugzilla?
</para>
</question>
<answer>
<para>
New in 2.16 - go to the Account section of the Preferences. You will
be emailed at both addresses for confirmation.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
@@ -1184,7 +1065,7 @@
<answer>
<para>
The current behavior is acceptable to bugzilla.mozilla.org and most
users. I personally don't like it. You have your choice of patches
users. You have your choice of patches
to change this behavior, however.
<simplelist>
<member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029">
@@ -1192,8 +1073,8 @@
<member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153">
"Accept" button automatically assigns to you</ulink></member>
</simplelist>
Note that these patches are somewhat dated. You will need to do the find
and replace manually to apply them. They are very small, though. It is easy.
Note that these patches are somewhat dated. You will need to apply
them manually.
</para>
</answer>
</qandaentry>
@@ -1224,7 +1105,7 @@
<answer>
<para>
Yup. Just rename it once you download it, or save it under a different
filename. This will not be fixed anytime too soon, because it would
filename. This will not be fixed anytime soon, because it would
cripple some other functionality.
</para>
</answer>
@@ -1288,9 +1169,7 @@
http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy
as adding the "---" priority field to your localconfig file in the appropriate area,
re-running checksetup.pl, and then changing the default priority in your browser using
"editparams.cgi". Hmm, now that I think about it, that is kind of a klunky way to handle
it, but for now it's what we have! Although the bug has been closed "RESOLVED WONTFIX",
there may be a better way to handle this...
"editparams.cgi".
</para>
</answer>
</qandaentry>
@@ -1325,7 +1204,7 @@
<listitem>
<para>
Announce your patch and the associated URL
(http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in
(http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for discussion in
the newsgroup (netscape.public.mozilla.webtools). You'll get a really
good, fairly immediate reaction to the implications of your patch,
which will also give us an idea how well-received the change would

54
mozilla/webtools/bugzilla/docs/xml/gfdl.xml
View File

@@ -1,10 +1,10 @@
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="gfdl">
<section id="gfdl">
<title>GNU Free Documentation License</title>
<!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
<!-- sect1>
<!-- section>
<title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para>
@@ -15,7 +15,7 @@
not allowed.</para>
</blockquote>
<sect1 label="0" id="gfdl-0">
<section label="0" id="gfdl-0">
<title>PREAMBLE</title>
<para>The purpose of this License is to make a manual, textbook, or other
@@ -38,9 +38,9 @@
can be used for any textual work, regardless of subject matter or whether
it is published as a printed book. We recommend this License principally
for works whose purpose is instruction or reference.</para>
</sect1>
</section>
<sect1 label="1" id="gfdl-1">
<section label="1" id="gfdl-1">
<title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that contains a
@@ -98,9 +98,9 @@
which do not have any title page as such, "Title Page" means the text
near the most prominent appearance of the work's title, preceding the
beginning of the body of the text.</para>
</sect1>
</section>
<sect1 label="2" id="gfdl-2">
<section label="2" id="gfdl-2">
<title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium, either
@@ -115,9 +115,9 @@
<para>You may also lend copies, under the same conditions stated above,
and you may publicly display copies.</para>
</sect1>
</section>
<sect1 label="3" id="gfdl-3">
<section label="3" id="gfdl-3">
<title>COPYING IN QUANTITY</title>
<para>If you publish printed copies of the Document numbering more than
@@ -154,9 +154,9 @@
the Document well before redistributing any large number of copies, to
give them a chance to provide you with an updated version of the
Document.</para>
</sect1>
</section>
<sect1 label="4" id="gfdl-4">
<section label="4" id="gfdl-4">
<title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the Document
@@ -284,9 +284,9 @@
<para>The author(s) and publisher(s) of the Document do not by this
License give permission to use their names for publicity for or to assert
or imply endorsement of any Modified Version.</para>
</sect1>
</section>
<sect1 label="5" id="gfdl-5">
<section label="5" id="gfdl-5">
<title>COMBINING DOCUMENTS</title>
<para>You may combine the Document with other documents released under
@@ -310,9 +310,9 @@
"History"; likewise combine any sections entitled "Acknowledgements", and
any sections entitled "Dedications". You must delete all sections
entitled "Endorsements."</para>
</sect1>
</section>
<sect1 label="6" id="gfdl-6">
<section label="6" id="gfdl-6">
<title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and other
@@ -326,9 +326,9 @@
distribute it individually under this License, provided you insert a copy
of this License into the extracted document, and follow this License in
all other respects regarding verbatim copying of that document.</para>
</sect1>
</section>
<sect1 label="7" id="gfdl-7">
<section label="7" id="gfdl-7">
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other
@@ -345,9 +345,9 @@
the entire aggregate, the Document's Cover Texts may be placed on covers
that surround only the Document within the aggregate. Otherwise they must
appear on covers around the whole aggregate.</para>
</sect1>
</section>
<sect1 label="8" id="gfdl-8">
<section label="8" id="gfdl-8">
<title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may
@@ -360,9 +360,9 @@
License. In case of a disagreement between the translation and the
original English version of this License, the original English version
will prevail.</para>
</sect1>
</section>
<sect1 label="9" id="gfdl-9">
<section label="9" id="gfdl-9">
<title>TERMINATION</title>
<para>You may not copy, modify, sublicense, or distribute the Document
@@ -372,9 +372,9 @@
who have received copies, or rights, from you under this License will not
have their licenses terminated so long as such parties remain in full
compliance.</para>
</sect1>
</section>
<sect1 label="10" id="gfdl-10">
<section label="10" id="gfdl-10">
<title>FUTURE REVISIONS OF THIS LICENSE</title>
<para>The Free Software Foundation may publish new, revised versions of
@@ -394,9 +394,9 @@
Software Foundation. If the Document does not specify a version number of
this License, you may choose any version ever published (not as a draft)
by the Free Software Foundation.</para>
</sect1>
</section>
<sect1 label="" id="gfdl-howto">
<section label="" id="gfdl-howto">
<title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include a copy
@@ -422,8 +422,8 @@
recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit their
use in free software.</para>
</sect1>
</appendix>
</section>
</section>
<!-- Keep this comment at the end of the file
Local variables:

87
mozilla/webtools/bugzilla/docs/xml/glossary.xml
View File

@@ -15,10 +15,7 @@
to keep secret files which would otherwise
compromise your installation - e.g. the
<filename>localconfig</filename>
file contains the password to your database. If this information were
generally available, and remote access to your database turned on,
you risk corruption of your database by computer criminals or the
file contains the password to your database.
curious.</para>
</glossdef>
</glossentry>
@@ -56,7 +53,7 @@
<glossdef>
<para>A
<quote>Bug</quote>
<quote>bug</quote>
in Bugzilla refers to an issue entered into the database which has an
associated number, assignments, comments, etc. Some also refer to a
@@ -71,33 +68,19 @@
<glossterm>Bug Number</glossterm>
<glossdef>
<para>Each Bugzilla Bug is assigned a number that uniquely identifies
that Bug. The Bug associated with a Bug Number can be pulled up via a
<para>Each Bugzilla bug is assigned a number that uniquely identifies
that bug. The bug associated with a bug number can be pulled up via a
query, or easily from the very front page by typing the number in the
"Find" box.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Bug Life Cycle</glossterm>
<glossdef>
<para>A Bug has stages through which it must pass before becoming a
<quote>closed bug</quote>,
including acceptance, resolution, and verification. The
<quote>Bug Life Cycle</quote>
is moderately flexible according to the needs of the organization
using it, though.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Bugzilla</glossterm>
<glossdef>
<para>Bugzilla is the industry-standard bug tracking system. It is
quite popular among Open Source enthusiasts.</para>
<para>Bugzilla is the world-leading free software bug tracking system.
</para>
</glossdef>
</glossentry>
</glossdiv>
@@ -127,14 +110,11 @@
<acronym>CPAN</acronym>
stands for the
<quote>Comprehensive Perl Archive Network</quote>
. CPAN maintains a large number of extremely useful
<quote>Comprehensive Perl Archive Network</quote>.
CPAN maintains a large number of extremely useful
<glossterm>Perl</glossterm>
modules. By themselves, Perl modules generally do nothing, but when
used as part of a larger program, they provide much-needed algorithms
and functionality.</para>
modules - encapsulated chunks of code for performing a
particular task.</para>
</glossdef>
</glossentry>
</glossdiv>
@@ -169,33 +149,16 @@
<quote>Groups</quote>
has a very special meaning to Bugzilla. Bugzilla's main security
mechanism comes by lumping users into groups, and assigning those
groups certain privileges to
mechanism comes by placing users in groups, and assigning those
groups certain privileges to view bugs in particular
<glossterm>Products</glossterm>
and
<glossterm>Components</glossterm>
in the
<glossterm>Bugzilla</glossterm>
database.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-i">
<title>I</title>
<glossentry id="gloss-infiniteloop">
<glossterm>Infinite Loop</glossterm>
<glossdef>
<para>A loop of information that never ends; see recursion.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-m">
<title>M</title>
@@ -221,10 +184,11 @@
<glossterm id="gloss-product">Product</glossterm>
<glossdef>
<para>A Product is a broad category of types of bugs. In general,
there are several Components to a Product. A Product may also define a
<para>A Product is a broad category of types of bugs, normally
representing a single piece of software or entity. In general,
there are several Components to a Product. A Product may define a
group (used for security) for all bugs entered into
components beneath it.</para>
its Components.</para>
</glossdef>
</glossentry>
@@ -262,24 +226,7 @@
bugs over their life cycle, thus the need for the
<quote>QA Contact</quote>
field in a Bug.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-r">
<title>R</title>
<glossentry id="gloss-recursion" xreflabel="Recursion">
<glossterm>Recursion</glossterm>
<glossdef>
<para>The property of a function looking back at itself for
something.
<quote>GNU</quote>, for instance, stands for
<quote>GNU's Not UNIX</quote>,
thus recursing upon itself for definition. For further clarity, see
Infinite Loop.</para>
field in a bug.</para>
</glossdef>
</glossentry>
</glossdiv>

3836
mozilla/webtools/bugzilla/docs/xml/installation.xml
View File

File diff suppressed because it is too large Load Diff

41
mozilla/webtools/bugzilla/docs/xml/integration.xml
View File

@@ -1,6 +1,6 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB -->
<chapter id="integration">
<section id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai"
@@ -13,43 +13,32 @@
. Using Bonsai, administrators can control open/closed status of trees,
query a fast relational database back-end for change, branch, and comment
information, and view changes made since the last time the tree was
closed. These kinds of changes cause the engineer responsible to be
<quote>on the hook</quote>
(include cool URL link here for Hook policies at mozilla.org). Bonsai
also includes gateways to
<xref linkend="tinderbox" />
and Bugzilla</para>
closed. Bonsai
also integrates with
<xref linkend="tinderbox" />.
</para>
</section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<title>CVS</title>
<para>CVS integration is best accomplished, at this point, using the
Bugzilla Email Gateway. There have been some files submitted to allow
greater CVS integration, but we need to make certain that Bugzilla is not
tied into one particular software management package.</para>
Bugzilla Email Gateway.</para>
<para>Follow the instructions in the FAQ for enabling Bugzilla e-mail
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to your
Bugzilla e-mail gateway with the subject of
<quote>[Bug XXXX]</quote>
, and you can have CVS check-in comments append to your Bugzilla bug. If
<quote>[Bug XXXX]</quote>,
and you can have CVS check-in comments append to your Bugzilla bug. If
you have your check-in script include an @resolution field, you can even
change the Bugzilla bug state.</para>
<para>There is also a project, based upon somewhat dated Bugzilla code,
to integrate CVS and Bugzilla through CVS' ability to email. Check it out
at:
<para>There is also a CVSZilla project, based upon somewhat dated
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at:
<ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>
, under the
<quote>cvszilla</quote>
link.</para>
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>.
</para>
</section>
<section id="scm"
@@ -86,7 +75,7 @@
<para>We need Tinderbox integration information.</para>
</section>
</chapter>
</section>
<!-- Keep this comment at the end of the file
Local variables:

241
mozilla/webtools/bugzilla/docs/xml/patches.xml
View File

@@ -26,160 +26,54 @@
setting up your VirtualHost section for Bugzilla with a rule like
this:</para>
<programlisting>
<![CDATA[
<programlisting><![CDATA[
<VirtualHost 12.34.56.78>
RewriteEngine On
RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</VirtualHost>
]]>
</programlisting>
]]></programlisting>
</listitem>
<listitem>
<para>There are many, many more things you can do with mod_rewrite.
As time goes on, I will include many more in the Guide. For now,
though, please refer to the mod_rewrite documentation at
<ulink url="http://www.apache.org">http://www.apache.org</ulink>
Please refer to the mod_rewrite documentation at
<ulink url="http://www.apache.org">http://www.apache.org</ulink>.
</para>
</listitem>
</orderedlist>
</section>
<section id="setperl" xreflabel="The setperl.csh Utility">
<title>The setperl.csh Utility</title>
<para>You can use the "setperl.csh" utility to quickly and easily change
the path to perl on all your Bugzilla files. This is a C-shell script; if
you do not have "csh" or "tcsh" in the search path on your system, it
will not work!</para>
<procedure>
<step>
<para>Download the "setperl.csh" utility to your Bugzilla directory
and make it executable.</para>
<substeps>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>cd /your/path/to/bugzilla</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>wget -O setperl.csh
'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod u+x setperl.csh</command>
</computeroutput>
</para>
</step>
</substeps>
</step>
<step>
<para>Prepare (and fix) Bugzilla file permissions.</para>
<substeps>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod u+w *</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod u+x duplicates.cgi</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod a-x bug_status.html</command>
</computeroutput>
</para>
</step>
</substeps>
</step>
<step>
<para>Run the script:</para>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>./setperl.csh /your/path/to/perl</command>
</computeroutput>
<example>
<title>Using Setperl to set your perl path</title>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>./setperl.csh /usr/bin/perl</command>
</computeroutput>
</para>
</example>
</para>
</step>
</procedure>
</section>
<section id="cmdline">
<title>Command-line Bugzilla Queries</title>
<para>Users can query Bugzilla from the command line using this suite of
utilities.</para>
<para>The query.conf file contains the mapping from options to field
<para>There are a suite of Unix utilities for querying Bugzilla from the
command line. They live in the
<filename class="directory">contrib/cmdline</filename>
directory. However, they
have not yet been updated to work with 2.16 (post-templatisation.).
There are three files - <filename>query.conf</filename>,
<filename>buglist</filename> and <filename>bugs</filename>.</para>
<para><filename>query.conf</filename>
contains the mapping from options to field
names and comparison types. Quoted option names are "grepped" for, so it
should be easy to edit this file. Comments (#) have no effect; you must
make sure these lines do not contain any quoted "option"</para>
make sure these lines do not contain any quoted "option".</para>
<para>buglist is a shell script which submits a Bugzilla query and writes
<para><filename>buglist</filename>
is a shell script which submits a Bugzilla query and writes
the resulting HTML page to stdout. It supports both short options, (such
as "-Afoo" or "-Rbar") and long options (such as "--assignedto=foo" or
"--reporter=bar"). If the first character of an option is not "-", it is
treated as if it were prefixed with "--default=".</para>
<para>The columlist is taken from the COLUMNLIST environment variable.
<para>The column list is taken from the COLUMNLIST environment variable.
This is equivalent to the "Change Columns" option when you list bugs in
buglist.cgi. If you have already used Bugzilla, use
<command>grep COLUMLIST ~/.netscape/cookies</command>
buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST
in your cookies file to see your current COLUMNLIST setting.</para>
to see your current COLUMNLIST setting.</para>
<para>bugs is a simple shell script which calls buglist and extracts the
<para><filename>bugs</filename> is a simple shell script which calls
<filename>buglist</filename> and extracts the
bug numbers from the output. Adding the prefix
"http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into
a working link if any bugs are found. Counting bugs is easy. Pipe the
@@ -187,100 +81,13 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
</para>
<para>Akkana says she has good results piping buglist output through
<para>Akkana Peck says she has good results piping
<filename>buglist</filename> output through
<command>w3m -T text/html -dump</command>
</para>
<procedure>
<step>
<para>Download three files:</para>
<substeps>
<step>
<para>
<computeroutput>
<prompt>bash$</prompt>
<command>wget -O query.conf
'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash$</prompt>
<command>wget -O buglist
'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>wget -O bugs
'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command>
</computeroutput>
</para>
</step>
</substeps>
</step>
<step>
<para>Make your utilities executable:
<computeroutput>
<prompt>bash$</prompt>
<command>chmod u+x buglist bugs</command>
</computeroutput>
</para>
</step>
</procedure>
</section>
<section id="quicksearch">
<title>The Quicksearch Utility</title>
<para>Quicksearch is a new, experimental feature of the 2.12 release. It
consist of two Javascript files, "quicksearch.js" and "localconfig.js",
and two documentation files, "quicksearch.html" and
"quicksearchhack.html"</para>
<para>The index.html page has been updated to include the QuickSearch
text box.</para>
<para>To take full advantage of the query power, the Bugzilla maintainer
must edit "localconfig.js" according to the value sets used in the local
installation.</para>
<para>Currently, keywords must be hard-coded in localconfig.js. If they
are not, keywords are not automatically recognized. This means, if
localconfig.js is left unconfigured, that searching for a bug with the
"foo" keyword will only find bugs with "foo" in the summary, status
whiteboard, product or component name, but not those with the keyword
"foo".</para>
<para>Workarounds for Bugzilla users:
<simplelist>
<member>search for '!foo' (this will find only bugs with the keyword
"foo"</member>
<member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member>
</simplelist>
</para>
<para>When this tool is ported from client-side JavaScript to server-side
Perl, the requirement for hard-coding keywords can be fixed.
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This
bug</ulink>
has details.</para>
</section>
</appendix>
<!-- Keep this comment at the end of the file

409
mozilla/webtools/bugzilla/docs/xml/using.xml
View File

@@ -1,167 +1,16 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<!-- TOC
Chapter: Using Bugzilla
Create an account
Logging in
Setting up preferences
Account Settings
Email Settings
Page Footer
Permissions
Life cycle of a bug
Creating a bug
Checking for duplicates
Overview of all bug fields
Setting bug permissions
The Query Interface
Standard Queries
Email Queries
Boolean Queries
Regexp Queries
The Query Results
Changing Columns
Changing sorting order
Mass changes
Miscellaneous usage hints
-->
<chapter id="using">
<title>Using Bugzilla</title>
<section id="whatis">
<title>What is Bugzilla?</title>
<para>Bugzilla is one example of a class of programs called "Defect
Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
Tracking Systems allow individual or groups of developers to keep track
of outstanding bugs in their product effectively. Bugzilla was originally
written by Terry Weissman in a programming language called "TCL", to
replace a crappy bug-tracking database used internally by Netscape
Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
it remains to this day. Most commercial defect-tracking software vendors
at the time charged enormous licensing fees, and Bugzilla quickly became
a favorite of the open-source crowd (with its genesis in the open-source
browser project, Mozilla). It is now the de-facto standard
defect-tracking system against which all others are measured.</para>
<para>Bugzilla has matured immensely, and now boasts many advanced
features. These include:
<itemizedlist>
<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>
<section id="why">
<title>Why Should We Use Bugzilla?</title>
<para>For many years, defect-tracking software has remained principally
the domain of large software development houses. Even then, most shops
never bothered with bug-tracking software, and instead simply relied on
shared lists and email to monitor the status of defects. This procedure
is error-prone and tends to cause those bugs judged least significant by
developers to be dropped or ignored.</para>
<para>These days, many companies are finding that integrated
defect-tracking systems reduce downtime, increase productivity, and raise
customer satisfaction with their systems. Along with full disclosure, an
open bug-tracker allows manufacturers to keep in touch with their clients
and resellers, to communicate about problems effectively throughout the
data management chain. Many corporations have also discovered that
defect-tracking helps reduce costs by providing IT support
accountability, telephone support knowledge bases, and a common,
well-understood system for accounting for unusual system or software
issues.</para>
<para>But why should
<emphasis>you</emphasis>
use Bugzilla?</para>
<para>Bugzilla is very adaptable to various situations. Known uses
currently include IT support queues, Systems Administration deployment
management, chip design and development problem tracking (both
pre-and-post fabrication), and software and hardware bug tracking for
luminaries such as Redhat, Loki software, Linux-Mandrake, and VA Systems.
Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
provides a powerful, easy-to-use solution to configuration management and
replication problems</para>
<para>Bugzilla can dramatically increase the productivity and
accountability of individual employees by providing a documented workflow
and positive feedback for good performance. How many times do you wake up
in the morning, remembering that you were supposed to do
<emphasis>something</emphasis>
today, but you just can't quite remember? Put it in Bugzilla, and you
have a record of it from which you can extrapolate milestones, predict
product versions for integration, and by using Bugzilla's e-mail
integration features be able to follow the discussion trail that led to
critical decisions.</para>
<para>Ultimately, Bugzilla puts the power in your hands to improve your
value to your employer or business while providing a usable framework for
your natural attention to detail and knowledge store to flourish.</para>
</section>
<section id="how">
<title>How do I use Bugzilla?</title>
<para>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.</para>
<para>There is a Bugzilla test installation, called
<ulink url="http://landfill.tequilarista.org/">Landfill</ulink>
, which you are welcome to play with. However, it does not necessarily
<para>This section contains information for end-users of Bugzilla.
There is a Bugzilla test installation, called
<ulink url="http://landfill.bugzilla.org/">Landfill</ulink>,
which you are welcome to play with (if it's up.)
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>
@@ -173,8 +22,8 @@ Chapter: Using Bugzilla
Consult with the administrator responsible for your installation of
Bugzilla for the URL you 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>
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/">
http://landfill.bugzilla.org/bugzilla-tip/</ulink>
</para>
<orderedlist>
@@ -200,18 +49,17 @@ Chapter: Using Bugzilla
<listitem>
<para>Click the
<quote>Log In</quote>
link in the yellow area at the bottom of the page in your browser,
enter your email address and password into the spaces provided, and
click
<quote>Login</quote>
.</para>
<quote>Login</quote>.
</para>
</listitem>
</orderedlist>
<para>You are now logged in. Bugzilla uses cookies for authentication,
so (unless your IP address changes) you should not have to log in
<para>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>
@@ -221,75 +69,65 @@ Chapter: Using Bugzilla
<para>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">
url="http://landfill.bugzilla.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;
is a good example. Note that the labels for most fields are hyperlinks;
clicking them will take you to context-sensitive help on that
particular field.</para>
particular field. Fields marked * may not be present on every
installation of Bugzilla.</para>
<orderedlist>
<listitem>
<para>
<emphasis>Product and Component</emphasis>
: Bugs are divided up by Product and Component, with a Product
<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.</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.</member>
<member>
<emphasis>Documentation:</emphasis>
The Bugzilla documentation, including The Bugzilla Guide.</member>
<member>
<emphasis>Email:</emphasis>
Anything to do with email sent by Bugzilla.</member>
<member>
<emphasis>Installation:</emphasis>
The installation process of Bugzilla.</member>
<member>
<emphasis>Query/Buglist:</emphasis>
Anything to do with searching for bugs and viewing the
buglists.</member>
<member>
<emphasis>Reporting/Charting:</emphasis>
Getting reports from Bugzilla.</member>
<member>
<emphasis>User Accounts:</emphasis>
Anything about managing a user account from the user's perspective.
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>
@@ -301,46 +139,41 @@ Chapter: Using Bugzilla
<para>
<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
These define exactly what state the bug is in - from not even
being confirmed as a bug, through to being fixed and the fix
confirmed by Quality Assurance. The different possible values for
Status and Resolution on your installation should 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>
<emphasis>URL:</emphasis>
<emphasis>*URL:</emphasis>
A URL associated with the bug, if any.</para>
</listitem>
<listitem>
<para>
<emphasis>Summary:</emphasis>
A one-sentence summary of the problem.</para>
</listitem>
<listitem>
<para>
<emphasis>Status Whiteboard:</emphasis>
<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>
<para>
<emphasis>Keywords:</emphasis>
<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>
@@ -349,7 +182,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Platform and OS:</emphasis>
These indicate the computing environment where the bug was
found.</para>
</listitem>
@@ -357,7 +189,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<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
@@ -367,7 +198,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<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>
@@ -375,7 +205,6 @@ Chapter: Using Bugzilla
<listitem>
<para>
<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
@@ -384,8 +213,7 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Target:</emphasis>
<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
@@ -396,29 +224,25 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Reporter:</emphasis>
The person who filed the bug.</para>
</listitem>
<listitem>
<para>
<emphasis>CC list:</emphasis>
A list of people who get mail when the bug changes.</para>
</listitem>
<listitem>
<para>
<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>
<para>
<emphasis>Dependencies:</emphasis>
<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>
@@ -426,15 +250,13 @@ Chapter: Using Bugzilla
<listitem>
<para>
<emphasis>Votes:</emphasis>
<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>
@@ -447,8 +269,8 @@ Chapter: Using Bugzilla
<para>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>
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/query.cgi">
landfill.bugzilla.org/bugzilla-tip/query.cgi</ulink>
.</para>
@@ -460,7 +282,7 @@ Chapter: Using Bugzilla
<para>Highly advanced querying is done using Boolean Charts, which have
their own
<ulink
url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">
url="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html">
context-sensitive help</ulink>
.</para>
@@ -517,10 +339,9 @@ Chapter: Using Bugzilla
<para>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
url="http://landfill.bugzilla.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
@@ -532,15 +353,13 @@ Chapter: Using Bugzilla
<orderedlist>
<listitem>
<para>Go to
<ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
<ulink url="http://landfill.bugzilla.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>
url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi">
Enter a new bug report</ulink>.
</para>
</listitem>
<listitem>
@@ -560,29 +379,138 @@ Chapter: Using Bugzilla
</section>
</section>
<section id="init4me">
<section id="hintsandtips">
<title>Hints and Tips</title>
<para>This section distills some Bugzilla tips and best practices
that have been developed.</para>
<section>
<title>Autolinkification</title>
<para>Bugzilla comments are plain text - so posting HTML will result
in literal HTML tags rather than being interpreted by a browser.
However, Bugzilla will automatically make hyperlinks out of certain
sorts of text in comments. For example, the text
http://www.bugzilla.org will be turned into
<ulink url="http://www.bugzilla.org">http://www.bugzilla.org</ulink>.
Other strings which get linkified in the obvious manner are:
<simplelist>
<member>bug 12345</member>
<member>bug 23456, comment 53</member>
<member>attachment 4321</member>
<member>mailto:george@example.com</member>
<member>george@example.com</member>
<member>ftp://ftp.mozilla.org</member>
<member>Most other sorts of URL</member>
</simplelist>
</para>
<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
for the convenience of others.
</para>
</section>
<section id="quicksearch">
<title>Quicksearch</title>
<para>Quicksearch is a single-text-box query tool which uses
metacharacters to indicate what is to be searched. For example, typing
"<filename>foo|bar</filename>"
into Quicksearch would search for "foo" or "bar" in the
summary and status whiteboard of a bug; adding
"<filename>:BazProduct</filename>" would
search only in that product.
</para>
<para>You'll find the Quicksearch box on Bugzilla's
front page, along with a
<ulink url="../../quicksearch.html">Help</ulink>
link which details how to use it.</para>
</section>
<section id="commenting">
<title>Comments</title>
<para>If you are changing the fields on a bug, only comment if
either you have something pertinent to say, or Bugzilla requires it.
Otherwise, you may spam people unnecessarily with bug mail.
To take an example: a user can set up their account to filter out messages
where someone just adds themselves to the CC field of a bug
(which happens a lot.) If you come along, add yourself to the CC field,
and add a comment saying "Adding self to CC", then that person
gets a pointless piece of mail they would otherwise have avoided.
</para>
<para>
Don't use sigs in comments. Signing your name ("Bill") is acceptable,
particularly if you do it out of habit, but full mail/news-style
four line ASCII art creations are not.
</para>
</section>
<section id="attachments">
<title>Attachments</title>
<para>
Use attachments, rather than comments, for large chunks of ASCII data,
such as trace, debugging output files, or log files. That way, it doesn't
bloat the bug for everyone who wants to read it, and cause people to
receive fat, useless mails.
</para>
<para>Trim screenshots. There's no need to show the whole screen if
you are pointing out a single-pixel problem.
</para>
<para>Don't attach simple test cases (e.g. one HTML file, one
CSS file and an image) as a ZIP file. Instead, upload them in
reverse order and edit the referring file so that they point to the
attached files. This way, the test case works immediately
out of the bug.
</para>
</section>
<section>
<title>Filing Bugs</title>
<para>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</para>
<para>
You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</para>
<para>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</para>
</section>
</section>
<section id="userpreferences">
<title>User Preferences</title>
<para>You can customise various aspects of Bugzilla, via the "Edit prefs"
link in the page footer, once you have logged in, e.g. to
<ulink
url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1">
Landfill</ulink>
. The preferences are split into four tabs.</para>
<para>Once you have logged in, you can customise various aspects of
Bugzilla via the "Edit prefs" link in the page footer.
The preferences are split into four tabs:</para>
<section id="accountsettings" xreflabel="Account Settings">
<title>Account Settings</title>
<para>On this tab, you can change your basic Account Settings,
<para>On this tab, you can change your basic account information,
including your password, email address and real name. For security
reasons, in order to change anything on this page you must type your
<emphasis>current</emphasis>
password into the
<quote>Password</quote>
field. If you attempt to change your email address, a confirmation
field at the top of the page.
If you attempt to change your email address, a confirmation
email is sent to both the old and new addresses, with a link to use to
confirm the change. This helps to prevent account hijacking.</para>
</section>
@@ -600,28 +528,27 @@ Chapter: Using Bugzilla
"Users to watch" text entry box you can receive a copy of all the
bugmail of other users (security settings permitting.) This powerful
functionality enables seamless transitions as developers change
projects, managers wish to get in touch with the issues faced by their
direct reports, or users go on vacation.</para>
projects or users go on holiday.</para>
<note>
<para>This option may not be available in all Bugzilla installations.
Ask your administrator.</para>
<para>The ability to watch other users may not be available in all
Bugzilla installations. If you can't see it, ask your
administrator.</para>
</note>
</section>
<section id="footersettings">
<title>Page Footer</title>
<para>By default, this page is quite barren. However, if you explore
the Search page some more, you will find that you can store numerous
queries on the server, so if you regularly run a particular query it is
just a drop-down menu away. Once you have a stored query, you can come
<para>On the Search page, you can store queries in Bugzilla, so if you
regularly run a particular query it is just a drop-down menu away.
Once you have a stored query, you can come
here to request that it also be displayed in your page footer.</para>
</section>
<section id="permissionsettings">
<title>Permissions</title>
<para>This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you
are in, and whether you can edit bugs or perform various administration

66
mozilla/webtools/bugzilla/docs/xml/variants.xml
View File

@@ -1,5 +1,5 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">-->
<chapter id="variants" xreflabel="Bugzilla Variants and Competitors">
<appendix id="variants" xreflabel="Bugzilla Variants and Competitors">
<title>Bugzilla Variants and Competitors</title>
<para>I created this section to answer questions about Bugzilla competitors
@@ -13,13 +13,12 @@
<section id="rhbugzilla" xreflabel="Red Hat Bugzilla">
<title>Red Hat Bugzilla</title>
<para>Red Hat Bugzilla is probably the most popular Bugzilla variant on
the planet. One of the major benefits of Red Hat Bugzilla is the ability
<para>Red Hat Bugzilla is a fork of Bugzilla 2.8.
One of its major benefits is the ability
to work with Oracle, MySQL, and PostGreSQL databases serving as the
back-end, instead of just MySQL. Dave Lawrence has worked very hard to
keep Red Hat Bugzilla up-to-date, and many people prefer the
snappier-looking page layout of Red Hat Bugzilla to the default
Mozilla-standard formatting.</para>
back-end, instead of just MySQL. Dave Lawrence of Red Hat is
active in the Bugzilla community, and we hope to see a reunification
of the fork before too long.</para>
<para>URL:
<ulink url="http://bugzilla.redhat.com/bugzilla/">
@@ -30,38 +29,26 @@
<section id="variant-fenris" xreflabel="Loki Bugzilla, a.k.a. Fenris">
<title>Loki Bugzilla (Fenris)</title>
<para>Fenris can be found at
<ulink url="http://fenris.lokigames.com/">
http://fenris.lokigames.com</ulink>
. It is a fork from Bugzilla.</para>
<para>Fenris was a fork from Bugzilla made by Loki Games; when
Loki went into receivership, it died. While Loki's other code lives on,
its custodians recommend Bugzilla for future bug-tracker deployments.
</para>
</section>
<section id="variant-issuezilla" xreflabel="Issuezilla">
<title>Issuezilla</title>
<para>Issuezilla is another fork from Bugzilla, and seems nearly as
popular as the Red Hat Bugzilla fork. Some Issuezilla team members are
regular contributors to the Bugzilla mailing list/newsgroup. Issuezilla
is not the primary focus of bug-tracking at tigris.org, however. Their
Java-based bug-tracker,
<xref linkend="variant-scarab" />
, is under heavy development and looks promising!</para>
<para>URL:
<ulink url="http://issuezilla.tigris.org/servlets/ProjectHome">
http://issuezilla.tigris.org/servlets/ProjectHome</ulink>
</para>
<para>Issuezilla was another fork from Bugzilla, made by collab.net and
hosted at tigris.org. It is also dead; the primary focus of bug-tracking
at tigris.org is their Java-based bug-tracker,
<xref linkend="variant-scarab"/>.</para>
</section>
<section id="variant-scarab"
xreflabel="Scarab, a newfangled Java-based issue tracker">
<section id="variant-scarab" xreflabel="Scarab">
<title>Scarab</title>
<para>Scarab is a promising new bug-tracking system built using Java
Serlet technology. As of this writing, no source code has been released
as a package, but you can obtain the code from CVS.</para>
<para>Scarab is a new open source bug-tracking system built using Java
Serlet technology. It is currently at version 1.0 beta 8.</para>
<para>URL:
<ulink url="http://scarab.tigris.org/">http://scarab.tigris.org</ulink>
@@ -72,32 +59,29 @@
<title>Perforce SCM</title>
<para>Although Perforce isn't really a bug tracker, it can be used as
such through the
<quote>jobs</quote>
such through the <quote>jobs</quote>
functionality.</para>
<para>
<para>URL:
<ulink url="http://www.perforce.com/perforce/technotes/note052.html">
http://www.perforce.com/perforce/technotes/note052.html
</ulink>
http://www.perforce.com/perforce/technotes/note052.html</para>
</para>
</section>
<section id="variant-sourceforge" xreflabel="SourceForge">
<title>SourceForge</title>
<para>SourceForge is more of a way of coordinating geographically
distributed free software and open source projects over the Internet than
strictly a bug tracker, but if you're hunting for bug-tracking for your
open project, it may be just what the software engineer ordered!</para>
<para>SourceForge is a way of coordinating geographically
distributed free software and open source projects over the Internet.
It has a built-in bug tracker, but it's not highly thought of.</para>
<para>URL:
<ulink url="http://www.sourceforge.net">
http://www.sourceforge.net</ulink>
</para>
</section>
</chapter>
</appendix>
<!-- Keep this comment at the end of the file
Local variables: