Skip to content

bugzilla
bugzilla
Commit e5b9f4fa authored by barnboy%trilobyte.net's avatar barnboy%trilobyte.net
Browse files
Options

Updated Bugzilla Guide and README to fix bug 76156, bug 76841, and bug 26242.

The README is now gutted, pointers to Guide. Also some new sections added, old ones fixed, and notes appended to deprecated sections I've not yet had the heart to remove.
parent 7016a5a0
Expand all Show whitespace changes
Inline Side-by-side
Showing with 192 additions and 219 deletions
docs/en/xml/Bugzilla-Guide.xml
View file @ e5b9f4fa
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
<!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Include macros -->
<!ENTITY about SYSTEM "about.xml">
<!ENTITY conventions SYSTEM "conventions.xml">
<!ENTITY doc-index SYSTEM "index.xml">
<!ENTITY gfdl SYSTEM "gfdl.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
<!ENTITY installation SYSTEM "installation.xml">
<!ENTITY administration SYSTEM "administration.xml">
<!ENTITY security SYSTEM "security.xml">
<!ENTITY using SYSTEM "using.xml">
<!ENTITY integration SYSTEM "integration.xml">
<!ENTITY index SYSTEM "index.xml">
<!ENTITY customization SYSTEM "customization.xml">
<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
<!ENTITY patches SYSTEM "patches.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY modules SYSTEM "modules.xml">
<!-- Things to change for a stable release:
* bz-ver to current stable
* bz-nexver to next stable
* bz-date to the release date
* landfillbase to the branch install
* Remove the BZ-DEVEL comments
- COMPILE DOCS AND CHECKIN -
Also, tag and tarball before completing
* bz-ver to devel version
For a devel release, simple bump bz-ver and bz-date
-->
<!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 requiredsoftware SYSTEM "requiredsoftware.sgml">
<!ENTITY bz-ver "3.1.3">
<!ENTITY bz-nextver "3.2">
<!ENTITY bz-date "2008-02-01">
<!ENTITY current-year "2008">
]>
<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bzg-bugs "<ulink url='https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!-- Coding standards for this document
<!ENTITY min-perl-ver "5.8.1">
]>
1. Preface new or modified sections with a comment stating who
modified it and when; please also use the "authorinitials" tag.
2. There is no "two".
<!-- Coding standards for this document
3. Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
4. Use Entities to include files for new chapters in Bugzilla-Guide.sgml.
5. Ensure all documents compile cleanly to HTML after modification.
The errors "DTD Declaration not allowed here" and "DTDDECL catalog types not supported"
are normal errors to be expected when compiling the whole guide.
6. Try to index important terms wherever possible.
7. Follow coding standards at http://www.linuxdoc.org.
8. All tags should be lowercase (needsfix)
* 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.xml.
* 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.
* Please use sensible spacing. The comments at the very end of each
9. Code being submitted for review should use the
"review" tag. Documentation on this is available at
http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html
under section 4.9.4, "Making notes on the text while it's being written".
10. Please use sensible spacing. The comments at the very end of each Guide
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.
Double-indent tags, use double spacing whenever possible,
try to avoid clutter and feel free to waste space in the code to make it more readable.
-->
<book id="index">
<BOOK ID="index">
<!-- Header -->
<bookinfo>
<title>The Bugzilla Guide - &bz-ver;
<!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL -->
Release</title>
<authorgroup>
<corpauthor>The Bugzilla Team</corpauthor>
</authorgroup>
<pubdate>&bz-date;</pubdate>
<abstract>
<para>
This is the documentation for Bugzilla, a
bug-tracking system from mozilla.org.
Bugzilla is an enterprise-class piece of software
that tracks millions of bugs and issues for hundreds of
organizations around the world.
</para>
<para>
The most current version of this document can always be found on the
<ulink url="http://www.bugzilla.org/docs/">Bugzilla
Documentation Page</ulink>.
</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>
<BOOKINFO>
<TITLE>The Bugzilla Guide</TITLE>
<PUBDATE>v2.12.0, 24 April 2001</PUBDATE>
<AUTHOR>
<FIRSTNAME>Matthew</FIRSTNAME>
<OTHERNAME>P.</OTHERNAME>
<SURNAME>Barnson</SURNAME>
<affiliation>
<address><email>barnboy@trilobyte.net</email></address>
</affiliation>
</AUTHOR>
<ABSTRACT>
<PARA>This is the documentation for Bugzilla, the Mozilla bug-tracking system.</PARA>
</ABSTRACT>
<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>
</REVHISTORY>
<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;
......@@ -125,25 +133,31 @@
<!-- Administering Bugzilla -->
&administration;
<!-- Securing Bugzilla -->
&security;
<!-- Using Bugzilla -->
&using;
<!-- Customizing Bugzilla -->
&customization;
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
<!-- The Future of Bugzilla -->
&future;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
<!-- Appendix: Required Bugzilla Software Links -->
&requiredsoftware
<!-- Appendix: Troubleshooting -->
&troubleshooting;
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Appendix: Custom Patches -->
&patches;
<!-- Appendix: Manually Installing Perl Modules -->
&modules;
<!-- Appendix: GNU Free Documentation License -->
<!-- Appendix: The GNU Free Documentation License -->
&gfdl;
<!-- Glossary -->
......@@ -152,27 +166,31 @@
<!-- Index -->
&index;
</book>
</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-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
docs/en/xml/administration.xml
View file @ e5b9f4fa
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/en/xml/installation.xml
View file @ e5b9f4fa
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 @ e5b9f4fa
<!-- <!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 -->
<section id="integration">
<chapter id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai"
xreflabel="Bonsai, the Mozilla automated CVS management system">
<section id="bonsai">
<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>
<para>We need Bonsai integration information.</para>
</section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<section id="cvs">
<title>CVS</title>
<para>We need CVS integration information</para>
</section>
<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.
<section id="scm">
<title>Perforce SCM</title>
<para>
Richard Brooksby created a Perforce integration tool for Bugzilla and TeamTrack.
You can find the main project page at
<ulink url="http://www.ravenbrook.com/project/p4dti/">
http://www.ravenbrook.com/project/p4dti</ulink>. "p4dti" 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>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://www.cvszilla.org/"/>.
<para>
Integration of Perforce with Bugzilla, once patches are applied, is fairly seamless. However,
p4dti is a patch against the Bugzilla 2.10 release, not the current 2.12 release. I anticipate
patches for 2.12 will be out shortly. Check the project page regularly for updates, or
take the given patches and patch it manually. 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>
<para>Another system capable of CVS integration with Bugzilla is
Scmbug. This system provides generic integration of Source code
Configuration Management with Bugtracking. Check it out at: <ulink
url="http://freshmeat.net/projects/scmbug/"/>.
<para>
Right now, there is no way to synchronize the Bug ID and the Perforce Transaction Number, or
to change the Bug ID to read (PRODUCT).bugID unless you hack it in. Additionally, if you
have synchronization problems, the easiest way to avoid them is to only put the bug
information, comments, etc. into Bugzilla, and not into the Perforce change records.
They will link anyway; merely reference the bug ID fixed in your change description,
and put a comment into Bugzilla
giving the change ID that fixed the Bugzilla bug. It's a process issue, not a technology
question.
</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/"/>
.
<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"/>
.</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="svn"
xreflabel="Subversion, a compelling replacement for CVS">
<title>Subversion</title>
<para>Subversion is a free/open-source version control system,
designed to overcome various limitations of CVS. Integration of
Subversion with Bugzilla is possible using Scmbug, a system
providing generic integration of Source Code Configuration
Management with Bugtracking. Scmbug is available at <ulink
url="http://freshmeat.net/projects/scmbug/"/>.</para>
<section id="tinderbox">
<title>Tinderbox</title>
<para>We need Tinderbox integration information</para>
</section>
<section id="tinderbox"
xreflabel="Tinderbox, the Mozilla automated build management system">
<title>Tinderbox/Tinderbox2</title>
</chapter>
<para>Tinderbox is a continuous-build system which can integrate with
Bugzilla - see
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
of Tinderbox, and
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
in action.</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-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
docs/en/xml/using.xml
View file @ e5b9f4fa
This source diff could not be displayed because it is too large. You can view the blob instead.
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