From: jocuri%softhome.net <>
Date: Fri, 4 Apr 2008 11:46:45 +0000 (+0000)
Subject: Bug 216703: Need PatchReader note in install docs; patch by jkeiser (John Keiser... 
X-Git-Tag: bugzilla-3.1.3~196
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d4be3230f4a2429d5167e4f0b29b95c17268b0ae;p=thirdparty%2Fbugzilla.git

Bug 216703: Need PatchReader note in install docs; patch by jkeiser (John Keiser - john@johnkeiser.com); r=jake; a=jake.
---

diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml
index e50784f81f..83875eacde 100644
--- a/docs/en/xml/Bugzilla-Guide.xml
+++ b/docs/en/xml/Bugzilla-Guide.xml
@@ -63,6 +63,7 @@
 <!ENTITY min-chart-base-ver "0.99c">
 <!ENTITY min-xml-parser-ver "any">
 <!ENTITY min-mime-parser-ver "any">
+<!ENTITY min-patchreader-ver "0.9.1">
 
 ]>
 
diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml
index 68c672ae53..0d38b2ce40 100644
--- a/docs/en/xml/installation.xml
+++ b/docs/en/xml/installation.xml
@@ -1,5 +1,5 @@
 <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
-<!-- $Id: installation.xml,v 1.54 2008/04/04 06:46:44 jocuri%softhome.net Exp $ -->
+<!-- $Id: installation.xml,v 1.55 2008/04/04 06:46:45 jocuri%softhome.net Exp $ -->
 <chapter id="installation">
   <title>Installation</title>
 
@@ -327,6 +327,13 @@ set-variable = max_allowed_packet=1M
             (&min-mime-parser-ver;) for the email interface
           </para>
         </listitem>
+
+        <listitem>
+          <para>
+            <link linkend="install-modules-patchreader">PatchReader</link>
+            (&min-patchreader-ver;) for pretty HTML view of patches
+          </para>
+        </listitem>
       </orderedlist>          
       </para>
 
@@ -632,6 +639,25 @@ ReadLine support enabled
         Documentation: <ulink url="http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm"/>
       </literallayout>
     </section>
+
+    <section id="install-modules-patchreader">
+      <title>PatchReader (&min-patchreader-ver;) [Optional]</title>
+
+      <para>PatchReader is only needed if you want to use Patch Viewer, a
+      Bugzilla feature to format patches in a pretty HTML fashion.  There are a
+      number of optional parameters you can configure Patch Viewer with as well,
+      including cvsroot, cvsroot_get, lxr_root, bonsai_url, lxr_url, and
+      lxr_root.  Patch Viewer also optionally will use cvs, diff and interdiff
+      utilities if they exist on the system (interdiff can be found in the
+      patchutils package at <ulink url="http://cyberelk.net/tim/patchutils/"/>.
+      These programs' locations can be configured in localconfig.
+      </para>
+
+      <literallayout>
+        CPAN Download Page: <ulink url="http://search.cpan.org/author/JKEISER/PatchReader/"/>
+        Documentation: <ulink url="http://www.johnkeiser.com/mozilla/Patch_Viewer.html"/>
+      </literallayout>
+    </section>
   </section>
   
     <section id="install-webserver">