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 @@
<!ENTITY database SYSTEM "database.sgml">
<!ENTITY patches SYSTEM "patches.sgml">
<!ENTITY variants SYSTEM "variants.sgml">
<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml">
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.mozilla.org/projects/bugzilla">
<!ENTITY bz-ver "2.14">
<!ENTITY bz-cvs-ver "2.15">
<!ENTITY bzg-date "August 10, 2001">
<!ENTITY bzg-ver "2.14">
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bz-ver "2.16">
<!ENTITY bz-cvs-ver "2.17">
<!ENTITY bzg-date "April 2nd, 2002">
<!ENTITY bzg-ver "2.16">
<!ENTITY bzg-cvs-ver "2.17.0">
<!ENTITY bzg-auth "The Bugzilla Team">
<!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 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
<bookinfo>
<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>
<author>
<firstname>Matthew</firstname>
<othername>P.</othername>
<surname>Barnson</surname>
<affiliation>
<address><email>barnboy@trilobyte.net</email></address>
</affiliation>
<firstname>Matthew</firstname>
<othername>P.</othername>
<surname>Barnson</surname>
</author>
<author>
<firstname>The</firstname>
<othername>Bugzilla</othername>
<surname>Team</surname>
</author>
<collab>
<collabname>Zach Lipton</collabname>
<affiliation>
<address><email>zach AT zachlipton DOT com</email></address>
</affiliation>
</collab>
</authorgroup>
<abstract>
<para>
This is the documentation for Bugzilla, the Mozilla
bug-tracking system.
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>
Bugzilla is an enterprise-class set of software utilities
that, when used together, power issue-tracking for hundreds of
organizations around the world, tracking millions of bugs.
While it is easy to use and quite flexible, it is
difficult for a novice to install and maintain. Although we
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>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or SGML diffs, attached
to a bug filed in
<ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation">mozilla.org's Bugzilla</ulink>.
</para>
</abstract>
<keywordset>
<keyword>Bugzilla</keyword>
<keyword>Guide</keyword>
......@@ -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;
<!-- Introduction -->
&introduction;
<!-- Using Bugzilla -->
&using;
......@@ -190,29 +118,17 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Administering Bugzilla -->
&administration;
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
<!-- The Future of Bugzilla -->
&future;
<!-- Major Bugzilla Variants -->
&variants;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
<!-- Appendix: Required Bugzilla Software Links -->
&requiredsoftware;
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Custom Patches -->
&patches;
<!-- Appendix: The GNU Free Documentation License -->
&gfdl;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Glossary -->
&glossary;
......
docs/en/xml/conventions.xml
View file @ e303177c
<!-- <!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>
<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>Warnings.</para>
</caution></entry>
<entry>
<caution>
<para>Don't run with scissors!</para>
</caution>
</entry>
</row>
<row>
<entry>Hint</entry>
<entry><tip>
<para>Hint.</para>
</tip></entry>
<entry>
<tip>
<para>Would you like a breath mint?</para>
</tip>
</entry>
</row>
<row>
<entry>Notes</entry>
<entry><note>
<para>Note.</para>
</note></entry>
<entry>
<note>
<para>Dear John...</para>
</note>
</entry>
</row>
<row>
<entry>Information requiring special attention</entry>
<entry><warning>
<para>Warning.</para>
</warning></entry>
<entry>
<warning>
<para>Read this or the cat gets it.</para>
</warning>
</entry>
</row>
<row>
<entry>File Names</entry>
<entry><filename>file.extension</filename></entry>
<entry>
<filename>filename</filename>
</entry>
</row>
<row>
<entry>Directory Names</entry>
<entry><filename class="directory">directory</filename></entry>
<entry>
<filename class="directory">directory</filename>
</entry>
</row>
<row>
<entry>Commands to be typed</entry>
<entry><command>command</command></entry>
<entry>
<command>command</command>
</entry>
</row>
<row>
<entry>Applications Names</entry>
<entry><application>application</application></entry>
<entry>
<application>application</application>
</entry>
</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>
</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>
</row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of user command under tcsh shell</entry>
<entry>tcsh$</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>
<entry>
<envar>VARIABLE</envar>
</entry>
</row>
<row>
<entry>Emphasized word</entry>
<entry><emphasis>word</emphasis></entry>
<entry>
<emphasis>word</emphasis>
</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>
<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
......@@ -114,3 +168,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t
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" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB -->
<chapter id="integration">
<section id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai" xreflabel="Bonsai, the Mozilla automated CVS management system">
<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. These kinds of changes cause the
engineer responsible to be <quote>on the hook</quote> (include
cool URL link here for Hook policies at mozilla.org). Bonsai
also includes gateways to <xref
linkend="tinderbox" /> and Bugzilla </para>
<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. There have been some files
submitted to allow greater CVS integration, but we need to make
certain that Bugzilla is not tied into one particular software
management package.</para>
<para>
Follow the instructions in the FAQ 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 have your check-in script include
an @resolution field, you can even change the Bugzilla bug
state.
</para>
<para>
There is also a project, based upon somewhat dated Bugzilla
code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at:
<ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>, under the
<quote>cvszilla</quote> link.
<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 have your check-in script include an @resolution field, you can even
change the Bugzilla bug state.</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">
<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>
<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>
</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
Local variables:
......@@ -93,3 +97,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t
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