зеркало из https://github.com/mozilla/gecko-dev.git
The source files for the Bugzilla Guide have long been using the XML version of DocBook but still residing in the sgml/ directory with an extension of .sgml.
In an effort to maintain CVS history, the raw files were copied on the CVS server to the xml/ directory and renamed to have .xml for the extension; any checkins before this one did have the .sgml extension.
This commit is contained in:
jake%bugzilla.org
Родитель
13e997dbf1
Коммит
4f6272ff24
|
|
@ -3,34 +3,32 @@ You'll find these directories and files here:
|
||||||
|
|
||||||
README.docs # This README file
|
README.docs # This README file
|
||||||
html/ # The compiled HTML docs from SGML sources (do not edit)
|
html/ # The compiled HTML docs from SGML sources (do not edit)
|
||||||
sgml/ # The original SGML doc sources (edit these)
|
xml/ # The original XML doc sources (edit these)
|
||||||
txt/ # The compiled text docs from SGML sources
|
txt/ # The compiled text docs from SGML sources
|
||||||
ps/ # The compiled PostScript docs from SGML sources
|
|
||||||
pdf/ # The compiled Adobe PDF docs from SGML sources
|
|
||||||
|
|
||||||
A note about SGML:
|
A note about the XML:
|
||||||
The documentation is written in DocBook 3.1/4.1 SGML, and attempts to adhere
|
The documentation is written in DocBook 4.1.2, and attempts to adhere
|
||||||
to the LinuxDoc standards everywhere applicable (http://www.linuxdoc.org).
|
to the LinuxDoc standards everywhere applicable (http://www.tldp.org).
|
||||||
Please consult "The LDP Author Guide" at linuxdoc.org for details on how
|
Please consult "The LDP Author Guide" at tldp.org for details on how
|
||||||
to set up your personal environment for compiling SGML files.
|
to set up your personal environment for compiling XML files.
|
||||||
If you need to make corrections to typographical errors, or other minor
|
If you need to make corrections to typographical errors, or other minor
|
||||||
editing duties, feel free to use any text editor to make the changes. SGML
|
editing duties, feel free to use any text editor to make the changes. XML
|
||||||
is not rocket science -- simply make sure your text appears between
|
is not rocket science -- simply make sure your text appears between
|
||||||
appropriate tags (like <para>This is a paragraph</para>) and we'll be fine.
|
appropriate tags (like <para>This is a paragraph</para>) and we'll be fine.
|
||||||
If you are making more extensive changes, please ensure you at least validate
|
If you are making more extensive changes, please ensure you at least validate
|
||||||
your SGML before checking it in with something like:
|
your XML before checking it in with something like:
|
||||||
nsgmls -s Bugzilla-Guide.sgml
|
nsgmls -s $JADE_PUB/xml.dcl Bugzilla-Guide.xml
|
||||||
|
|
||||||
When you validate, please validate the master document (Bugzilla-Guide.sgml)
|
When you validate, please validate the master document (Bugzilla-Guide.xml)
|
||||||
as well as the document you edited to ensure there are no critical errors.
|
as well as the document you edited to ensure there are no critical errors.
|
||||||
The following errors are considered "normal" when validating with nsgmls:
|
The following errors are considered "normal" when validating with nsgmls:
|
||||||
|
|
||||||
DTDDECL catalog entries are not supported
|
DTDDECL catalog entries are not supported
|
||||||
"DOCTYPE" declaration not allowed in instance
|
"DOCTYPE" declaration not allowed in instance
|
||||||
|
|
||||||
The reason these occur is that free sgml validators do not yet support
|
The reason these occur is that free sgml/xml validators do not yet support
|
||||||
the DTDDECL catalog entries, and I've included DOCTYPE declarations in
|
the DTDDECL catalog entries, and I've included DOCTYPE declarations in
|
||||||
entities referenced from Bugzilla-Guide.sgml so these entities can compile
|
entities referenced from Bugzilla-Guide.xml so these entities can compile
|
||||||
individually, if necessary. I suppose I ought to comment them out at some
|
individually, if necessary. I suppose I ought to comment them out at some
|
||||||
point, but for now they are convenient and don't hurt anything.
|
point, but for now they are convenient and don't hurt anything.
|
||||||
|
|
||||||
|
|
@ -39,13 +37,13 @@ documentation. Please address comments and questions to the newsgroup:
|
||||||
news://news.mozilla.org/netscape/public/mozilla/webtools .
|
news://news.mozilla.org/netscape/public/mozilla/webtools .
|
||||||
|
|
||||||
==========
|
==========
|
||||||
HOW TO SET UP YOUR OWN SGML EDITING ENVIRONMENT:
|
HOW TO SET UP YOUR OWN XML EDITING ENVIRONMENT:
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Trying to set up an SGML/XML Docbook editing environment the
|
Trying to set up an XML Docbook editing environment the
|
||||||
first time can be a daunting task.
|
first time can be a daunting task.
|
||||||
I use Linux-Mandrake, in part, because it has a fully-functional
|
I use Linux-Mandrake, in part, because it has a fully-functional
|
||||||
SGML/XML Docbook editing environment included as part of the
|
XML Docbook editing environment included as part of the
|
||||||
distribution CD's. If you have easier instructions for how to
|
distribution CD's. If you have easier instructions for how to
|
||||||
do this for a particular Linux distribution or platform, please
|
do this for a particular Linux distribution or platform, please
|
||||||
let the team know at the mailing list: mozilla-webtools@mozilla.org.
|
let the team know at the mailing list: mozilla-webtools@mozilla.org.
|
||||||
|
|
@ -74,9 +72,10 @@ sgml-common
|
||||||
|
|
||||||
If you're getting these from RedHat, make sure you get the ones in the
|
If you're getting these from RedHat, make sure you get the ones in the
|
||||||
rawhide area. The ones in the 7.2 distribution are too old and don't
|
rawhide area. The ones in the 7.2 distribution are too old and don't
|
||||||
include the XML stuff.
|
include the XML stuff. The packages distrubuted with RedHat 8.0 and 9
|
||||||
|
and known to work.
|
||||||
|
|
||||||
Download "ldp.dsl" from the Resources page on linuxdoc.org. This is the
|
Download "ldp.dsl" from the Resources page on tldp.org. This is the
|
||||||
stylesheet I use to get the HTML and text output. It works well, and has a
|
stylesheet I use to get the HTML and text output. It works well, and has a
|
||||||
nice, consistent look with the rest of the linuxdoc documents. You'll have to
|
nice, consistent look with the rest of the linuxdoc documents. You'll have to
|
||||||
adjust the paths in ldp.dsl at the top of the file to reflect the actual
|
adjust the paths in ldp.dsl at the top of the file to reflect the actual
|
||||||
|
|
@ -92,6 +91,8 @@ dsssl>
|
||||||
Note the difference is the top one points to the HTML docbook stylesheet,
|
Note the difference is the top one points to the HTML docbook stylesheet,
|
||||||
and the next one points to the PRINT docbook stylesheet.
|
and the next one points to the PRINT docbook stylesheet.
|
||||||
|
|
||||||
|
Also note that modifying ldp.dsl doesn't seem to be needed on RedHat 9.
|
||||||
|
|
||||||
You know, this sure looks awful involved. Anyway, once you have this in
|
You know, this sure looks awful involved. Anyway, once you have this in
|
||||||
place, add to your .bashrc:
|
place, add to your .bashrc:
|
||||||
export SGML_CATALOG_FILES=/etc/sgml/catalog
|
export SGML_CATALOG_FILES=/etc/sgml/catalog
|
||||||
|
|
@ -111,13 +112,16 @@ for tcsh users.
|
||||||
folders are anywhere else on your system (for example, the openjade version
|
folders are anywhere else on your system (for example, the openjade version
|
||||||
might change if you get a new version at some point).
|
might change if you get a new version at some point).
|
||||||
|
|
||||||
I suggest xemacs for editing your SGML/XML Docbook documents. The darn
|
I suggest xemacs for editing your XML Docbook documents. The darn
|
||||||
thing just works, and generally includes PSGML mode by default. Not to
|
thing just works, and generally includes PSGML mode by default. Not to
|
||||||
mention you can validate the SGML from right within it without having to
|
mention you can validate the SGML from right within it without having to
|
||||||
remember the command-line syntax for nsgml (not that it's that hard
|
remember the command-line syntax for nsgml (not that it's that hard
|
||||||
anyway). If not, you can download psgml at
|
anyway). If not, you can download psgml at
|
||||||
http://www.sourceforge.net/projects/psgml.
|
http://www.sourceforge.net/projects/psgml.
|
||||||
|
|
||||||
|
Another good editor is the latest releases of vim and gvim. Vim will
|
||||||
|
recognize DocBook tags and give them a different color than unreconized tags.
|
||||||
|
|
||||||
==========
|
==========
|
||||||
NOTES:
|
NOTES:
|
||||||
==========
|
==========
|
||||||
|
|
@ -125,15 +129,17 @@ NOTES:
|
||||||
Here are the commands I use to maintain this documentation.
|
Here are the commands I use to maintain this documentation.
|
||||||
You MUST have DocBook 4.1.2 set up correctly in order for this to work.
|
You MUST have DocBook 4.1.2 set up correctly in order for this to work.
|
||||||
|
|
||||||
|
These commands can be run all at once using the ./makedocs.pl script.
|
||||||
|
|
||||||
To create HTML documentation:
|
To create HTML documentation:
|
||||||
bash$ cd html
|
bash$ cd html
|
||||||
bash$ jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
|
bash$ jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
|
||||||
$JADE_PUB/xml.dcl ../sgml/Bugzilla-Guide.sgml
|
$JADE_PUB/xml.dcl ../xml/Bugzilla-Guide.xml
|
||||||
|
|
||||||
To create HTML documentation as a single big HTML file:
|
To create HTML documentation as a single big HTML file:
|
||||||
bash$ cd html
|
bash$ cd html
|
||||||
bash$ jade -V nochunks -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
|
bash$ jade -V nochunks -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
|
||||||
$JADE_PUB/xml.dcl ../sgml/Bugzilla-Guide.sgml >Bugzilla-Guide.html
|
$JADE_PUB/xml.dcl ../xml/Bugzilla-Guide.xml >Bugzilla-Guide.html
|
||||||
|
|
||||||
To create TXT documentation as a single big TXT file:
|
To create TXT documentation as a single big TXT file:
|
||||||
bash$ cd txt
|
bash$ cd txt
|
||||||
|
|
|
||||||
|
|
@ -70,9 +70,9 @@ chdir dirname($0);
|
||||||
chdir 'html';
|
chdir 'html';
|
||||||
|
|
||||||
MakeDocs('separate HTML', "jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html " .
|
MakeDocs('separate HTML', "jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html " .
|
||||||
"$JADE_PUB/xml.dcl ../sgml/Bugzilla-Guide.sgml");
|
"$JADE_PUB/xml.dcl ../xml/Bugzilla-Guide.xml");
|
||||||
MakeDocs('big HTML', "jade -V nochunks -t sgml -i html -d " .
|
MakeDocs('big HTML', "jade -V nochunks -t sgml -i html -d " .
|
||||||
"$LDP_HOME/ldp.dsl\#html $JADE_PUB/xml.dcl " .
|
"$LDP_HOME/ldp.dsl\#html $JADE_PUB/xml.dcl " .
|
||||||
"../sgml/Bugzilla-Guide.sgml > Bugzilla-Guide.html");
|
"../xml/Bugzilla-Guide.xml > Bugzilla-Guide.html");
|
||||||
MakeDocs('big text', "lynx -dump -justify=off -nolist Bugzilla-Guide.html " .
|
MakeDocs('big text', "lynx -dump -justify=off -nolist Bugzilla-Guide.html " .
|
||||||
"> ../txt/Bugzilla-Guide.txt");
|
"> ../txt/Bugzilla-Guide.txt");
|
||||||
|
|
|
||||||
|
|
@ -1,205 +0,0 @@
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [
|
|
||||||
|
|
||||||
<!-- Include macros -->
|
|
||||||
<!ENTITY about SYSTEM "about.sgml">
|
|
||||||
<!ENTITY conventions SYSTEM "conventions.sgml">
|
|
||||||
<!ENTITY doc-index SYSTEM "index.sgml">
|
|
||||||
<!ENTITY faq SYSTEM "faq.sgml">
|
|
||||||
<!ENTITY gfdl SYSTEM "gfdl.sgml">
|
|
||||||
<!ENTITY glossary SYSTEM "glossary.sgml">
|
|
||||||
<!ENTITY installation SYSTEM "installation.sgml">
|
|
||||||
<!ENTITY administration SYSTEM "administration.sgml">
|
|
||||||
<!ENTITY using SYSTEM "using.sgml">
|
|
||||||
<!ENTITY integration SYSTEM "integration.sgml">
|
|
||||||
<!ENTITY future SYSTEM "future.sgml">
|
|
||||||
<!ENTITY index SYSTEM "index.sgml">
|
|
||||||
<!ENTITY database SYSTEM "database.sgml">
|
|
||||||
<!ENTITY patches SYSTEM "patches.sgml">
|
|
||||||
<!ENTITY variants SYSTEM "variants.sgml">
|
|
||||||
<!ENTITY introduction SYSTEM "introduction.sgml">
|
|
||||||
<!ENTITY revhistory SYSTEM "revhistory.sgml">
|
|
||||||
|
|
||||||
<!-- Things to change for a stable release:
|
|
||||||
* bz-ver to current stable
|
|
||||||
* bz-nexver to next stable
|
|
||||||
* bz-date to the release date
|
|
||||||
* bz-devel to "IGNORE"
|
|
||||||
- COMPILE DOCS AND CHECKIN -
|
|
||||||
Also, tag and tarball before completing
|
|
||||||
* bz-ver to devel version
|
|
||||||
* bz-devel to "INCLUDE"
|
|
||||||
|
|
||||||
For a devel release, simple bump bz-ver and bz-date
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!ENTITY bz-ver "2.17.4">
|
|
||||||
<!ENTITY bz-nextver "2.18">
|
|
||||||
<!ENTITY bz-date "2003-02-16">
|
|
||||||
<!ENTITY % bz-devel "INCLUDE">
|
|
||||||
|
|
||||||
<!ENTITY bz "http://www.bugzilla.org/">
|
|
||||||
<!ENTITY bzg-auth "The Bugzilla Team">
|
|
||||||
<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation'>Bugzilla Documentation</ulink>">
|
|
||||||
<!ENTITY mysql "http://www.mysql.com/">
|
|
||||||
<!ENTITY newest-perl-ver "5.8">
|
|
||||||
|
|
||||||
<!-- For minimum versions -->
|
|
||||||
<!ENTITY min-mysql-ver "3.23.41">
|
|
||||||
<!ENTITY min-perl-ver "5.6">
|
|
||||||
<!ENTITY min-template-ver "2.08">
|
|
||||||
<!ENTITY min-file-temp-ver "1.804">
|
|
||||||
<!ENTITY min-appconfig-ver "1.52">
|
|
||||||
<!ENTITY min-text-wrap-ver "2001.0131">
|
|
||||||
<!ENTITY min-file-spec-ver "0.82">
|
|
||||||
<!ENTITY min-data-dumper-ver "any">
|
|
||||||
<!ENTITY min-dbd-mysql-ver "2.1010">
|
|
||||||
<!ENTITY min-dbi-ver "1.32">
|
|
||||||
<!ENTITY min-date-format-ver "2.21">
|
|
||||||
<!ENTITY min-cgi-ver "2.88">
|
|
||||||
<!-- Optional modules -->
|
|
||||||
<!ENTITY min-gd-ver "1.20">
|
|
||||||
<!ENTITY min-gd-graph-ver "any">
|
|
||||||
<!ENTITY min-gd-text-align-ver "any">
|
|
||||||
<!ENTITY min-chart-base-ver "0.99c">
|
|
||||||
<!ENTITY min-xml-parser-ver "any">
|
|
||||||
<!ENTITY min-mime-parser-ver "any">
|
|
||||||
|
|
||||||
]>
|
|
||||||
|
|
||||||
|
|
||||||
<!-- Coding standards for this document
|
|
||||||
|
|
||||||
* Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
|
|
||||||
* Use Entities to include files for new chapters in Bugzilla-Guide.sgml.
|
|
||||||
* Try to use Entities for frequently-used passages of text as well.
|
|
||||||
* Ensure all documents compile cleanly to HTML after modification.
|
|
||||||
The warning, "DTDDECL catalog types not supported" is normal.
|
|
||||||
* Try to index important terms wherever possible.
|
|
||||||
* Use "glossterm" whenever you introduce a new term.
|
|
||||||
* Follow coding standards at http://www.tldp.org, and
|
|
||||||
check out the KDE guidelines (they are nice, too)
|
|
||||||
http://i18n.kde.org/doc/markup.html
|
|
||||||
* All tags should be lowercase (needsfix)
|
|
||||||
* Please use sensible spacing. The comments at the very end of each
|
|
||||||
file define reasonable defaults for PSGML mode in EMACS.
|
|
||||||
Double-indent tags, use double spacing whenever possible, and
|
|
||||||
try to avoid clutter and feel free to waste space in the code to make it more readable.
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<book id="index">
|
|
||||||
|
|
||||||
<!-- Header -->
|
|
||||||
|
|
||||||
<bookinfo>
|
|
||||||
<title>The Bugzilla Guide - &bz-ver; <![%bz-devel;[Development ]]>Release</title>
|
|
||||||
|
|
||||||
<authorgroup>
|
|
||||||
<author>
|
|
||||||
<firstname>Matthew</firstname>
|
|
||||||
<othername>P.</othername>
|
|
||||||
<surname>Barnson</surname>
|
|
||||||
</author>
|
|
||||||
<author>
|
|
||||||
<firstname>Jacob</firstname>
|
|
||||||
<surname>Steenhagen</surname>
|
|
||||||
</author>
|
|
||||||
<corpauthor>The Bugzilla Team</corpauthor>
|
|
||||||
</authorgroup>
|
|
||||||
|
|
||||||
<pubdate>&bz-date;</pubdate>
|
|
||||||
|
|
||||||
<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.
|
|
||||||
</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 bug filed in the &bzg-bugs; compontent.
|
|
||||||
</para>
|
|
||||||
<![%bz-devel;[
|
|
||||||
<para>This is a development version of this guide. Information in it
|
|
||||||
is subject to change before the &bz-nextver; release of this guide
|
|
||||||
(which will correspond with the &bz-nextver; release of Bugzilla).
|
|
||||||
</para>
|
|
||||||
]]>
|
|
||||||
</abstract>
|
|
||||||
|
|
||||||
<keywordset>
|
|
||||||
<keyword>Bugzilla</keyword>
|
|
||||||
<keyword>Guide</keyword>
|
|
||||||
<keyword>installation</keyword>
|
|
||||||
<keyword>FAQ</keyword>
|
|
||||||
<keyword>administration</keyword>
|
|
||||||
<keyword>integration</keyword>
|
|
||||||
<keyword>MySQL</keyword>
|
|
||||||
<keyword>Mozilla</keyword>
|
|
||||||
<keyword>webtools</keyword>
|
|
||||||
</keywordset>
|
|
||||||
</bookinfo>
|
|
||||||
|
|
||||||
<!-- About This Guide -->
|
|
||||||
&about;
|
|
||||||
|
|
||||||
<!-- Introduction -->
|
|
||||||
&introduction;
|
|
||||||
|
|
||||||
<!-- Using Bugzilla -->
|
|
||||||
&using;
|
|
||||||
|
|
||||||
<!-- Installing Bugzilla -->
|
|
||||||
&installation;
|
|
||||||
|
|
||||||
<!-- Administering Bugzilla -->
|
|
||||||
&administration;
|
|
||||||
|
|
||||||
<!-- Appendix: The Frequently Asked Questions -->
|
|
||||||
&faq;
|
|
||||||
|
|
||||||
<!-- Appendix: The Database Schema -->
|
|
||||||
&database;
|
|
||||||
|
|
||||||
<!-- Appendix: Custom Patches -->
|
|
||||||
&patches;
|
|
||||||
|
|
||||||
<!-- Appendix: Major Bugzilla Variants -->
|
|
||||||
&variants;
|
|
||||||
|
|
||||||
<!-- Appendix: GNU Free Documentation License -->
|
|
||||||
&gfdl;
|
|
||||||
|
|
||||||
<!-- Glossary -->
|
|
||||||
&glossary;
|
|
||||||
|
|
||||||
<!-- Index -->
|
|
||||||
&index;
|
|
||||||
|
|
||||||
|
|
||||||
</book>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
@ -1,227 +0,0 @@
|
||||||
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
|
||||||
<!ENTITY conventions SYSTEM "conventions.sgml"> ] > -->
|
|
||||||
|
|
||||||
<chapter id="about">
|
|
||||||
<title>About This Guide</title>
|
|
||||||
|
|
||||||
<section id="copyright">
|
|
||||||
<title>Copyright Information</title>
|
|
||||||
<blockquote>
|
|
||||||
<attribution>Copyright (c) 2000-2003 Matthew P. Barnson and &bzg-auth;</attribution>
|
|
||||||
<para>
|
|
||||||
Permission is granted to copy, distribute and/or modify this
|
|
||||||
document under the terms of the GNU Free Documentation
|
|
||||||
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 <xref linkend="gfdl"/>.
|
|
||||||
</para>
|
|
||||||
</blockquote>
|
|
||||||
<para>
|
|
||||||
If you have any questions regarding this document, its
|
|
||||||
copyright, or publishing this document in non-electronic form,
|
|
||||||
please contact &bzg-auth;.
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="disclaimer">
|
|
||||||
<title>Disclaimer</title>
|
|
||||||
<para>
|
|
||||||
No liability for the contents of this document can be accepted.
|
|
||||||
Use the concepts, examples, and other content at your own risk.
|
|
||||||
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
|
|
||||||
specifically noted otherwise. Use of a term in this document
|
|
||||||
should not be regarded as affecting the validity of any
|
|
||||||
trademark or service mark.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
Naming of particular products or brands should not be seen as
|
|
||||||
endorsements, with the exception of the term "GNU/Linux". We
|
|
||||||
wholeheartedly endorse the use of GNU/Linux in every situation
|
|
||||||
where it is appropriate. It is an extremely versatile, stable,
|
|
||||||
and robust operating system that offers an ideal operating
|
|
||||||
environment for Bugzilla.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
You are strongly recommended to make a backup of your system
|
|
||||||
before installing Bugzilla and at regular intervals thereafter.
|
|
||||||
If you implement any suggestion in this Guide, implement this one!
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
Although the Bugzilla development team has taken great care to
|
|
||||||
ensure that all easily-exploitable bugs or options are
|
|
||||||
documented or fixed in the code, security holes surely exist.
|
|
||||||
Great care should be taken both in the installation and usage of
|
|
||||||
this software. Carefully consider the implications of installing
|
|
||||||
other network services with Bugzilla. The Bugzilla development
|
|
||||||
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 ensure
|
|
||||||
your security needs are met.
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<!-- Section 2: New Versions -->
|
|
||||||
|
|
||||||
<section id="newversions">
|
|
||||||
<title>New Versions</title>
|
|
||||||
<para>
|
|
||||||
This is the &bz-ver; version of The Bugzilla Guide. It is so named
|
|
||||||
to match the current version of Bugzilla.
|
|
||||||
<![%bz-devel;[
|
|
||||||
This version of the guide, like its associated Bugzilla version is a
|
|
||||||
development version. Information is subject to change between now and
|
|
||||||
when &bz-nextver; is released.
|
|
||||||
]]>
|
|
||||||
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.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
The newest version of this guide can always be found at <ulink
|
|
||||||
url="http://www.bugzilla.org">bugzilla.org</ulink>; including
|
|
||||||
documentation for past releases and the current development version.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
The documentation for the most recent stable release of Bugzilla can also
|
|
||||||
be found at
|
|
||||||
<ulink url="http://www.tldp.org">The Linux Documentation Project</ulink>.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
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>
|
|
||||||
|
|
||||||
<section id="credits">
|
|
||||||
<title>Credits</title>
|
|
||||||
<para>
|
|
||||||
The people listed below have made enormous contributions to the
|
|
||||||
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>
|
|
||||||
|
|
||||||
<!-- TODO: This is evil... there has to be a valid way to get this look -->
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term>Matthew P. Barnson <email>mbarnson@sisna.com</email></term>
|
|
||||||
<listitem>
|
|
||||||
<para>for the Herculaean task of pulling together the Bugzilla Guide
|
|
||||||
and shepherding it to 2.14.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term>Terry Weissman <email>terry@mozilla.org</email></term>
|
|
||||||
<listitem>
|
|
||||||
<para>for initially writing Bugzilla and creating the README upon
|
|
||||||
which the UNIX installation documentation is largely based.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term>Tara Hernandez <email>tara@tequilarists.org</email></term>
|
|
||||||
<listitem>
|
|
||||||
<para>for keeping Bugzilla development going strong after Terry left
|
|
||||||
mozilla.org and for running landfill.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
|
|
||||||
<listitem>
|
|
||||||
<para>for providing insight into the key differences between Red
|
|
||||||
Hat's customized Bugzilla, and being largely responsible for
|
|
||||||
<xref linkend="variant-redhat"/>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term>Dawn Endico <email>endico@mozilla.org</email></term>
|
|
||||||
<listitem>
|
|
||||||
<para>for being a hacker extraordinaire and putting up with Matthew's
|
|
||||||
incessant questions and arguments on irc.mozilla.org in #mozwebtools
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term>Jacob Steenhagen <email>jake@bugzilla.org</email></term>
|
|
||||||
<listitem>
|
|
||||||
<para>for taking over documentation during the 2.17 development
|
|
||||||
period.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
</variablelist>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
Last but not least, all the members of the
|
|
||||||
<ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"/>
|
|
||||||
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
|
|
||||||
to this documentation (in alphabetical order):
|
|
||||||
<simplelist type="inline">
|
|
||||||
<member>Andrew Pearson</member>
|
|
||||||
<member>Ben FrantzDale</member>
|
|
||||||
<member>Eric Hanson</member>
|
|
||||||
<member>Gervase Markham</member>
|
|
||||||
<member>Joe Robins</member>
|
|
||||||
<member>Kevin Brannen</member>
|
|
||||||
<member>Ron Teitelbaum</member>
|
|
||||||
<member>Spencer Smith</member>
|
|
||||||
<member>Zach Liption</member>
|
|
||||||
</simplelist>
|
|
||||||
.
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<!-- conventions used here (didn't want to give it a chapter of its own) -->
|
|
||||||
&conventions;
|
|
||||||
</chapter>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End: -->
|
|
||||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,179 +0,0 @@
|
||||||
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
|
||||||
<section id="conventions">
|
|
||||||
<title>Document Conventions</title>
|
|
||||||
|
|
||||||
<indexterm zone="conventions">
|
|
||||||
<primary>conventions</primary>
|
|
||||||
</indexterm>
|
|
||||||
|
|
||||||
<para>This document uses the following conventions:</para>
|
|
||||||
|
|
||||||
<informaltable frame="none">
|
|
||||||
<tgroup cols="2">
|
|
||||||
<thead>
|
|
||||||
<row>
|
|
||||||
<entry>Descriptions</entry>
|
|
||||||
|
|
||||||
<entry>Appearance</entry>
|
|
||||||
</row>
|
|
||||||
</thead>
|
|
||||||
|
|
||||||
<tbody>
|
|
||||||
<row>
|
|
||||||
<entry>Warnings</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<caution>
|
|
||||||
<para>Don't run with scissors!</para>
|
|
||||||
</caution>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Hint</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<tip>
|
|
||||||
<para>Would you like a breath mint?</para>
|
|
||||||
</tip>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Notes</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<note>
|
|
||||||
<para>Dear John...</para>
|
|
||||||
</note>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Information requiring special attention</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<warning>
|
|
||||||
<para>Read this or the cat gets it.</para>
|
|
||||||
</warning>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>File Names</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<filename>filename</filename>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Directory Names</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<filename class="directory">directory</filename>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Commands to be typed</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<command>command</command>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Applications Names</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<application>application</application>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>
|
|
||||||
<foreignphrase>Prompt</foreignphrase>
|
|
||||||
|
|
||||||
of users command under bash shell</entry>
|
|
||||||
|
|
||||||
<entry>bash$</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>
|
|
||||||
<foreignphrase>Prompt</foreignphrase>
|
|
||||||
|
|
||||||
of root users command under bash shell</entry>
|
|
||||||
|
|
||||||
<entry>bash#</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>
|
|
||||||
<foreignphrase>Prompt</foreignphrase>
|
|
||||||
|
|
||||||
of user command under tcsh shell</entry>
|
|
||||||
|
|
||||||
<entry>tcsh$</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Environment Variables</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<envar>VARIABLE</envar>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Emphasized word</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<emphasis>word</emphasis>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Term found in the glossary</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
|
|
||||||
<row>
|
|
||||||
<entry>Code Example</entry>
|
|
||||||
|
|
||||||
<entry>
|
|
||||||
<programlisting><sgmltag class="starttag">para</sgmltag>
|
|
||||||
Beginning and end of paragraph
|
|
||||||
<sgmltag class="endtag">para</sgmltag></programlisting>
|
|
||||||
</entry>
|
|
||||||
</row>
|
|
||||||
</tbody>
|
|
||||||
</tgroup>
|
|
||||||
</informaltable>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,394 +0,0 @@
|
||||||
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
|
||||||
<appendix id="database">
|
|
||||||
<title>The Bugzilla Database</title>
|
|
||||||
|
|
||||||
<note>
|
|
||||||
<para>This document really needs to be updated with more fleshed out
|
|
||||||
information about primary keys, interrelationships, and maybe some nifty
|
|
||||||
tables to document dependencies. Any takers?</para>
|
|
||||||
</note>
|
|
||||||
|
|
||||||
<section id="dbmodify">
|
|
||||||
<title>Modifying Your Running System</title>
|
|
||||||
|
|
||||||
<para>Bugzilla optimizes database lookups by storing all relatively
|
|
||||||
static information in the
|
|
||||||
<filename>versioncache</filename> file, located in the
|
|
||||||
<filename class="directory">data/</filename>
|
|
||||||
subdirectory under your installation directory.</para>
|
|
||||||
|
|
||||||
<para>If you make a change to the structural data in your database (the
|
|
||||||
versions table for example), or to the
|
|
||||||
<quote>constants</quote>
|
|
||||||
|
|
||||||
encoded in <filename>defparams.pl</filename>, you will need to remove
|
|
||||||
the cached content from the data directory (by doing a
|
|
||||||
<quote>rm data/versioncache</quote>
|
|
||||||
|
|
||||||
), or your changes won't show up.</para>
|
|
||||||
|
|
||||||
<para> <filename>versioncache</filename>
|
|
||||||
gets automatically regenerated whenever it's more than
|
|
||||||
an hour old, so Bugzilla will eventually notice your changes by itself,
|
|
||||||
but generally you want it to notice right away, so that you can test
|
|
||||||
things.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="dbdoc">
|
|
||||||
<title>MySQL Bugzilla Database Introduction</title>
|
|
||||||
|
|
||||||
<para>This information comes straight from my life. I was forced to learn
|
|
||||||
how Bugzilla organizes database because of nitpicky requests from users
|
|
||||||
for tiny changes in wording, rather than having people re-educate
|
|
||||||
themselves or figure out how to work our procedures around the tool. It
|
|
||||||
sucks, but it can and will happen to you, so learn how the schema works
|
|
||||||
and deal with it when it comes.</para>
|
|
||||||
|
|
||||||
<para>So, here you are with your brand-new installation of Bugzilla.
|
|
||||||
You've got MySQL set up, Apache working right, Perl DBI and DBD talking
|
|
||||||
to the database flawlessly. Maybe you've even entered a few test bugs to
|
|
||||||
make sure email's working; people seem to be notified of new bugs and
|
|
||||||
changes, and you can enter and edit bugs to your heart's content. Perhaps
|
|
||||||
you've gone through the trouble of setting up a gateway for people to
|
|
||||||
submit bugs to your database via email, have had a few people test it,
|
|
||||||
and received rave reviews from your beta testers.</para>
|
|
||||||
|
|
||||||
<para>What's the next thing you do? Outline a training strategy for your
|
|
||||||
development team, of course, and bring them up to speed on the new tool
|
|
||||||
you've labored over for hours.</para>
|
|
||||||
|
|
||||||
<para>Your first training session starts off very well! You have a
|
|
||||||
captive audience which seems enraptured by the efficiency embodied in
|
|
||||||
this thing called "Bugzilla". You are caught up describing the nifty
|
|
||||||
features, how people can save favorite queries in the database, set them
|
|
||||||
up as headers and footers on their pages, customize their layouts,
|
|
||||||
generate reports, track status with greater efficiency than ever before,
|
|
||||||
leap tall buildings with a single bound and rescue Jane from the clutches
|
|
||||||
of Certain Death!</para>
|
|
||||||
|
|
||||||
<para>But Certain Death speaks up -- a tiny voice, from the dark corners
|
|
||||||
of the conference room. "I have a concern," the voice hisses from the
|
|
||||||
darkness, "about the use of the word 'verified'.</para>
|
|
||||||
|
|
||||||
<para>The room, previously filled with happy chatter, lapses into
|
|
||||||
reverential silence as Certain Death (better known as the Vice President
|
|
||||||
of Software Engineering) continues. "You see, for two years we've used
|
|
||||||
the word 'verified' to indicate that a developer or quality assurance
|
|
||||||
engineer has confirmed that, in fact, a bug is valid. I don't want to
|
|
||||||
lose two years of training to a new software product. You need to change
|
|
||||||
the bug status of 'verified' to 'approved' as soon as possible. To avoid
|
|
||||||
confusion, of course."</para>
|
|
||||||
|
|
||||||
<para>Oh no! Terror strikes your heart, as you find yourself mumbling
|
|
||||||
"yes, yes, I don't think that would be a problem," You review the changes
|
|
||||||
with Certain Death, and continue to jabber on, "no, it's not too big a
|
|
||||||
change. I mean, we have the source code, right? You know, 'Use the
|
|
||||||
Source, Luke' and all that... no problem," All the while you quiver
|
|
||||||
inside like a beached jellyfish bubbling, burbling, and boiling on a hot
|
|
||||||
Jamaican sand dune...</para>
|
|
||||||
|
|
||||||
<para>Thus begins your adventure into the heart of Bugzilla. You've been
|
|
||||||
forced to learn about non-portable enum() fields, varchar columns, and
|
|
||||||
tinyint definitions. The Adventure Awaits You!</para>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<title>Bugzilla Database Basics</title>
|
|
||||||
|
|
||||||
<para>If you were like me, at this point you're totally clueless about
|
|
||||||
the internals of MySQL, and if it weren't for this executive order from
|
|
||||||
the Vice President you couldn't care less about the difference between
|
|
||||||
a
|
|
||||||
<quote>bigint</quote>
|
|
||||||
|
|
||||||
and a
|
|
||||||
<quote>tinyint</quote>
|
|
||||||
|
|
||||||
entry in MySQL. I recommend you refer to the MySQL documentation,
|
|
||||||
available at
|
|
||||||
<ulink url="http://www.mysql.com/doc.html">MySQL.com</ulink>
|
|
||||||
|
|
||||||
. Below are the basics you need to know about the Bugzilla database.
|
|
||||||
Check the chart above for more details.</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
<orderedlist>
|
|
||||||
<listitem>
|
|
||||||
<para>To connect to your database:</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
<prompt>bash#</prompt>
|
|
||||||
|
|
||||||
<command>mysql</command>
|
|
||||||
|
|
||||||
<parameter>-u root</parameter>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>If this works without asking you for a password,
|
|
||||||
<emphasis>shame on you</emphasis>
|
|
||||||
|
|
||||||
! 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
|
|
||||||
<ulink url="http://www.mysql.com/php/manual.php3?section=Privilege_system">MySQL
|
|
||||||
searchable documentation</ulink>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>You should now be at a prompt that looks like this:</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
<prompt>mysql></prompt>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>At the prompt, if
|
|
||||||
<quote>bugs</quote>
|
|
||||||
|
|
||||||
is the name you chose in the
|
|
||||||
<filename>localconfig</filename>
|
|
||||||
|
|
||||||
file for your Bugzilla database, type:</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
<prompt>mysql</prompt>
|
|
||||||
|
|
||||||
<command>use bugs;</command>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
</listitem>
|
|
||||||
</orderedlist>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<title>Bugzilla Database Tables</title>
|
|
||||||
|
|
||||||
<para>Imagine your MySQL database as a series of spreadsheets, and
|
|
||||||
you won't be too far off. If you use this command:</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
<prompt>mysql></prompt>
|
|
||||||
<command>show tables from bugs;</command>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>you'll be able to see the names of all the
|
|
||||||
<quote>spreadsheets</quote>
|
|
||||||
(tables) in your database.</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 |
|
|
||||||
| 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.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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>
|
|
||||||
|
|
||||||
</appendix>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
|
|
||||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,18 +0,0 @@
|
||||||
--- File/Temp.pm.orig Thu Feb 6 16:26:00 2003
|
|
||||||
+++ File/Temp.pm Thu Feb 6 16:26:23 2003
|
|
||||||
@@ -205,6 +205,7 @@
|
|
||||||
# eg CGI::Carp
|
|
||||||
local $SIG{__DIE__} = sub {};
|
|
||||||
local $SIG{__WARN__} = sub {};
|
|
||||||
+ local *CORE::GLOBAL::die = sub {};
|
|
||||||
$bit = &$func();
|
|
||||||
1;
|
|
||||||
};
|
|
||||||
@@ -226,6 +227,7 @@
|
|
||||||
# eg CGI::Carp
|
|
||||||
local $SIG{__DIE__} = sub {};
|
|
||||||
local $SIG{__WARN__} = sub {};
|
|
||||||
+ local *CORE::GLOBAL::die = sub {};
|
|
||||||
$bit = &$func();
|
|
||||||
1;
|
|
||||||
};
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
--- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000
|
|
||||||
+++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001
|
|
||||||
@@ -3,8 +3,8 @@
|
|
||||||
warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n";
|
|
||||||
|
|
||||||
# =====> PATHS: CHECK AND ADJUST <=====
|
|
||||||
-my @INC = qw(-I/usr/local/include -I/usr/local/include/gd);
|
|
||||||
-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
|
|
||||||
+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
|
|
||||||
+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
|
|
||||||
my @LIBS = qw(-lgd -lpng -lz);
|
|
||||||
|
|
||||||
# FEATURE FLAGS
|
|
||||||
@@ -23,7 +23,7 @@
|
|
||||||
|
|
||||||
push @LIBS,'-lttf' if $TTF;
|
|
||||||
push @LIBS,'-ljpeg' if $JPEG;
|
|
||||||
-push @LIBS, '-lm' unless $^O eq 'MSWin32';
|
|
||||||
+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
|
|
||||||
|
|
||||||
# FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified
|
|
||||||
if ($^O ne 'freebsd' && $^O ne 'MSWin32') {
|
|
||||||
|
|
@ -1,448 +0,0 @@
|
||||||
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
|
||||||
<appendix id="gfdl">
|
|
||||||
<title>GNU Free Documentation License</title>
|
|
||||||
|
|
||||||
<!-- - GNU Project - Free Software Foundation (FSF) -->
|
|
||||||
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
|
|
||||||
<!-- section>
|
|
||||||
<title>GNU Free Documentation License</title -->
|
|
||||||
<para>Version 1.1, March 2000</para>
|
|
||||||
|
|
||||||
<blockquote>
|
|
||||||
<para>Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
|
|
||||||
Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and
|
|
||||||
distribute verbatim copies of this license document, but changing it is
|
|
||||||
not allowed.</para>
|
|
||||||
</blockquote>
|
|
||||||
|
|
||||||
<section label="0" id="gfdl-0">
|
|
||||||
<title>PREAMBLE</title>
|
|
||||||
|
|
||||||
<para>The purpose of this License is to make a manual, textbook, or other
|
|
||||||
written document "free" in the sense of freedom: to assure everyone the
|
|
||||||
effective freedom to copy and redistribute it, with or without modifying
|
|
||||||
it, either commercially or noncommercially. Secondarily, this License
|
|
||||||
preserves for the author and publisher a way to get credit for their
|
|
||||||
work, while not being considered responsible for modifications made by
|
|
||||||
others.</para>
|
|
||||||
|
|
||||||
<para>This License is a kind of "copyleft", which means that derivative
|
|
||||||
works of the document must themselves be free in the same sense. It
|
|
||||||
complements the GNU General Public License, which is a copyleft license
|
|
||||||
designed for free software.</para>
|
|
||||||
|
|
||||||
<para>We have designed this License in order to use it for manuals for
|
|
||||||
free software, because free software needs free documentation: a free
|
|
||||||
program should come with manuals providing the same freedoms that the
|
|
||||||
software does. But this License is not limited to software manuals; it
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="1" id="gfdl-1">
|
|
||||||
<title>APPLICABILITY AND DEFINITIONS</title>
|
|
||||||
|
|
||||||
<para>This License applies to any manual or other work that contains a
|
|
||||||
notice placed by the copyright holder saying it can be distributed under
|
|
||||||
the terms of this License. The "Document", below, refers to any such
|
|
||||||
manual or work. Any member of the public is a licensee, and is addressed
|
|
||||||
as "you".</para>
|
|
||||||
|
|
||||||
<para>A "Modified Version" of the Document means any work containing the
|
|
||||||
Document or a portion of it, either copied verbatim, or with
|
|
||||||
modifications and/or translated into another language.</para>
|
|
||||||
|
|
||||||
<para>A "Secondary Section" is a named appendix or a front-matter section
|
|
||||||
of the Document that deals exclusively with the relationship of the
|
|
||||||
publishers or authors of the Document to the Document's overall subject
|
|
||||||
(or to related matters) and contains nothing that could fall directly
|
|
||||||
within that overall subject. (For example, if the Document is in part a
|
|
||||||
textbook of mathematics, a Secondary Section may not explain any
|
|
||||||
mathematics.) The relationship could be a matter of historical connection
|
|
||||||
with the subject or with related matters, or of legal, commercial,
|
|
||||||
philosophical, ethical or political position regarding them.</para>
|
|
||||||
|
|
||||||
<para>The "Invariant Sections" are certain Secondary Sections whose
|
|
||||||
titles are designated, as being those of Invariant Sections, in the
|
|
||||||
notice that says that the Document is released under this License.</para>
|
|
||||||
|
|
||||||
<para>The "Cover Texts" are certain short passages of text that are
|
|
||||||
listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says
|
|
||||||
that the Document is released under this License.</para>
|
|
||||||
|
|
||||||
<para>A "Transparent" copy of the Document means a machine-readable copy,
|
|
||||||
represented in a format whose specification is available to the general
|
|
||||||
public, whose contents can be viewed and edited directly and
|
|
||||||
straightforwardly with generic text editors or (for images composed of
|
|
||||||
pixels) generic paint programs or (for drawings) some widely available
|
|
||||||
drawing editor, and that is suitable for input to text formatters or for
|
|
||||||
automatic translation to a variety of formats suitable for input to text
|
|
||||||
formatters. A copy made in an otherwise Transparent file format whose
|
|
||||||
markup has been designed to thwart or discourage subsequent modification
|
|
||||||
by readers is not Transparent. A copy that is not "Transparent" is called
|
|
||||||
"Opaque".</para>
|
|
||||||
|
|
||||||
<para>Examples of suitable formats for Transparent copies include plain
|
|
||||||
ASCII without markup, Texinfo input format, LaTeX input format, SGML or
|
|
||||||
XML using a publicly available DTD, and standard-conforming simple HTML
|
|
||||||
designed for human modification. Opaque formats include PostScript, PDF,
|
|
||||||
proprietary formats that can be read and edited only by proprietary word
|
|
||||||
processors, SGML or XML for which the DTD and/or processing tools are not
|
|
||||||
generally available, and the machine-generated HTML produced by some word
|
|
||||||
processors for output purposes only.</para>
|
|
||||||
|
|
||||||
<para>The "Title Page" means, for a printed book, the title page itself,
|
|
||||||
plus such following pages as are needed to hold, legibly, the material
|
|
||||||
this License requires to appear in the title page. For works in formats
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="2" id="gfdl-2">
|
|
||||||
<title>VERBATIM COPYING</title>
|
|
||||||
|
|
||||||
<para>You may copy and distribute the Document in any medium, either
|
|
||||||
commercially or noncommercially, provided that this License, the
|
|
||||||
copyright notices, and the license notice saying this License applies to
|
|
||||||
the Document are reproduced in all copies, and that you add no other
|
|
||||||
conditions whatsoever to those of this License. You may not use technical
|
|
||||||
measures to obstruct or control the reading or further copying of the
|
|
||||||
copies you make or distribute. However, you may accept compensation in
|
|
||||||
exchange for copies. If you distribute a large enough number of copies
|
|
||||||
you must also follow the conditions in section 3.</para>
|
|
||||||
|
|
||||||
<para>You may also lend copies, under the same conditions stated above,
|
|
||||||
and you may publicly display copies.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="3" id="gfdl-3">
|
|
||||||
<title>COPYING IN QUANTITY</title>
|
|
||||||
|
|
||||||
<para>If you publish printed copies of the Document numbering more than
|
|
||||||
100, and the Document's license notice requires Cover Texts, you must
|
|
||||||
enclose the copies in covers that carry, clearly and legibly, all these
|
|
||||||
Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts
|
|
||||||
on the back cover. Both covers must also clearly and legibly identify you
|
|
||||||
as the publisher of these copies. The front cover must present the full
|
|
||||||
title with all words of the title equally prominent and visible. You may
|
|
||||||
add other material on the covers in addition. Copying with changes
|
|
||||||
limited to the covers, as long as they preserve the title of the Document
|
|
||||||
and satisfy these conditions, can be treated as verbatim copying in other
|
|
||||||
respects.</para>
|
|
||||||
|
|
||||||
<para>If the required texts for either cover are too voluminous to fit
|
|
||||||
legibly, you should put the first ones listed (as many as fit reasonably)
|
|
||||||
on the actual cover, and continue the rest onto adjacent pages.</para>
|
|
||||||
|
|
||||||
<para>If you publish or distribute Opaque copies of the Document
|
|
||||||
numbering more than 100, you must either include a machine-readable
|
|
||||||
Transparent copy along with each Opaque copy, or state in or with each
|
|
||||||
Opaque copy a publicly-accessible computer-network location containing a
|
|
||||||
complete Transparent copy of the Document, free of added material, which
|
|
||||||
the general network-using public has access to download anonymously at no
|
|
||||||
charge using public-standard network protocols. If you use the latter
|
|
||||||
option, you must take reasonably prudent steps, when you begin
|
|
||||||
distribution of Opaque copies in quantity, to ensure that this
|
|
||||||
Transparent copy will remain thus accessible at the stated location until
|
|
||||||
at least one year after the last time you distribute an Opaque copy
|
|
||||||
(directly or through your agents or retailers) of that edition to the
|
|
||||||
public.</para>
|
|
||||||
|
|
||||||
<para>It is requested, but not required, that you contact the authors of
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="4" id="gfdl-4">
|
|
||||||
<title>MODIFICATIONS</title>
|
|
||||||
|
|
||||||
<para>You may copy and distribute a Modified Version of the Document
|
|
||||||
under the conditions of sections 2 and 3 above, provided that you release
|
|
||||||
the Modified Version under precisely this License, with the Modified
|
|
||||||
Version filling the role of the Document, thus licensing distribution and
|
|
||||||
modification of the Modified Version to whoever possesses a copy of it.
|
|
||||||
In addition, you must do these things in the Modified Version:</para>
|
|
||||||
|
|
||||||
<orderedlist numeration="upperalpha">
|
|
||||||
<listitem>
|
|
||||||
<para>Use in the Title Page (and on the covers, if any) a title
|
|
||||||
distinct from that of the Document, and from those of previous
|
|
||||||
versions (which should, if there were any, be listed in the History
|
|
||||||
section of the Document). You may use the same title as a previous
|
|
||||||
version if the original publisher of that version gives
|
|
||||||
permission.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>List on the Title Page, as authors, one or more persons or
|
|
||||||
entities responsible for authorship of the modifications in the
|
|
||||||
Modified Version, together with at least five of the principal
|
|
||||||
authors of the Document (all of its principal authors, if it has less
|
|
||||||
than five).</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>State on the Title page the name of the publisher of the
|
|
||||||
Modified Version, as the publisher.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Preserve all the copyright notices of the Document.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Add an appropriate copyright notice for your modifications
|
|
||||||
adjacent to the other copyright notices.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Include, immediately after the copyright notices, a license
|
|
||||||
notice giving the public permission to use the Modified Version under
|
|
||||||
the terms of this License, in the form shown in the Addendum
|
|
||||||
below.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Preserve in that license notice the full lists of Invariant
|
|
||||||
Sections and required Cover Texts given in the Document's license
|
|
||||||
notice.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Include an unaltered copy of this License.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Preserve the section entitled "History", and its title, and add
|
|
||||||
to it an item stating at least the title, year, new authors, and
|
|
||||||
publisher of the Modified Version as given on the Title Page. If
|
|
||||||
there is no section entitled "History" in the Document, create one
|
|
||||||
stating the title, year, authors, and publisher of the Document as
|
|
||||||
given on its Title Page, then add an item describing the Modified
|
|
||||||
Version as stated in the previous sentence.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Preserve the network location, if any, given in the Document
|
|
||||||
for public access to a Transparent copy of the Document, and likewise
|
|
||||||
the network locations given in the Document for previous versions it
|
|
||||||
was based on. These may be placed in the "History" section. You may
|
|
||||||
omit a network location for a work that was published at least four
|
|
||||||
years before the Document itself, or if the original publisher of the
|
|
||||||
version it refers to gives permission.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>In any section entitled "Acknowledgements" or "Dedications",
|
|
||||||
preserve the section's title, and preserve in the section all the
|
|
||||||
substance and tone of each of the contributor acknowledgements and/or
|
|
||||||
dedications given therein.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Preserve all the Invariant Sections of the Document, unaltered
|
|
||||||
in their text and in their titles. Section numbers or the equivalent
|
|
||||||
are not considered part of the section titles.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Delete any section entitled "Endorsements". Such a section may
|
|
||||||
not be included in the Modified Version.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Do not retitle any existing section as "Endorsements" or to
|
|
||||||
conflict in title with any Invariant Section.</para>
|
|
||||||
</listitem>
|
|
||||||
</orderedlist>
|
|
||||||
|
|
||||||
<para>If the Modified Version includes new front-matter sections or
|
|
||||||
appendices that qualify as Secondary Sections and contain no material
|
|
||||||
copied from the Document, you may at your option designate some or all of
|
|
||||||
these sections as invariant. To do this, add their titles to the list of
|
|
||||||
Invariant Sections in the Modified Version's license notice. These titles
|
|
||||||
must be distinct from any other section titles.</para>
|
|
||||||
|
|
||||||
<para>You may add a section entitled "Endorsements", provided it contains
|
|
||||||
nothing but endorsements of your Modified Version by various parties--for
|
|
||||||
example, statements of peer review or that the text has been approved by
|
|
||||||
an organization as the authoritative definition of a standard.</para>
|
|
||||||
|
|
||||||
<para>You may add a passage of up to five words as a Front-Cover Text,
|
|
||||||
and a passage of up to 25 words as a Back-Cover Text, to the end of the
|
|
||||||
list of Cover Texts in the Modified Version. Only one passage of
|
|
||||||
Front-Cover Text and one of Back-Cover Text may be added by (or through
|
|
||||||
arrangements made by) any one entity. If the Document already includes a
|
|
||||||
cover text for the same cover, previously added by you or by arrangement
|
|
||||||
made by the same entity you are acting on behalf of, you may not add
|
|
||||||
another; but you may replace the old one, on explicit permission from the
|
|
||||||
previous publisher that added the old one.</para>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="5" id="gfdl-5">
|
|
||||||
<title>COMBINING DOCUMENTS</title>
|
|
||||||
|
|
||||||
<para>You may combine the Document with other documents released under
|
|
||||||
this License, under the terms defined in section 4 above for modified
|
|
||||||
versions, provided that you include in the combination all of the
|
|
||||||
Invariant Sections of all of the original documents, unmodified, and list
|
|
||||||
them all as Invariant Sections of your combined work in its license
|
|
||||||
notice.</para>
|
|
||||||
|
|
||||||
<para>The combined work need only contain one copy of this License, and
|
|
||||||
multiple identical Invariant Sections may be replaced with a single copy.
|
|
||||||
If there are multiple Invariant Sections with the same name but different
|
|
||||||
contents, make the title of each such section unique by adding at the end
|
|
||||||
of it, in parentheses, the name of the original author or publisher of
|
|
||||||
that section if known, or else a unique number. Make the same adjustment
|
|
||||||
to the section titles in the list of Invariant Sections in the license
|
|
||||||
notice of the combined work.</para>
|
|
||||||
|
|
||||||
<para>In the combination, you must combine any sections entitled
|
|
||||||
"History" in the various original documents, forming one section entitled
|
|
||||||
"History"; likewise combine any sections entitled "Acknowledgements", and
|
|
||||||
any sections entitled "Dedications". You must delete all sections
|
|
||||||
entitled "Endorsements."</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="6" id="gfdl-6">
|
|
||||||
<title>COLLECTIONS OF DOCUMENTS</title>
|
|
||||||
|
|
||||||
<para>You may make a collection consisting of the Document and other
|
|
||||||
documents released under this License, and replace the individual copies
|
|
||||||
of this License in the various documents with a single copy that is
|
|
||||||
included in the collection, provided that you follow the rules of this
|
|
||||||
License for verbatim copying of each of the documents in all other
|
|
||||||
respects.</para>
|
|
||||||
|
|
||||||
<para>You may extract a single document from such a collection, and
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="7" id="gfdl-7">
|
|
||||||
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
|
|
||||||
|
|
||||||
<para>A compilation of the Document or its derivatives with other
|
|
||||||
separate and independent documents or works, in or on a volume of a
|
|
||||||
storage or distribution medium, does not as a whole count as a Modified
|
|
||||||
Version of the Document, provided no compilation copyright is claimed for
|
|
||||||
the compilation. Such a compilation is called an "aggregate", and this
|
|
||||||
License does not apply to the other self-contained works thus compiled
|
|
||||||
with the Document, on account of their being thus compiled, if they are
|
|
||||||
not themselves derivative works of the Document.</para>
|
|
||||||
|
|
||||||
<para>If the Cover Text requirement of section 3 is applicable to these
|
|
||||||
copies of the Document, then if the Document is less than one quarter of
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="8" id="gfdl-8">
|
|
||||||
<title>TRANSLATION</title>
|
|
||||||
|
|
||||||
<para>Translation is considered a kind of modification, so you may
|
|
||||||
distribute translations of the Document under the terms of section 4.
|
|
||||||
Replacing Invariant Sections with translations requires special
|
|
||||||
permission from their copyright holders, but you may include translations
|
|
||||||
of some or all Invariant Sections in addition to the original versions of
|
|
||||||
these Invariant Sections. You may include a translation of this License
|
|
||||||
provided that you also include the original English version of this
|
|
||||||
License. In case of a disagreement between the translation and the
|
|
||||||
original English version of this License, the original English version
|
|
||||||
will prevail.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="9" id="gfdl-9">
|
|
||||||
<title>TERMINATION</title>
|
|
||||||
|
|
||||||
<para>You may not copy, modify, sublicense, or distribute the Document
|
|
||||||
except as expressly provided for under this License. Any other attempt to
|
|
||||||
copy, modify, sublicense or distribute the Document is void, and will
|
|
||||||
automatically terminate your rights under this License. However, parties
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section label="10" id="gfdl-10">
|
|
||||||
<title>FUTURE REVISIONS OF THIS LICENSE</title>
|
|
||||||
|
|
||||||
<para>The Free Software Foundation may publish new, revised versions of
|
|
||||||
the GNU Free Documentation License from time to time. Such new versions
|
|
||||||
will be similar in spirit to the present version, but may differ in
|
|
||||||
detail to address new problems or concerns. See
|
|
||||||
<ulink url="http://www.gnu.org/copyleft/">
|
|
||||||
http://www.gnu.org/copyleft/</ulink>
|
|
||||||
|
|
||||||
.</para>
|
|
||||||
|
|
||||||
<para>Each version of the License is given a distinguishing version
|
|
||||||
number. If the Document specifies that a particular numbered version of
|
|
||||||
this License "or any later version" applies to it, you have the option of
|
|
||||||
following the terms and conditions either of that specified version or of
|
|
||||||
any later version that has been published (not as a draft) by the Free
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<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
|
|
||||||
of the License in the document and put the following copyright and
|
|
||||||
license notices just after the title page:</para>
|
|
||||||
|
|
||||||
<blockquote>
|
|
||||||
<para>Copyright (c) YEAR YOUR NAME. Permission is granted to copy,
|
|
||||||
distribute and/or modify this document under the terms of the GNU Free
|
|
||||||
Documentation License, Version 1.1 or any later version published by
|
|
||||||
the Free Software Foundation; with the Invariant Sections being LIST
|
|
||||||
THEIR TITLES, with the Front-Cover Texts being LIST, and with the
|
|
||||||
Back-Cover Texts being LIST. A copy of the license is included in the
|
|
||||||
section entitled "GNU Free Documentation License".</para>
|
|
||||||
</blockquote>
|
|
||||||
|
|
||||||
<para>If you have no Invariant Sections, write "with no Invariant
|
|
||||||
Sections" instead of saying which ones are invariant. If you have no
|
|
||||||
Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover
|
|
||||||
Texts being LIST"; likewise for Back-Cover Texts.</para>
|
|
||||||
|
|
||||||
<para>If your document contains nontrivial examples of program code, we
|
|
||||||
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>
|
|
||||||
</section>
|
|
||||||
</appendix>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,482 +0,0 @@
|
||||||
<!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
|
|
||||||
<glossary id="glossary">
|
|
||||||
<glossdiv>
|
|
||||||
<title>0-9, high ascii</title>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm>.htaccess</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>Apache web server, and other NCSA-compliant web servers,
|
|
||||||
observe the convention of using files in directories called
|
|
||||||
<filename>.htaccess</filename>
|
|
||||||
|
|
||||||
to restrict access to certain files. In Bugzilla, they are used
|
|
||||||
to keep secret files which would otherwise
|
|
||||||
compromise your installation - e.g. the
|
|
||||||
<filename>localconfig</filename>
|
|
||||||
file contains the password to your database.
|
|
||||||
curious.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-a">
|
|
||||||
<title>A</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-apache">
|
|
||||||
<glossterm>Apache</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>In this context, Apache is the web server most commonly used
|
|
||||||
for serving up Bugzilla
|
|
||||||
pages. Contrary to popular belief, the apache web server has nothing
|
|
||||||
to do with the ancient and noble Native American tribe, but instead
|
|
||||||
derived its name from the fact that it was
|
|
||||||
<quote>a patchy</quote>
|
|
||||||
version of the original
|
|
||||||
<acronym>NCSA</acronym>
|
|
||||||
world-wide-web server.</para>
|
|
||||||
|
|
||||||
<variablelist>
|
|
||||||
<title>Useful Directives when configuring Bugzilla</title>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Tell Apache that it's OK to run CGI scripts.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term>
|
|
||||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term>
|
|
||||||
<listitem>
|
|
||||||
<para>These directives are used to tell Apache many things about
|
|
||||||
the directory they apply to. For Bugzilla's purposes, we need
|
|
||||||
them to allow script execution and <filename>.htaccess</filename>
|
|
||||||
overrides.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Used to tell Apache what files are indexes. If you can
|
|
||||||
not add <filename>index.cgi</filename> to the list of valid files,
|
|
||||||
you'll need to set <computeroutput>$index_html</computeroutput> to
|
|
||||||
1 in <filename>localconfig</filename> so
|
|
||||||
<command>./checksetup.pl</command> will create an
|
|
||||||
<filename>index.html</filename> that redirects to
|
|
||||||
<filename>index.cgi</filename>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Used when running Apache on windows so the shebang line
|
|
||||||
doesn't have to be changed in every Bugzilla script.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
|
|
||||||
<para>For more information about how to configure Apache for Bugzilla,
|
|
||||||
see <xref linkend="http-apache"/>.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-b">
|
|
||||||
<title>B</title>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm>Bug</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>A
|
|
||||||
<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
|
|
||||||
<quote>tickets</quote>
|
|
||||||
or
|
|
||||||
<quote>issues</quote>;
|
|
||||||
in the context of Bugzilla, they are synonymous.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<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
|
|
||||||
query, or easily from the very front page by typing the number in the
|
|
||||||
"Find" box.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id="gloss-bugzilla">
|
|
||||||
<glossterm>Bugzilla</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>Bugzilla is the world-leading free software bug tracking system.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-c">
|
|
||||||
<title>C</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-cgi">
|
|
||||||
<glossterm>Common Gateway Interface</glossterm>
|
|
||||||
<acronym>CGI</acronym>
|
|
||||||
<glossdef>
|
|
||||||
<para><acronym>CGI</acronym> is an acronym for Common Gateway Interface. This is
|
|
||||||
a standard for interfacing an external application with a web server. Bugzilla
|
|
||||||
is an example of a <acronym>CGI</acronym> application.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id="gloss-component">
|
|
||||||
<glossterm>Component</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>A Component is a subsection of a Product. It should be a narrow
|
|
||||||
category, tailored to your organization. All Products must contain at
|
|
||||||
least one Component (and, as a matter of fact, creating a Product
|
|
||||||
with no Components will create an error in Bugzilla).</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id="gloss-cpan">
|
|
||||||
<glossterm>
|
|
||||||
<acronym>CPAN</acronym>
|
|
||||||
</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>
|
|
||||||
<acronym>CPAN</acronym>
|
|
||||||
|
|
||||||
stands for the
|
|
||||||
<quote>Comprehensive Perl Archive Network</quote>.
|
|
||||||
CPAN maintains a large number of extremely useful
|
|
||||||
<glossterm>Perl</glossterm>
|
|
||||||
modules - encapsulated chunks of code for performing a
|
|
||||||
particular task.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-d">
|
|
||||||
<title>D</title>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm>daemon</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>A daemon is a computer program which runs in the background. In
|
|
||||||
general, most daemons are started at boot time via System V init
|
|
||||||
scripts, or through RC scripts on BSD-based systems.
|
|
||||||
<glossterm>mysqld</glossterm>,
|
|
||||||
the MySQL server, and
|
|
||||||
<glossterm>apache</glossterm>,
|
|
||||||
a web server, are generally run as daemons.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-g">
|
|
||||||
<title>G</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-groups">
|
|
||||||
<glossterm>Groups</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>The word
|
|
||||||
<quote>Groups</quote>
|
|
||||||
|
|
||||||
has a very special meaning to Bugzilla. Bugzilla's main security
|
|
||||||
mechanism comes by placing users in groups, and assigning those
|
|
||||||
groups certain privileges to view bugs in particular
|
|
||||||
<glossterm>Products</glossterm>
|
|
||||||
in the
|
|
||||||
<glossterm>Bugzilla</glossterm>
|
|
||||||
database.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-j">
|
|
||||||
<title>J</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-javascript">
|
|
||||||
<glossterm>JavaScript</glossterm>
|
|
||||||
<glossdef>
|
|
||||||
<para>JavaScript is cool, we should talk about it.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-m">
|
|
||||||
<title>M</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-mta">
|
|
||||||
<glossterm>Message Transport Agent</glossterm>
|
|
||||||
<acronym>MTA</acronym>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>A Message Transport Agent is used to control the flow of email
|
|
||||||
on a system. Many unix based systems use
|
|
||||||
<ulink url="http://www.sendmail.org">sendmail</ulink> which is what
|
|
||||||
Bugzilla expects to find by default at <filename>/usr/sbin/sendmail</filename>.
|
|
||||||
Many other MTA's will work, but they all require that the
|
|
||||||
<option>sendmailnow</option> param be set to <literal>on</literal>.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id="gloss-mysql">
|
|
||||||
<glossterm>MySQL</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>MySQL is currently the required
|
|
||||||
<glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL
|
|
||||||
can be downloaded from <ulink url="http://www.mysql.com"/>. While you
|
|
||||||
should familiarize yourself with all of the documentation, some high
|
|
||||||
points are:
|
|
||||||
</para>
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Methods for backing up your Bugzilla database.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Information about how to configure MySQL using
|
|
||||||
<filename>my.cnf</filename>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Much more detailed information about the suggestions in
|
|
||||||
<xref linkend="security-mysql"/>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-p">
|
|
||||||
<title>P</title>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm id="gloss-product">Product</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<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
|
|
||||||
its Components.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm>Perl</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>First written by Larry Wall, Perl is a remarkable program
|
|
||||||
language. It has the benefits of the flexibility of an interpreted
|
|
||||||
scripting language (such as shell script), combined with the speed
|
|
||||||
and power of a compiled language, such as C.
|
|
||||||
<glossterm>Bugzilla</glossterm>
|
|
||||||
|
|
||||||
is maintained in Perl.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-q">
|
|
||||||
<title>Q</title>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm>QA</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>
|
|
||||||
<quote>QA</quote>,
|
|
||||||
<quote>Q/A</quote>, and
|
|
||||||
<quote>Q.A.</quote>
|
|
||||||
are short for
|
|
||||||
<quote>Quality Assurance</quote>.
|
|
||||||
In most large software development organizations, there is a team
|
|
||||||
devoted to ensuring the product meets minimum standards before
|
|
||||||
shipping. This team will also generally want to track the progress of
|
|
||||||
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-rdbms">
|
|
||||||
<glossterm>Relational DataBase Managment System</glossterm>
|
|
||||||
<acronym>RDBMS</acronym>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>A relational database management system is a database system
|
|
||||||
that stores information in tables that are related to each other.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-s">
|
|
||||||
<title>S</title>
|
|
||||||
|
|
||||||
<glossentry>
|
|
||||||
<glossterm>
|
|
||||||
<acronym>SGML</acronym>
|
|
||||||
</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>
|
|
||||||
<acronym>SGML</acronym>
|
|
||||||
|
|
||||||
stands for
|
|
||||||
<quote>Standard Generalized Markup Language</quote>.
|
|
||||||
Created in the 1980's to provide an extensible means to maintain
|
|
||||||
documentation based upon content instead of presentation,
|
|
||||||
<acronym>SGML</acronym>
|
|
||||||
|
|
||||||
has withstood the test of time as a robust, powerful language.
|
|
||||||
<glossterm>
|
|
||||||
<acronym>XML</acronym>
|
|
||||||
</glossterm>
|
|
||||||
|
|
||||||
is the
|
|
||||||
<quote>baby brother</quote>
|
|
||||||
|
|
||||||
of SGML; any valid
|
|
||||||
<acronym>XML</acronym>
|
|
||||||
|
|
||||||
document it, by definition, a valid
|
|
||||||
<acronym>SGML</acronym>
|
|
||||||
|
|
||||||
document. The document you are reading is written and maintained in
|
|
||||||
<acronym>SGML</acronym>,
|
|
||||||
and is also valid
|
|
||||||
<acronym>XML</acronym>
|
|
||||||
|
|
||||||
if you modify the Document Type Definition.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-t">
|
|
||||||
<title>T</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-target-milestone" xreflabel="Target Milestone">
|
|
||||||
<glossterm>Target Milestone</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>Target Milestones are Product goals. They are configurable on a
|
|
||||||
per-Product basis. Most software development houses have a concept of
|
|
||||||
|
|
||||||
<quote>milestones</quote>
|
|
||||||
|
|
||||||
where the people funding a project expect certain functionality on
|
|
||||||
certain dates. Bugzilla facilitates meeting these milestones by
|
|
||||||
giving you the ability to declare by which milestone a bug will be
|
|
||||||
fixed, or an enhancement will be implemented.</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id="gloss-tcl">
|
|
||||||
<glossterm>Tool Command Language</glossterm>
|
|
||||||
<acronym>TCL</acronym>
|
|
||||||
<glossdef>
|
|
||||||
<para>TCL is an open source scripting language available for Windows,
|
|
||||||
Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but
|
|
||||||
never released. The first release of Bugzilla was 2.0, which was when
|
|
||||||
it was ported to perl.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
|
|
||||||
<glossdiv id="gloss-z">
|
|
||||||
<title>Z</title>
|
|
||||||
|
|
||||||
<glossentry id="gloss-zarro">
|
|
||||||
<glossterm>Zarro Boogs Found</glossterm>
|
|
||||||
|
|
||||||
<glossdef>
|
|
||||||
<para>This is just a goofy way of saying that there were no bugs
|
|
||||||
found matching your query. When asked to explain this message,
|
|
||||||
Terry had the following to say:
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<blockquote>
|
|
||||||
<attribution>Terry Weissman</attribution>
|
|
||||||
<para>I've been asked to explain this ... way back when, when
|
|
||||||
Netscape released version 4.0 of its browser, we had a release
|
|
||||||
party. Naturally, there had been a big push to try and fix every
|
|
||||||
known bug before the release. Naturally, that hadn't actually
|
|
||||||
happened. (This is not unique to Netscape or to 4.0; the same thing
|
|
||||||
has happened with every software project I've ever seen.) Anyway,
|
|
||||||
at the release party, T-shirts were handed out that said something
|
|
||||||
like "Netscape 4.0: Zarro Boogs". Just like the software, the
|
|
||||||
T-shirt had no known bugs. Uh-huh.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>So, when you query for a list of bugs, and it gets no results,
|
|
||||||
you can think of this as a friendly reminder. Of *course* there are
|
|
||||||
bugs matching your query, they just aren't in the bugsystem yet...
|
|
||||||
</para>
|
|
||||||
</blockquote>
|
|
||||||
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
</glossdiv>
|
|
||||||
</glossary>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,101 +0,0 @@
|
||||||
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
|
|
||||||
<!-- Keep these tools listings in alphabetical order please. -MPB -->
|
|
||||||
<section id="integration">
|
|
||||||
<title>Integrating Bugzilla with Third-Party Tools</title>
|
|
||||||
|
|
||||||
<section id="bonsai"
|
|
||||||
xreflabel="Bonsai, the Mozilla automated CVS management system">
|
|
||||||
<title>Bonsai</title>
|
|
||||||
|
|
||||||
<para>Bonsai is a web-based tool for managing
|
|
||||||
<xref linkend="cvs" />
|
|
||||||
|
|
||||||
. 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. 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.</para>
|
|
||||||
|
|
||||||
<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
|
|
||||||
you want to have the bug be closed automatically, you'll have to modify
|
|
||||||
the <filename>contrib/bugzilla_email_append.pl</filename> script.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<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>.
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="scm"
|
|
||||||
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
|
|
||||||
|
|
||||||
<title>Perforce SCM</title>
|
|
||||||
|
|
||||||
<para>You can find the project page for Bugzilla and Teamtrack Perforce
|
|
||||||
integration (p4dti) at:
|
|
||||||
<ulink url="http://www.ravenbrook.com/project/p4dti/">
|
|
||||||
http://www.ravenbrook.com/project/p4dti</ulink>
|
|
||||||
|
|
||||||
.
|
|
||||||
<quote>p4dti</quote>
|
|
||||||
|
|
||||||
is now an officially supported product from Perforce, and you can find
|
|
||||||
the "Perforce Public Depot" p4dti page at
|
|
||||||
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html">
|
|
||||||
http://public.perforce.com/public/perforce/p4dti/index.html</ulink>
|
|
||||||
|
|
||||||
.</para>
|
|
||||||
|
|
||||||
<para>Integration of Perforce with Bugzilla, once patches are applied, is
|
|
||||||
seamless. Perforce replication information will appear below the comments
|
|
||||||
of each bug. Be certain you have a matching set of patches for the
|
|
||||||
Bugzilla version you are installing. p4dti is designed to support
|
|
||||||
multiple defect trackers, and maintains its own documentation for it.
|
|
||||||
Please consult the pages linked above for further information.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="tinderbox"
|
|
||||||
xreflabel="Tinderbox, the Mozilla automated build management system">
|
|
||||||
<title>Tinderbox/Tinderbox2</title>
|
|
||||||
|
|
||||||
<para>We need Tinderbox integration information.</para>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,149 +0,0 @@
|
||||||
<chapter id="introduction">
|
|
||||||
<title>Introduction</title>
|
|
||||||
|
|
||||||
<section id="whatis">
|
|
||||||
<title>What is Bugzilla?</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
Bugzilla is a bug- or issue-tracking system. Bug-tracking
|
|
||||||
systems allow individual or groups of developers effectively to keep track
|
|
||||||
of outstanding problems with their product.
|
|
||||||
Bugzilla was originally
|
|
||||||
written by Terry Weissman in a programming language called TCL, to
|
|
||||||
replace a rudimentary 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 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, NASA, Linux-Mandrake, and VA Systems.
|
|
||||||
Combined with systems such as
|
|
||||||
<ulink url="http://www.cvshome.org">CVS</ulink>,
|
|
||||||
<ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or
|
|
||||||
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, 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 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>
|
|
||||||
</chapter>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
@ -1,113 +0,0 @@
|
||||||
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
|
|
||||||
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
|
|
||||||
<title>Useful Patches and Utilities for Bugzilla</title>
|
|
||||||
|
|
||||||
<para>Are you looking for a way to put your Bugzilla into overdrive? Catch
|
|
||||||
some of the niftiest tricks here in this section.</para>
|
|
||||||
|
|
||||||
<section id="rewrite" xreflabel="Apache mod_rewrite magic">
|
|
||||||
<title>Apache
|
|
||||||
<filename>mod_rewrite</filename>
|
|
||||||
|
|
||||||
magic</title>
|
|
||||||
|
|
||||||
<para>Apache's
|
|
||||||
<filename>mod_rewrite</filename>
|
|
||||||
|
|
||||||
module lets you do some truly amazing things with URL rewriting. Here are
|
|
||||||
a couple of examples of what you can do.</para>
|
|
||||||
|
|
||||||
<orderedlist>
|
|
||||||
<listitem>
|
|
||||||
<para>Make it so if someone types
|
|
||||||
<computeroutput>http://www.foo.com/12345</computeroutput>
|
|
||||||
|
|
||||||
, Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try
|
|
||||||
setting up your VirtualHost section for Bugzilla with a rule like
|
|
||||||
this:</para>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>There are many, many more things you can do with mod_rewrite.
|
|
||||||
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="cmdline">
|
|
||||||
<title>Command-line Bugzilla Queries</title>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
<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 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, grep for COLUMNLIST
|
|
||||||
in your cookies file to see your current COLUMNLIST setting.</para>
|
|
||||||
|
|
||||||
<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
|
|
||||||
results through
|
|
||||||
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>Akkana Peck says she has good results piping
|
|
||||||
<filename>buglist</filename> output through
|
|
||||||
<command>w3m -T text/html -dump</command>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
|
|
||||||
</appendix>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,88 +0,0 @@
|
||||||
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
|
||||||
<appendix id="downloadlinks">
|
|
||||||
<title>Software Download Links</title>
|
|
||||||
|
|
||||||
<para>All of these sites are current as of April, 2001. Hopefully they'll
|
|
||||||
stay current for a while.</para>
|
|
||||||
|
|
||||||
<para>Apache Web Server:
|
|
||||||
<ulink url="http://www.apache.org/">http://www.apache.org</ulink>
|
|
||||||
|
|
||||||
Optional web server for Bugzilla, but recommended because of broad user
|
|
||||||
base and support.</para>
|
|
||||||
|
|
||||||
<para>Bugzilla:
|
|
||||||
<ulink url="http://www.bugzilla.org/">
|
|
||||||
http://www.bugzilla.org/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>MySQL:
|
|
||||||
<ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>Perl:
|
|
||||||
<ulink url="http://www.perl.org">http://www.perl.org/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>CPAN:
|
|
||||||
<ulink url="http://www.cpan.org/">http://www.cpan.org/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>DBI Perl module:
|
|
||||||
<ulink url="http://www.cpan.org/modules/by-module/DBI/">
|
|
||||||
http://www.cpan.org/modules/by-module/DBI/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>Data::Dumper module:
|
|
||||||
<ulink url="http://www.cpan.org/modules/by-module/Data/">
|
|
||||||
http://www.cpan.org/modules/by-module/Data/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>MySQL related Perl modules:
|
|
||||||
<ulink url="http://www.cpan.org/modules/by-module/Mysql/">
|
|
||||||
http://www.cpan.org/modules/by-module/Mysql/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>TimeDate Perl module collection:
|
|
||||||
<ulink url="http://www.cpan.org/modules/by-module/Date/">
|
|
||||||
http://www.cpan.org/modules/by-module/Date/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>GD Perl module:
|
|
||||||
<ulink url="http://www.cpan.org/modules/by-module/GD/">
|
|
||||||
http://www.cpan.org/modules/by-module/GD/</ulink>
|
|
||||||
|
|
||||||
Alternately, you should be able to find the latest version of GD at
|
|
||||||
<ulink url="http://www.boutell.com/gd/">http://www.boutell.com/gd/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>Chart::Base module:
|
|
||||||
<ulink url="http://www.cpan.org/modules/by-module/Chart/">
|
|
||||||
http://www.cpan.org/modules/by-module/Chart/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>(But remember, Bundle::Bugzilla will install all the modules for you.)
|
|
||||||
</para>
|
|
||||||
</appendix>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,580 +0,0 @@
|
||||||
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
|
||||||
|
|
||||||
<chapter id="using">
|
|
||||||
<title>Using Bugzilla</title>
|
|
||||||
|
|
||||||
<section id="how">
|
|
||||||
<title>How do I use Bugzilla?</title>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
<section id="myaccount">
|
|
||||||
<title>Create a Bugzilla Account</title>
|
|
||||||
|
|
||||||
<para>If you want to use Bugzilla, first you need to create an account.
|
|
||||||
Consult with the administrator responsible for your installation of
|
|
||||||
Bugzilla for the URL you should use to access it. If you're
|
|
||||||
test-driving Bugzilla, use this URL:
|
|
||||||
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/">
|
|
||||||
http://landfill.bugzilla.org/bugzilla-tip/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<orderedlist>
|
|
||||||
<listitem>
|
|
||||||
<para>Click the
|
|
||||||
<quote>Open a new Bugzilla account</quote>
|
|
||||||
|
|
||||||
link, enter your email address and, optionally, your name in the
|
|
||||||
spaces provided, then click
|
|
||||||
<quote>Create Account</quote>
|
|
||||||
|
|
||||||
.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Within moments, you should receive an email to the address
|
|
||||||
you provided above, which contains your login name (generally the
|
|
||||||
same as the email address), and a password you can use to access
|
|
||||||
your account. This password is randomly generated, and can be
|
|
||||||
changed to something more memorable.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Click the
|
|
||||||
<quote>Log In</quote>
|
|
||||||
link in the yellow area at the bottom of the page in your browser,
|
|
||||||
enter your email address and password into the spaces provided, and
|
|
||||||
click
|
|
||||||
<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
|
|
||||||
again.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="bug_page">
|
|
||||||
<title>Anatomy of a Bug</title>
|
|
||||||
|
|
||||||
<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.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1">
|
|
||||||
Bug 1 on Landfill</ulink>
|
|
||||||
|
|
||||||
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. 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
|
|
||||||
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>
|
|
||||||
</simplelist>
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<emphasis>Status and Resolution:</emphasis>
|
|
||||||
|
|
||||||
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>
|
|
||||||
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>
|
|
||||||
(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>
|
|
||||||
The administrator can define keywords which you can use to tag and
|
|
||||||
categorise bugs - e.g. The Mozilla Project has keywords like crash
|
|
||||||
and regression.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<emphasis>Platform and OS:</emphasis>
|
|
||||||
These indicate the computing environment where the bug was
|
|
||||||
found.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<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
|
|
||||||
about.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
<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
|
|
||||||
request.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<emphasis>*Target:</emphasis>
|
|
||||||
(a.k.a. Target Milestone) A future version by which the bug is to
|
|
||||||
be fixed. e.g. The Bugzilla Project's milestones for future
|
|
||||||
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
|
|
||||||
restricted to numbers, thought - you can use any text strings, such
|
|
||||||
as dates.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<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>
|
|
||||||
If this bug cannot be fixed unless other bugs are fixed (depends
|
|
||||||
on), or this bug stops other bugs being fixed (blocks), their
|
|
||||||
numbers are recorded here.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<emphasis>*Votes:</emphasis>
|
|
||||||
Whether this bug has any votes.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<emphasis>Additional Comments:</emphasis>
|
|
||||||
You can add your two cents to the bug discussion here, if you have
|
|
||||||
something worthwhile to say.</para>
|
|
||||||
</listitem>
|
|
||||||
</orderedlist>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="query">
|
|
||||||
<title>Searching for Bugs</title>
|
|
||||||
|
|
||||||
<para>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.bugzilla.org/bugzilla-tip/query.cgi">
|
|
||||||
landfill.bugzilla.org/bugzilla-tip/query.cgi</ulink>
|
|
||||||
|
|
||||||
.</para>
|
|
||||||
|
|
||||||
<para>The Search page has controls for selecting different possible
|
|
||||||
values for all of the fields in a bug, as described above. Once you've
|
|
||||||
defined a search, you can either run it, or save it as a Remembered
|
|
||||||
Query, which can optionally appear in the footer of your pages.</para>
|
|
||||||
|
|
||||||
<para>Highly advanced querying is done using Boolean Charts, which have
|
|
||||||
their own
|
|
||||||
<ulink
|
|
||||||
url="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html">
|
|
||||||
context-sensitive help</ulink>
|
|
||||||
|
|
||||||
.</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="list">
|
|
||||||
<title>Bug Lists</title>
|
|
||||||
|
|
||||||
<para>If you run a search, a list of matching bugs will be returned.
|
|
||||||
The default search is to return all open bugs on the system - don't try
|
|
||||||
running this search on a Bugzilla installation with a lot of
|
|
||||||
bugs!</para>
|
|
||||||
|
|
||||||
<para>The format of the list is configurable. For example, it can be
|
|
||||||
sorted by clicking the column headings. Other useful features can be
|
|
||||||
accessed using the links at the bottom of the list:
|
|
||||||
<simplelist>
|
|
||||||
<member>
|
|
||||||
<emphasis>Long Format:</emphasis>
|
|
||||||
|
|
||||||
this gives you a large page with a non-editable summary of the fields
|
|
||||||
of each bug.</member>
|
|
||||||
|
|
||||||
<member>
|
|
||||||
<emphasis>Change Columns:</emphasis>
|
|
||||||
|
|
||||||
change the bug attributes which appear in the list.</member>
|
|
||||||
|
|
||||||
<member>
|
|
||||||
<emphasis>Change several bugs at once:</emphasis>
|
|
||||||
|
|
||||||
If your account is sufficiently empowered, you can make the same
|
|
||||||
change to all the bugs in the list - for example, changing their
|
|
||||||
owner.</member>
|
|
||||||
|
|
||||||
<member>
|
|
||||||
<emphasis>Send mail to bug owners:</emphasis>
|
|
||||||
|
|
||||||
Sends mail to the owners of all bugs on the list.</member>
|
|
||||||
|
|
||||||
<member>
|
|
||||||
<emphasis>Edit this query:</emphasis>
|
|
||||||
|
|
||||||
If you didn't get exactly the results you were looking for, you can
|
|
||||||
return to the Query page through this link and make small revisions
|
|
||||||
to the query you just made so you get more accurate results.</member>
|
|
||||||
</simplelist>
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="bugreports">
|
|
||||||
<title>Filing Bugs</title>
|
|
||||||
|
|
||||||
<para>Years of bug writing experience has been distilled for your
|
|
||||||
reading pleasure into the
|
|
||||||
<ulink
|
|
||||||
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
|
|
||||||
the failure go a long way toward ensuring accurate, responsible fixes
|
|
||||||
for the bug that bit you.</para>
|
|
||||||
|
|
||||||
<para>The procedure for filing a test bug is as follows:</para>
|
|
||||||
|
|
||||||
<orderedlist>
|
|
||||||
<listitem>
|
|
||||||
<para>Go to
|
|
||||||
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/">
|
|
||||||
Landfill</ulink>
|
|
||||||
in your browser and click
|
|
||||||
<ulink
|
|
||||||
url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi">
|
|
||||||
Enter a new bug report</ulink>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Select a product - any one will do.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Fill in the fields. Bugzilla should have made reasonable
|
|
||||||
guesses, based upon your browser, for the "Platform" and "OS"
|
|
||||||
drop-down boxes. If they are wrong, change them.</para>
|
|
||||||
</listitem>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<para>Select "Commit" and send in your bug report.</para>
|
|
||||||
</listitem>
|
|
||||||
</orderedlist>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<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>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 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 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>
|
|
||||||
|
|
||||||
<section id="emailsettings">
|
|
||||||
<title>Email Settings</title>
|
|
||||||
|
|
||||||
<para>On this tab you can reduce or increase the amount of email sent
|
|
||||||
you from Bugzilla, opting in our out depending on your relationship to
|
|
||||||
the bug and the change that was made to it. (Note that you can also do
|
|
||||||
client-side filtering using the X-Bugzilla-Reason header which Bugzilla
|
|
||||||
adds to all bugmail.)</para>
|
|
||||||
|
|
||||||
<para>By entering user email names, delineated by commas, into the
|
|
||||||
"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 or users go on holiday.</para>
|
|
||||||
|
|
||||||
<note>
|
|
||||||
<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>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
|
|
||||||
functions.</para>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</chapter>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,123 +0,0 @@
|
||||||
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">-->
|
|
||||||
<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
|
|
||||||
and variants, then found a wonderful site which covers an awful lot of what
|
|
||||||
I wanted to discuss. Rather than quote it in its entirety, I'll simply
|
|
||||||
refer you here:
|
|
||||||
<ulink url="http://linas.org/linux/pm.html">
|
|
||||||
http://linas.org/linux/pm.html</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<section id="variant-redhat">
|
|
||||||
<title>Red Hat Bugzilla</title>
|
|
||||||
|
|
||||||
<para>Red Hat's old fork of Bugzilla which was based on version 2.8 is now
|
|
||||||
obsolete. The newest version in use is based on version 2.17.1 and is in
|
|
||||||
the process of being integrated into the main Bugzilla source tree. The
|
|
||||||
back-end is modified to work with PostgreSQL instead of MySQL and they have
|
|
||||||
custom templates to get their desired look and feel, but other than that it
|
|
||||||
is Bugzilla 2.17.1. Dave Lawrence of Red Hat put forth a great deal of
|
|
||||||
effort to make sure that the changes he made could be integrated back into
|
|
||||||
the main tree.
|
|
||||||
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=98304">Bug
|
|
||||||
98304</ulink> exists to track this integration.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>URL:
|
|
||||||
<ulink url="http://bugzilla.redhat.com/bugzilla/">
|
|
||||||
http://bugzilla.redhat.com/bugzilla/</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>This section last updated 24 Dec 2002</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="variant-fenris">
|
|
||||||
<title>Loki Bugzilla (Fenris)</title>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
<para>This section last updated 27 Jul 2002</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="variant-issuezilla">
|
|
||||||
<title>Issuezilla</title>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
<para>This section last updated 27 Jul 2002</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="variant-scarab">
|
|
||||||
<title>Scarab</title>
|
|
||||||
|
|
||||||
<para>Scarab is a new open source bug-tracking system built using Java
|
|
||||||
Servlet technology. It is currently at version 1.0 beta 13.</para>
|
|
||||||
|
|
||||||
<para>URL:
|
|
||||||
<ulink url="http://scarab.tigris.org/">http://scarab.tigris.org</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>This section last updated 18 Jan 2003</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="variant-perforce">
|
|
||||||
<title>Perforce SCM</title>
|
|
||||||
|
|
||||||
<para>Although Perforce isn't really a bug tracker, it can be used as
|
|
||||||
such through the <quote>jobs</quote>
|
|
||||||
functionality.</para>
|
|
||||||
|
|
||||||
<para>URL:
|
|
||||||
<ulink url="http://www.perforce.com/perforce/technotes/note052.html">
|
|
||||||
http://www.perforce.com/perforce/technotes/note052.html
|
|
||||||
</ulink>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>This section last updated 27 Jul 2002</para>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="variant-sourceforge">
|
|
||||||
<title>SourceForge</title>
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
<para>This section last updated 27 Jul 2002</para>
|
|
||||||
</section>
|
|
||||||
</appendix>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-auto-insert-required-elements:t
|
|
||||||
sgml-balanced-tag-edit:t
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-general-insert-case:lower
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-namecase-general:t
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-tag-region-if-active:t
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
@ -1,23 +1,23 @@
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [
|
||||||
|
|
||||||
<!-- Include macros -->
|
<!-- Include macros -->
|
||||||
<!ENTITY about SYSTEM "about.sgml">
|
<!ENTITY about SYSTEM "about.xml">
|
||||||
<!ENTITY conventions SYSTEM "conventions.sgml">
|
<!ENTITY conventions SYSTEM "conventions.xml">
|
||||||
<!ENTITY doc-index SYSTEM "index.sgml">
|
<!ENTITY doc-index SYSTEM "index.xml">
|
||||||
<!ENTITY faq SYSTEM "faq.sgml">
|
<!ENTITY faq SYSTEM "faq.xml">
|
||||||
<!ENTITY gfdl SYSTEM "gfdl.sgml">
|
<!ENTITY gfdl SYSTEM "gfdl.xml">
|
||||||
<!ENTITY glossary SYSTEM "glossary.sgml">
|
<!ENTITY glossary SYSTEM "glossary.xml">
|
||||||
<!ENTITY installation SYSTEM "installation.sgml">
|
<!ENTITY installation SYSTEM "installation.xml">
|
||||||
<!ENTITY administration SYSTEM "administration.sgml">
|
<!ENTITY administration SYSTEM "administration.xml">
|
||||||
<!ENTITY using SYSTEM "using.sgml">
|
<!ENTITY using SYSTEM "using.xml">
|
||||||
<!ENTITY integration SYSTEM "integration.sgml">
|
<!ENTITY integration SYSTEM "integration.xml">
|
||||||
<!ENTITY future SYSTEM "future.sgml">
|
<!ENTITY future SYSTEM "future.xml">
|
||||||
<!ENTITY index SYSTEM "index.sgml">
|
<!ENTITY index SYSTEM "index.xml">
|
||||||
<!ENTITY database SYSTEM "database.sgml">
|
<!ENTITY database SYSTEM "database.xml">
|
||||||
<!ENTITY patches SYSTEM "patches.sgml">
|
<!ENTITY patches SYSTEM "patches.xml">
|
||||||
<!ENTITY variants SYSTEM "variants.sgml">
|
<!ENTITY variants SYSTEM "variants.xml">
|
||||||
<!ENTITY introduction SYSTEM "introduction.sgml">
|
<!ENTITY introduction SYSTEM "introduction.xml">
|
||||||
<!ENTITY revhistory SYSTEM "revhistory.sgml">
|
<!ENTITY revhistory SYSTEM "revhistory.xml">
|
||||||
|
|
||||||
<!-- Things to change for a stable release:
|
<!-- Things to change for a stable release:
|
||||||
* bz-ver to current stable
|
* bz-ver to current stable
|
||||||
|
|
@ -70,7 +70,7 @@
|
||||||
<!-- Coding standards for this document
|
<!-- Coding standards for this document
|
||||||
|
|
||||||
* Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
|
* Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
|
||||||
* Use Entities to include files for new chapters in Bugzilla-Guide.sgml.
|
* Use Entities to include files for new chapters in Bugzilla-Guide.xml.
|
||||||
* Try to use Entities for frequently-used passages of text as well.
|
* Try to use Entities for frequently-used passages of text as well.
|
||||||
* Ensure all documents compile cleanly to HTML after modification.
|
* Ensure all documents compile cleanly to HTML after modification.
|
||||||
The warning, "DTDDECL catalog types not supported" is normal.
|
The warning, "DTDDECL catalog types not supported" is normal.
|
||||||
|
|
@ -79,7 +79,7 @@ The warning, "DTDDECL catalog types not supported" is normal.
|
||||||
* Follow coding standards at http://www.tldp.org, and
|
* Follow coding standards at http://www.tldp.org, and
|
||||||
check out the KDE guidelines (they are nice, too)
|
check out the KDE guidelines (they are nice, too)
|
||||||
http://i18n.kde.org/doc/markup.html
|
http://i18n.kde.org/doc/markup.html
|
||||||
* All tags should be lowercase (needsfix)
|
* All tags should be lowercase.
|
||||||
* Please use sensible spacing. The comments at the very end of each
|
* Please use sensible spacing. The comments at the very end of each
|
||||||
file define reasonable defaults for PSGML mode in EMACS.
|
file define reasonable defaults for PSGML mode in EMACS.
|
||||||
Double-indent tags, use double spacing whenever possible, and
|
Double-indent tags, use double spacing whenever possible, and
|
||||||
|
|
@ -120,7 +120,7 @@ try to avoid clutter and feel free to waste space in the code to make it more re
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This documentation is maintained in DocBook 4.1.2 XML format.
|
This documentation is maintained in DocBook 4.1.2 XML format.
|
||||||
Changes are best submitted as plain text or SGML diffs, attached
|
Changes are best submitted as plain text or XML diffs, attached
|
||||||
to a bug filed in the &bzg-bugs; compontent.
|
to a bug filed in the &bzg-bugs; compontent.
|
||||||
</para>
|
</para>
|
||||||
<![%bz-devel;[
|
<![%bz-devel;[
|
||||||
|
|
@ -198,7 +198,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
||||||
<!ENTITY conventions SYSTEM "conventions.sgml"> ] > -->
|
<!ENTITY conventions SYSTEM "conventions.xml"> ] > -->
|
||||||
|
|
||||||
<chapter id="about">
|
<chapter id="about">
|
||||||
<title>About This Guide</title>
|
<title>About This Guide</title>
|
||||||
|
|
@ -221,7 +221,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End: -->
|
End: -->
|
||||||
|
|
|
||||||
|
|
@ -1632,7 +1632,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -171,7 +171,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -386,7 +386,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -1314,7 +1314,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -440,7 +440,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -474,7 +474,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -1165,7 +1165,7 @@ my $webservergid = '8'
|
||||||
<command>look GD</command>.
|
<command>look GD</command>.
|
||||||
This should go through the motions of downloading the latest version of
|
This should go through the motions of downloading the latest version of
|
||||||
the GD module, then it will open a shell and drop you into the build
|
the GD module, then it will open a shell and drop you into the build
|
||||||
directory. Apply <ulink url="../sgml/gd-makefile.patch">this patch</ulink>
|
directory. Apply <ulink url="../xml/gd-makefile.patch">this patch</ulink>
|
||||||
to the Makefile.PL file (save the
|
to the Makefile.PL file (save the
|
||||||
patch into a file and use the command
|
patch into a file and use the command
|
||||||
<command>patch < patchfile</command>.)
|
<command>patch < patchfile</command>.)
|
||||||
|
|
@ -1561,7 +1561,7 @@ at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.
|
||||||
<para>Numerous people have reported that upgrading to version 5.6.1
|
<para>Numerous people have reported that upgrading to version 5.6.1
|
||||||
or higher solved the problem for them. A less involved fix is to apply
|
or higher solved the problem for them. A less involved fix is to apply
|
||||||
the patch in <xref linkend="trouble-filetemp-patch"/>. The patch is also
|
the patch in <xref linkend="trouble-filetemp-patch"/>. The patch is also
|
||||||
available as a <ulink url="../sgml/filetemp.patch">patch file</ulink>.
|
available as a <ulink url="../xml/filetemp.patch">patch file</ulink>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<figure id="trouble-filetemp-patch">
|
<figure id="trouble-filetemp-patch">
|
||||||
|
|
@ -1607,7 +1607,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -93,7 +93,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -142,7 +142,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
|
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
||||||
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
|
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
|
||||||
<title>Useful Patches and Utilities for Bugzilla</title>
|
<title>Useful Patches and Utilities for Bugzilla</title>
|
||||||
|
|
||||||
|
|
@ -105,7 +105,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -80,7 +80,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -572,7 +572,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
|
|
@ -115,7 +115,7 @@ sgml-local-ecat-files:nil
|
||||||
sgml-minimize-attributes:nil
|
sgml-minimize-attributes:nil
|
||||||
sgml-namecase-general:t
|
sgml-namecase-general:t
|
||||||
sgml-omittag:t
|
sgml-omittag:t
|
||||||
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||||
sgml-shorttag:t
|
sgml-shorttag:t
|
||||||
sgml-tag-region-if-active:t
|
sgml-tag-region-if-active:t
|
||||||
End:
|
End:
|
||||||
|
|
|
||||||
Загрузка…
Ссылка в новой задаче