Recompile the docs to pick up recent changes for the website.

1 files changed, 159 insertions, 34 deletions

diff --git a/docs/txt/Bugzilla-Guide.txt b/docs/txt/Bugzilla-Guide.txt
index 166ee98a8..90a993e1f 100644
--- a/docs/txt/Bugzilla-Guide.txt
+++ b/docs/txt/Bugzilla-Guide.txt
@@ -5,6 +5,8 @@ Matthew P. Barnson
 
 The Bugzilla Team
 
+   2003-01-02
+
    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,
@@ -13,6 +15,10 @@ The Bugzilla Team
    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 mozilla.org's Bugzilla.
+
+   This is a development version of this guide. Information in it is
+   subject to change before the 2.18 release of this guide (which will
+   correspond with the 2.18 release of Bugzilla).
      _________________________________________________________________
 
    Table of Contents
@@ -83,6 +89,10 @@ The Bugzilla Team
    4-2. Installing OpenInteract ppd Modules manually on Microsoft Windows
    4-3. Removing encrypt() for Windows NT Bugzilla version 2.12 or
           earlier
+
+   5-1. Upgrading using CVS
+   5-2. Upgrading using the tarball
+   5-3. Upgrading using patches
      _________________________________________________________________
 
 Chapter 1. About This Guide
@@ -506,15 +516,20 @@ How to use this License for your documents
 
 1.3. New Versions
 
-   This is the 2.16 version of The Bugzilla Guide. It is so named to
-   match the current version of Bugzilla. If you are reading this from
-   any source other than those below, please check one of these mirrors
-   to make sure you are reading an up-to-date version of the Guide.
+   This is the 2.17.3 version of The Bugzilla Guide. It is so named to
+   match the current version of Bugzilla. This version of the guide, like
+   its associated Bugzilla version is a development version. Information
+   is subject to change between now and when 2.18 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.
 
-   This document can be found in the following places:
+   The newest version of this guide can always be found at bugzilla.org;
+   including documentation for past releases and the current development
+   version.
 
-     * bugzilla.org
-     * The Linux Documentation Project
+   The documentation for the most recent stable release of Bugzilla can
+   also be found at The Linux Documentation Project.
 
    The latest version of this document can always be checked out via CVS.
    Please follow the instructions available at the Mozilla CVS page, and
@@ -1015,7 +1030,7 @@ Chapter 4. Installation
    The software packages necessary for the proper running of Bugzilla
    (with download links) are:
 
-    1. MySQL database server (3.23.6 or greater)
+    1. MySQL database server (3.23.41 or greater)
     2. Perl (5.6, 5.6.1 is recommended if you wish to use
        Bundle::Bugzilla)
     3. Perl Modules (minimum version):
@@ -1031,7 +1046,7 @@ Chapter 4. Installation
          j. CGI (2.88)
        and, optionally:
          a. GD (1.20) for bug charting
-         b. GD::Chart (any) for bug charting
+         b. GD::Graph (any) for bug charting
          c. GD::Text::Align (any) for bug charting
          d. Chart::Base (0.99c) for bug charting
          e. XML::Parser (any) for the XML interface
@@ -2978,32 +2993,142 @@ deny from all
 
 5.9. Upgrading to New Releases
 
-   A plain Bugzilla is fairly easy to upgrade from one version to a newer
-   one. Always read the release notes to see if there are any issues that
-   you might need to take note of. It is recommended that you take a
-   backup of your database and your entire Bugzilla installation before
-   attempting an upgrade. You can upgrade a 'clean' installation by
-   untarring a new tarball over the old installation. If you are
-   upgrading from 2.12 or later, and have cvs installed, you can type cvs
-   -z3 update, and resolve conflicts if there are any.
-
-   However, things get a bit more complicated if you've made changes to
-   Bugzilla's code. In this case, you may have to re-make or reapply
-   those changes. One good method is to take a diff of your customized
-   version against the original, so you can survey all that you've
-   changed. Hopefully, templatization will reduce the need for this in
-   the future.
-
-   From version 2.8 onward, Bugzilla databases can be automatically
-   carried forward during an upgrade. However, because the developers of
-   Bugzilla are constantly adding new tables, columns and fields, you'll
-   probably get SQL errors if you just update the code and attempt to use
-   Bugzilla. Always run the checksetup.pl script whenever you upgrade
-   your installation.
+   Upgrading Bugzilla is something we all want to do from time to time,
+   be it to get new features or pick up the latest security fix. How easy
+   it is to update depends on a few factors.
+
+     * If the new version is a revision or a new point release
+     * How many, if any, local changes have been made
+
+   There are also three different methods to upgrade your installation.
+
+    1. Using CVS (Example 5-1)
+    2. Downloading a new tarball (Example 5-2)
+    3. Applying the relevant patches (Example 5-3)
+
+   Which options are available to you may depend on how large a jump you
+   are making and/or your network configuration.
+
+   Revisions are normally released to fix security vulnerabilities and
+   are distinguished by an increase in the third number. For example,
+   when 2.16.2 was released, it was a revision to 2.16.1.
+
+   Point releases are normally released when the Bugzilla team feels that
+   there has been a significant amount of progress made between the last
+   point release and the current time. These are often proceeded by a
+   stabilization period and release candidates, however the use of
+   development versions or release candidates is beyond the scope of this
+   document. Point releases can be distinguished by an increase in the
+   second number, or minor version. For example, 2.16.2 is a newer point
+   release than 2.14.5.
+
+   The examples in this section are written as if you were updating to
+   version 2.16.2. The procedures are the same regardless if you are
+   updating to a new point release or a new revision. However, the chance
+   of running into trouble increases when upgrading to a new point
+   release, escpecially if you've made local changes.
+
+   These examples also assume that your Bugzilla installation is at
+   /var/www/html/bugzilla. If that is not the case, simply substitute the
+   proper paths where appropriate.
+
+   Example 5-1. Upgrading using CVS
+
+   Every release of Bugzilla, whether it is a revision or a point
+   release, is tagged in CVS. Also, every tarball we have distributed
+   since version 2.12 has been primed for using CVS. This does, however,
+   require that you are able to access cvs-mirror.mozilla.org on port
+   2401.
+
+   Tip
+
+   If you can do this, updating using CVS is probably the most painless
+   method, especially if you have a lot of local changes.
+bash$ cd /var/www/html/bugzilla
+bash$ cvs login
+Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot
+CVS password: anonymous
+bash$ cvs -q update -r BUGZILLA-2_16_2 -dP
+P checksetup.pl
+P collectstats.pl
+P globals.pl
+P docs/rel_notes.txt
+P template/en/default/list/quips.html.tmpl
+
+   Caution
+
+   If a line in the output from cvs update begins with a C that
+   represents a file with local changes that CVS was unable to properly
+   merge. You need to resolve these conflicts manually before Bugzilla
+   (or at least the portion using that file) will be usable.
+
+   Note
+
+   You also need to run ./checksetup.pl before your Bugzilla upgrade will
+   be complete.
+
+   Example 5-2. Upgrading using the tarball
+
+   If you are unable or unwilling to use CVS, another option that's
+   always available is to download the latest tarball. This is the most
+   difficult option to use, especially if you have local changes.
+bash$ cd /var/www/html
+bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.2.tar.gz
+Output omitted
+bash$ tar xzvf bugzilla-2.16.2.tar.gz
+bugzilla-2.16.2/
+bugzilla-2.16.2/.cvsignore
+bugzilla-2.16.2/1x1.gif
+Output truncated
+bash$ cd bugzilla-2.16.2
+bash$ cp ../bugzilla/localconfig* .
+bash$ cp -r ../bugzilla/data .
+bash$ cd ..
+bash$ mv bugzilla bugzilla.old
+bash$ mv bugzilla-2.16.2 bugzilla
+bash$ cd bugzilla
+bash$ ./checksetup.pl
+Output omitted
+
+   Warning
+
+   The cp commands both end with periods which is a very important
+   detail, it tells the shell that the destination directory is the
+   current working directory. Also, the period at the beginning of the
+   ./checksetup.pl is important and can not be omitted.
+
+   Note
+
+   You will now have to reapply any changes you have made to your local
+   installation manually.
+
+   Example 5-3. Upgrading using patches
+
+   The Bugzilla team will normally make a patch file available for
+   revisions to go from the most recent revision to the new one. You
+   could also read the release notes and grab the patches attached to the
+   mentioned bug, but it is safer to use the released patch file as
+   sometimes patches get changed before they get checked in (for minor
+   spelling fixes and the like). It is also theorectically possible to
+   scour the fixed bug list and pick and choose which patches to apply
+   from a point release, but this is not recommended either as what
+   you'll end up with is a hodge podge Bugzilla that isn't really any
+   version. This would also make it more difficult to upgrade in the
+   future.
+bash$ cd /var/www/html/bugzilla
+bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.1-to-2.16.2.diff.gz
+Output omitted
+bash$ gunzip bugzilla-2.16.1-to-2.16.2.diff.gz
+bash$ patch -p1 < bugzilla-2.16.1-to-2.16.2.diff
+patching file checksetup.pl
+patching file collectstats.pl
+patching file globals.pl
+
+   Caution
 
-   If you are running Bugzilla version 2.8 or lower, and wish to upgrade
-   to the latest version, please consult the file, "UPGRADING-pre-2.8" in
-   the Bugzilla root directory after untarring the archive.
+   If you do this, beware that this doesn't change the entires in your
+   CVS directory so it may make updates using CVS (Example 5-1) more
+   difficult in the future.
      _________________________________________________________________
 
 5.10. Integrating Bugzilla with Third-Party Tools