Skip to content

bugzilla
bugzilla
Commit e303177c authored by gerv%gerv.net's avatar gerv%gerv.net
Browse files
Options

Merging new docs from 2.16 branch.

parent 9284fe0a
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 186 additions and 210 deletions
docs/en/xml/Bugzilla-Guide.xml
View file @ e303177c
...@@ -16,17 +16,17 @@ ...@@ -16,17 +16,17 @@
<!ENTITY database SYSTEM "database.sgml"> <!ENTITY database SYSTEM "database.sgml">
<!ENTITY patches SYSTEM "patches.sgml"> <!ENTITY patches SYSTEM "patches.sgml">
<!ENTITY variants SYSTEM "variants.sgml"> <!ENTITY variants SYSTEM "variants.sgml">
<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> <!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml"> <!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.mozilla.org/projects/bugzilla"> <!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bz-ver "2.14"> <!ENTITY bz-ver "2.16">
<!ENTITY bz-cvs-ver "2.15"> <!ENTITY bz-cvs-ver "2.17">
<!ENTITY bzg-date "August 10, 2001"> <!ENTITY bzg-date "April 2nd, 2002">
<!ENTITY bzg-ver "2.14"> <!ENTITY bzg-ver "2.16">
<!ENTITY bzg-cvs-ver "2.15.0"> <!ENTITY bzg-cvs-ver "2.17.0">
<!ENTITY bzg-auth "Matthew P. Barnson"> <!ENTITY bzg-auth "The Bugzilla Team">
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>"> <!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla</ulink>">
<!ENTITY mysql "http://www.mysql.com/"> <!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1"> <!ENTITY perl-ver "5.6.1">
...@@ -59,112 +59,37 @@ try to avoid clutter and feel free to waste space in the code to make it more re ...@@ -59,112 +59,37 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<bookinfo> <bookinfo>
<title>The Bugzilla Guide</title> <title>The Bugzilla Guide</title>
<pubdate>2001-04-25</pubdate>
<revhistory>
<revision>
<revnumber>v2.11</revnumber>
<date>20 December 2000</date>
<authorinitials>MPB</authorinitials>
<revremark>
Converted the README, FAQ, and DATABASE information into
SGML docbook format.
</revremark>
</revision>
<revision>
<revnumber>2.11.1</revnumber>
<date>06 March 2001</date>
<authorinitials>MPB</authorinitials>
<revremark>
Took way too long to revise this for 2.12 release. Updated
FAQ to use qandaset tags instead of literallayout, cleaned
up administration section, added User Guide section,
miscellaneous FAQ updates and third-party integration
information. From this point on all new tags are lowercase
in preparation for the 2.13 release of the Guide in XML
format instead of SGML.
</revremark>
</revision>
<revision>
<revnumber>2.12.0</revnumber>
<date>24 April 2001</date>
<authorinitials>MPB</authorinitials>
<revremark>
Things fixed this release: Elaborated on queryhelp
interface, added FAQ regarding moving bugs from one keyword
to another, clarified possible problems with the Landfill
tutorial, fixed a boatload of typos and unclear sentence
structures. Incorporated the README into the UNIX
installation section, and changed the README to indicate the
deprecated status. Things I know need work: Used
"simplelist" a lot, where I should have used "procedure" to
tag things. Need to lowercase all tags to be XML compliant.
</revremark>
</revision>
<revision>
<revnumber>2.14.0</revnumber>
<date>07 August 2001</date>
<authorinitials>MPB</authorinitials>
<revremark>
Attempted to integrate relevant portions of the UNIX and
Windows installation instructions, moved some data from FAQ
to Install, removed references to README from text, added
Mac OS X install instructions, fixed a bunch
of tpyos (Mark Harig), linked text that referenced other
parts of the Guide, and nuked the old MySQL permissions
section.
</revremark>
</revision>
</revhistory>
<authorgroup> <authorgroup>
<author> <author>
<firstname>Matthew</firstname> <firstname>Matthew</firstname>
<othername>P.</othername> <othername>P.</othername>
<surname>Barnson</surname> <surname>Barnson</surname>
<affiliation> </author>
<address><email>barnboy@trilobyte.net</email></address> <author>
</affiliation> <firstname>The</firstname>
<othername>Bugzilla</othername>
<surname>Team</surname>
</author> </author>
<collab>
<collabname>Zach Lipton</collabname>
<affiliation>
<address><email>zach AT zachlipton DOT com</email></address>
</affiliation>
</collab>
</authorgroup> </authorgroup>
<abstract> <abstract>
<para> <para>
This is the documentation for Bugzilla, the Mozilla This is the documentation for Bugzilla, the mozilla.org
bug-tracking system. 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>
<para>
Bugzilla is an enterprise-class set of software utilities <para>
that, when used together, power issue-tracking for hundreds of This documentation is maintained in DocBook 4.1.2 XML format.
organizations around the world, tracking millions of bugs. Changes are best submitted as plain text or SGML diffs, attached
While it is easy to use and quite flexible, it is to a bug filed in
difficult for a novice to install and maintain. Although we <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation">mozilla.org's Bugzilla</ulink>.
have provided step-by-step directions, Bugzilla is not always
easy to get working. Please be sure the person responsible
for installing and maintaining this software is a qualified
professional for the operating system upon which you install
Bugzilla.
</para>
<para>
THIS DOCUMENTATION IS MAINTAINED IN DOCBOOK 4.1.2 XML FORMAT.
IF YOU WISH TO MAKE CORRECTIONS, PLEASE MAKE THEM IN PLAIN
TEXT OR SGML DIFFS AGAINST THE SOURCE. I CANNOT ACCEPT
ADDITIONS TO THE GUIDE WRITTEN IN HTML!
</para> </para>
</abstract> </abstract>
<keywordset> <keywordset>
<keyword>Bugzilla</keyword> <keyword>Bugzilla</keyword>
<keyword>Guide</keyword> <keyword>Guide</keyword>
...@@ -181,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re ...@@ -181,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- About This Guide --> <!-- About This Guide -->
&about; &about;
<!-- Introduction -->
&introduction;
<!-- Using Bugzilla --> <!-- Using Bugzilla -->
&using; &using;
...@@ -190,29 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re ...@@ -190,29 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Administering Bugzilla --> <!-- Administering Bugzilla -->
&administration; &administration;
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
<!-- The Future of Bugzilla -->
&future;
<!-- Major Bugzilla Variants -->
&variants;
<!-- Appendix: The Frequently Asked Questions --> <!-- Appendix: The Frequently Asked Questions -->
&faq; &faq;
<!-- Appendix: Required Bugzilla Software Links -->
&requiredsoftware;
<!-- Appendix: The Database Schema --> <!-- Appendix: The Database Schema -->
&database; &database;
<!-- Appendix: Custom Patches --> <!-- Appendix: Custom Patches -->
&patches; &patches;
<!-- Appendix: The GNU Free Documentation License --> <!-- Appendix: Major Bugzilla Variants -->
&gfdl; &variants;
<!-- Glossary --> <!-- Glossary -->
&glossary; &glossary;
......
docs/en/xml/conventions.xml
View file @ e303177c
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<section id="conventions"> <section id="conventions">
<title>Document Conventions</title> <title>Document Conventions</title>
<indexterm zone="conventions"> <indexterm zone="conventions">
<primary>conventions</primary> <primary>conventions</primary>
</indexterm> </indexterm>
<para> <para>This document uses the following conventions:</para>
This document uses the following conventions
</para>
<informaltable frame="none"> <informaltable frame="none">
<tgroup cols="2"> <tgroup cols="2">
<thead> <thead>
<row> <row>
<entry>Descriptions</entry> <entry>Descriptions</entry>
<entry>Appearance</entry> <entry>Appearance</entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry>Warnings</entry> <entry>Warnings</entry>
<entry><caution>
<para>Warnings.</para> <entry>
</caution></entry> <caution>
<para>Don't run with scissors!</para>
</caution>
</entry>
</row> </row>
<row> <row>
<entry>Hint</entry> <entry>Hint</entry>
<entry><tip>
<para>Hint.</para> <entry>
</tip></entry> <tip>
<para>Would you like a breath mint?</para>
</tip>
</entry>
</row> </row>
<row> <row>
<entry>Notes</entry> <entry>Notes</entry>
<entry><note>
<para>Note.</para> <entry>
</note></entry> <note>
<para>Dear John...</para>
</note>
</entry>
</row> </row>
<row> <row>
<entry>Information requiring special attention</entry> <entry>Information requiring special attention</entry>
<entry><warning>
<para>Warning.</para> <entry>
</warning></entry> <warning>
<para>Read this or the cat gets it.</para>
</warning>
</entry>
</row> </row>
<row> <row>
<entry>File Names</entry> <entry>File Names</entry>
<entry><filename>file.extension</filename></entry>
<entry>
<filename>filename</filename>
</entry>
</row> </row>
<row> <row>
<entry>Directory Names</entry> <entry>Directory Names</entry>
<entry><filename class="directory">directory</filename></entry>
<entry>
<filename class="directory">directory</filename>
</entry>
</row> </row>
<row> <row>
<entry>Commands to be typed</entry> <entry>Commands to be typed</entry>
<entry><command>command</command></entry>
<entry>
<command>command</command>
</entry>
</row> </row>
<row> <row>
<entry>Applications Names</entry> <entry>Applications Names</entry>
<entry><application>application</application></entry>
<entry>
<application>application</application>
</entry>
</row> </row>
<row> <row>
<entry><foreignphrase>Prompt</foreignphrase> of users command under bash shell</entry> <entry>
<foreignphrase>Prompt</foreignphrase>
of users command under bash shell</entry>
<entry>bash$</entry> <entry>bash$</entry>
</row> </row>
<row> <row>
<entry><foreignphrase>Prompt</foreignphrase> of root users command under bash shell</entry> <entry>
<foreignphrase>Prompt</foreignphrase>
of root users command under bash shell</entry>
<entry>bash#</entry> <entry>bash#</entry>
</row> </row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of user command under tcsh shell</entry> <row>
<entry>tcsh$</entry> <entry>
</row> <foreignphrase>Prompt</foreignphrase>
of user command under tcsh shell</entry>
<entry>tcsh$</entry>
</row>
<row> <row>
<entry>Environment Variables</entry> <entry>Environment Variables</entry>
<entry><envar>VARIABLE</envar></entry>
<entry>
<envar>VARIABLE</envar>
</entry>
</row> </row>
<row> <row>
<entry>Emphasized word</entry> <entry>Emphasized word</entry>
<entry><emphasis>word</emphasis></entry>
<entry>
<emphasis>word</emphasis>
</entry>
</row> </row>
<row> <row>
<entry>Code Example</entry> <entry>Code Example</entry>
<entry><programlisting><sgmltag class="starttag">para</sgmltag>Beginning and end of paragraph<sgmltag class="endtag">para</sgmltag></programlisting></entry>
<entry>
<programlisting><sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag></programlisting>
</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
</section> </section>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -114,3 +168,4 @@ sgml-shorttag:t ...@@ -114,3 +168,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
docs/en/xml/installation.xml
View file @ e303177c
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/en/xml/integration.xml
View file @ e303177c
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB --> <!-- Keep these tools listings in alphabetical order please. -MPB -->
<section id="integration">
<chapter id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title> <title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai" xreflabel="Bonsai, the Mozilla automated CVS management system"> <section id="bonsai"
xreflabel="Bonsai, the Mozilla automated CVS management system">
<title>Bonsai</title> <title>Bonsai</title>
<para>Bonsai is a web-based tool for managing <xref
linkend="cvs" /> <para>Bonsai is a web-based tool for managing
. Using Bonsai, administrators can control open/closed status <xref linkend="cvs" />
of trees, query a fast relational database back-end for change,
branch, and comment information, and view changes made since the . Using Bonsai, administrators can control open/closed status of trees,
last time the tree was closed. These kinds of changes cause the query a fast relational database back-end for change, branch, and comment
engineer responsible to be <quote>on the hook</quote> (include information, and view changes made since the last time the tree was
cool URL link here for Hook policies at mozilla.org). Bonsai closed. Bonsai
also includes gateways to <xref also integrates with
linkend="tinderbox" /> and Bugzilla </para> <xref linkend="tinderbox" />.
</para>
</section> </section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System"> <section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<title>CVS</title> <title>CVS</title>
<para>CVS integration is best accomplished, at this point, using
the Bugzilla Email Gateway. There have been some files <para>CVS integration is best accomplished, at this point, using the
submitted to allow greater CVS integration, but we need to make Bugzilla Email Gateway.</para>
certain that Bugzilla is not tied into one particular software
management package.</para> <para>Follow the instructions in this Guide for enabling Bugzilla e-mail
<para> integration. Ensure that your check-in script sends an email to your
Follow the instructions in the FAQ for enabling Bugzilla e-mail Bugzilla e-mail gateway with the subject of
integration. Ensure that your check-in script sends an email to <quote>[Bug XXXX]</quote>,
your Bugzilla e-mail gateway with the subject of <quote>[Bug and you can have CVS check-in comments append to your Bugzilla bug. If
XXXX]</quote>, and you can have CVS check-in comments append you have your check-in script include an @resolution field, you can even
to your Bugzilla bug. If you have your check-in script include change the Bugzilla bug state.</para>
an @resolution field, you can even change the Bugzilla bug
state. <para>There is also a CVSZilla project, based upon somewhat dated
</para> Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
<para> email. Check it out at:
There is also a project, based upon somewhat dated Bugzilla <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
code, to integrate CVS and Bugzilla through CVS' ability to http://homepages.kcbbs.gen.nz/~tonyg/</ulink>.
email. Check it out at:
<ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>, under the
<quote>cvszilla</quote> link.
</para> </para>
</section> </section>
<section id="scm" xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS"> <section id="scm"
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
<title>Perforce SCM</title> <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"> <para>You can find the project page for Bugzilla and Teamtrack Perforce
<title>Tinderbox/Tinderbox2</title> integration (p4dti) at:
<para>We need Tinderbox integration information.</para> <ulink url="http://www.ravenbrook.com/project/p4dti/">
</section> http://www.ravenbrook.com/project/p4dti</ulink>
</chapter> .
<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 <!-- Keep this comment at the end of the file
Local variables: Local variables:
...@@ -93,3 +97,4 @@ sgml-shorttag:t ...@@ -93,3 +97,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment