Recompile the docs

d6fe6257 · jake%bugzilla.org · 028ccb87 · d6fe6257 · d6fe6257 · d6fe6257
Commit d6fe6257 authored Jul 08, 2003 by jake%bugzilla.org
16 changed files
--- a/docs/html/Bugzilla-Guide.html
+++ b/docs/html/Bugzilla-Guide.html
--- a/docs/html/administration.html
+++ b/docs/html/administration.html
@@ -180,22 +180,22 @@ HREF="cust-templates.html"
 ><DL
 ><DT
 >5.7.1. <A
-HREF="cust-templates.html#AEN1534"
+HREF="cust-templates.html#AEN1559"
 >What to Edit</A
 ></DT
 ><DT
 >5.7.2. <A
-HREF="cust-templates.html#AEN1553"
+HREF="cust-templates.html#AEN1578"
 >How To Edit Templates</A
 ></DT
 ><DT
 >5.7.3. <A
-HREF="cust-templates.html#AEN1563"
+HREF="cust-templates.html#AEN1588"
 >Template Formats</A
 ></DT
 ><DT
 >5.7.4. <A
-HREF="cust-templates.html#AEN1576"
+HREF="cust-templates.html#AEN1601"
 >Particular Templates</A
 ></DT
 ></DL

--- a/docs/html/cust-templates.html
+++ b/docs/html/cust-templates.html
@@ -99,7 +99,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN1534"
+NAME="AEN1559"
 ></A
 >5.7.1. What to Edit</H2
 ><P
@@ -214,7 +214,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN1553"
+NAME="AEN1578"
 ></A
 >5.7.2. How To Edit Templates</H2
 ><P
@@ -296,7 +296,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN1563"
+NAME="AEN1588"
 ></A
 >5.7.3. Template Formats</H2
 ><P
@@ -358,7 +358,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN1576"
+NAME="AEN1601"
 ></A
 >5.7.4. Particular Templates</H2
 ><P

--- a/docs/html/dbdoc.html
+++ b/docs/html/dbdoc.html
@@ -135,7 +135,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN2185"
+NAME="AEN2212"
 ></A
 >B.2.1. Bugzilla Database Basics</H2
 ><P
@@ -249,7 +249,7 @@ CLASS="section"
 ><H3
 CLASS="section"
 ><A
-NAME="AEN2212"
+NAME="AEN2239"
 ></A
 >B.2.1.1. Bugzilla Database Tables</H3
 ><P

--- a/docs/html/extraconfig.html
+++ b/docs/html/extraconfig.html
--- a/docs/html/faq.html
+++ b/docs/html/faq.html
@@ -1879,7 +1879,7 @@ CLASS="answer"
 	    You can call bug_email.pl directly from your aliases file, with
 	    an entry like this:
 	    <A
-NAME="AEN1980"
+NAME="AEN2007"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -2323,7 +2323,7 @@ CLASS="answer"
 ><P
 >&#13;	    Microsoft has some advice on this matter, as well:
 	    <A
-NAME="AEN2063"
+NAME="AEN2090"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"

--- a/docs/html/gfdl-howto.html
+++ b/docs/html/gfdl-howto.html
@@ -81,7 +81,7 @@ NAME="gfdl-howto"
    of the License in the document and put the following copyright and
    license notices just after the title page:</P
 ><A
-NAME="AEN2390"
+NAME="AEN2417"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"

--- a/docs/html/gfdl.html
+++ b/docs/html/gfdl.html
@@ -144,7 +144,7 @@ HREF="gfdl-howto.html"
 ><P
 >Version 1.1, March 2000</P
 ><A
-NAME="AEN2300"
+NAME="AEN2327"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"

--- a/docs/html/glossary.html
+++ b/docs/html/glossary.html
@@ -70,7 +70,7 @@ CLASS="glossdiv"
 ><H1
 CLASS="glossdiv"
 ><A
-NAME="AEN2395"
+NAME="AEN2422"
 ></A
 >0-9, high ascii</H1
 ><DL
@@ -375,6 +375,62 @@ CLASS="glossterm"
        modules - encapsulated chunks of code for performing a
        particular task.</P
 ></DD
+><DT
+><A
+NAME="gloss-contrib"
+></A
+><B
+><TT
+CLASS="filename"
+>contrib</TT
+></B
+></DT
+><DD
+><P
+>The <TT
+CLASS="filename"
+>contrib</TT
+> directory is
+        a location to put scripts that have been contributed to Bugzilla but
+        are not a part of the official distribution. These scripts are written
+        by third parties and may be in languages other than perl. For those
+        that are in perl, there may be additional modules or other requirements
+        than those of the offical distribution.
+        <DIV
+CLASS="note"
+><P
+></P
+><TABLE
+CLASS="note"
+WIDTH="100%"
+BORDER="0"
+><TR
+><TD
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/note.gif"
+HSPACE="5"
+ALT="Note"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>Scripts in the <TT
+CLASS="filename"
+>contrib</TT
+>
+          directory are not offically supported by the Bugzilla team and may
+          break in between versions.
+          </P
+></TD
+></TR
+></TABLE
+></DIV
+>
+        </P
+></DD
 ></DL
 ></DIV
 ><DIV
@@ -878,7 +934,7 @@ NAME="gloss-zarro"
        Terry had the following to say:
        </P
 ><A
-NAME="AEN2621"
+NAME="AEN2657"
 ></A
 ><TABLE
 BORDER="0"

--- a/docs/html/installation.html
+++ b/docs/html/installation.html
@@ -258,12 +258,12 @@ HREF="troubleshooting.html"
 ><DL
 ><DT
 >4.5.1. <A
-HREF="troubleshooting.html#AEN1086"
+HREF="troubleshooting.html#AEN1111"
 >Bundle::Bugzilla makes me upgrade to Perl 5.6.1</A
 ></DT
 ><DT
 >4.5.2. <A
-HREF="troubleshooting.html#AEN1091"
+HREF="troubleshooting.html#AEN1116"
 >DBD::Sponge::db prepare failed</A
 ></DT
 ><DT

--- a/docs/html/os-specific.html
+++ b/docs/html/os-specific.html
@@ -414,7 +414,7 @@ COLOR="#000000"
 ><PRE
 CLASS="programlisting"
 >&#13;use Net::SMTP;
-$smtp_server = 'smtp.mycompany.com';  # change this
+my $smtp_server = 'smtp.mycompany.com';  # change this

 # Use die on error, so that the mail will be in the 'unsent mails' and
 # can be sent from the sanity check page.
@@ -526,110 +526,172 @@ TARGET="_top"
 >.</P
 ><P
 >Follow the instructions for setting up Fink. Once it's installed,
-      you'll want to run the following as root: 
-      <B
-CLASS="command"
->fink install gd</B
->
+      you'll want to use it to install the gd2 package.
      </P
 ><P
 >It will prompt you for a number of dependencies, type 'y' and hit
-      enter to install all of the dependencies. Then watch it work.</P
-><P
->To prevent creating conflicts with the software that Apple installs
-      by default, Fink creates its own directory tree at /sw where it installs
-      most of the software that it installs. This means your libraries and
-      headers for libgd will be at /sw/lib and /sw/include instead of /usr/lib
-      and /usr/local/include. Because of these changed locations for the
-      libraries, the Perl GD module will not install directly via CPAN, because it
-      looks for the specific paths instead of getting them from your
-      environment. But there's a way around that :-)</P
-><P
->Instead of typing 
-      <SPAN
-CLASS="QUOTE"
->"install GD"</SPAN
->
-      at the 
-      <TT
-CLASS="prompt"
->cpan&#62;</TT
->
-      prompt, type 
-      <B
-CLASS="command"
->look GD</B
->. 
-      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
-      directory. Apply <A
-HREF="../xml/gd-makefile.patch"
-TARGET="_top"
->this patch</A
-> 
-      to the Makefile.PL file (save the
-      patch into a file and use the command 
-      <B
-CLASS="command"
->patch &#60; patchfile</B
->.)
+      enter to install all of the dependencies and then watch it work. You will
+      then be able to use <A
+HREF="glossary.html#gloss-cpan"
+><I
+CLASS="glossterm"
+>CPAN</I
+></A
+> to
+      install the GD perl module.
      </P
+><DIV
+CLASS="note"
 ><P
->Then, run these commands to finish the installation of the GD
-      module: 
-      <P
 ></P
 ><TABLE
+CLASS="note"
+WIDTH="100%"
 BORDER="0"
-><TBODY
 ><TR
 ><TD
->&#13;          <B
-CLASS="command"
->perl Makefile.PL</B
->
-        </TD
-></TR
-><TR
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/note.gif"
+HSPACE="5"
+ALT="Note"></TD
 ><TD
->&#13;          <B
-CLASS="command"
->make</B
->
-        </TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>To prevent creating conflicts with the software that Apple
+        installs by default, Fink creates its own directory tree at 
+        <TT
+CLASS="filename"
+>/sw</TT
+> where it installs most of
+        the software that it installs. This means your libraries and headers be
+        at <TT
+CLASS="filename"
+>/sw/lib</TT
+> and
+        <TT
+CLASS="filename"
+>/sw/include</TT
+> instead of
+        <TT
+CLASS="filename"
+>/usr/lib</TT
+> and
+        <TT
+CLASS="filename"
+>/usr/local/include</TT
+>. When the
+        Perl module config script asks where your libgd is, be sure to tell it
+        <TT
+CLASS="filename"
+>/sw/lib</TT
+>.
+        </P
+></TD
 ></TR
+></TABLE
+></DIV
+><P
+>Also available via Fink is expat. Once running using fink to
+      install the expat package you will be able to install
+      XML::Parser using CPAN. There is one caveat. Unlike recent versions of
+      the GD module, XML::Parser doesn't prompt for the location of the
+      required libraries. When using CPAN, you will need to use the following
+      command sequence:
+      </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
 ><TR
 ><TD
->&#13;          <B
-CLASS="command"
->make test</B
+><FONT
+COLOR="#000000"
+><PRE
+CLASS="screen"
+>&#13;# perl -MCPAN -e'look XML::Parser'        <A
+NAME="macosx-look"
+><IMG
+SRC="../images/callouts/1.gif"
+HSPACE="0"
+VSPACE="0"
+BORDER="0"
+ALT="(1)"></A
 >
-        </TD
-></TR
-><TR
-><TD
->&#13;          <B
-CLASS="command"
->make install</B
+# perl Makefile.PL EXPATLIBPATH=/sw/lib EXPATINCPATH=/sw/include
+# make; make test; make install           <A
+NAME="macosx-make"
+><IMG
+SRC="../images/callouts/2.gif"
+HSPACE="0"
+VSPACE="0"
+BORDER="0"
+ALT="(2)"></A
 >
-        </TD
-></TR
-><TR
-><TD
->And don't forget to run 
-        <B
-CLASS="command"
->exit</B
+# exit                                    <A
+NAME="macosx-exit"
+><IMG
+SRC="../images/callouts/3.gif"
+HSPACE="0"
+VSPACE="0"
+BORDER="0"
+ALT="(3)"></A
 >
-
-        to get back to CPAN.</TD
+      </PRE
+></FONT
+></TD
 ></TR
-></TBODY
 ></TABLE
-><P
-></P
->
-      </P
+><DIV
+CLASS="calloutlist"
+><DL
+COMPACT="COMPACT"
+><DT
+><A
+HREF="os-specific.html#macosx-look"
+><IMG
+SRC="../images/callouts/1.gif"
+HSPACE="0"
+VSPACE="0"
+BORDER="0"
+ALT="(1)"></A
+><A
+HREF="os-specific.html#macosx-exit"
+><IMG
+SRC="../images/callouts/3.gif"
+HSPACE="0"
+VSPACE="0"
+BORDER="0"
+ALT="(3)"></A
+></DT
+><DD
+>The look command will download the module and spawn a
+          new shell with the extracted files as the current working directory.
+          The exit command will return you to your original shell.
+          </DD
+><DT
+><A
+HREF="os-specific.html#macosx-make"
+><IMG
+SRC="../images/callouts/2.gif"
+HSPACE="0"
+VSPACE="0"
+BORDER="0"
+ALT="(2)"></A
+></DT
+><DD
+>You should watch the output from these make commands,
+          especially <SPAN
+CLASS="QUOTE"
+>"make test"</SPAN
+> as errors may prevent XML::Parser
+          from functioning correctly with Bugzilla.
+          </DD
+></DL
+></DIV
 ></DIV
 ><DIV
 CLASS="section"

--- a/docs/html/stepbystep.html
+++ b/docs/html/stepbystep.html
--- a/docs/html/troubleshooting.html
+++ b/docs/html/troubleshooting.html
@@ -85,7 +85,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN1086"
+NAME="AEN1111"
 ></A
 >4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2
 ><P
@@ -110,7 +110,7 @@ CLASS="section"
 ><H2
 CLASS="section"
 ><A
-NAME="AEN1091"
+NAME="AEN1116"
 ></A
 >4.5.2. DBD::Sponge::db prepare failed</H2
 ><P

--- a/docs/html/upgrading.html
+++ b/docs/html/upgrading.html
@@ -76,6 +76,36 @@ CLASS="section"
 NAME="upgrading"
 ></A
 >5.9. Upgrading to New Releases</H1
+><DIV
+CLASS="warning"
+><P
+></P
+><TABLE
+CLASS="warning"
+WIDTH="100%"
+BORDER="0"
+><TR
+><TD
+WIDTH="25"
+ALIGN="CENTER"
+VALIGN="TOP"
+><IMG
+SRC="../images/warning.gif"
+HSPACE="5"
+ALT="Warning"></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><P
+>Upgrading is a one-way process. You should backup your database
+      and current Bugzilla directory before attempting the upgrade. If you wish
+      to revert to the old Bugzilla version for any reason, you will have to
+      restore from these backups.
+      </P
+></TD
+></TR
+></TABLE
+></DIV
 ><P
 >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

--- a/docs/pdf/Bugzilla-Guide.pdf
+++ b/docs/pdf/Bugzilla-Guide.pdf
--- a/docs/txt/Bugzilla-Guide.txt
+++ b/docs/txt/Bugzilla-Guide.txt