Bug 252272: Allow extremely large attachments to be stored locally (docs)

Patch by A. Karl Kornel <karl@kornel.name>, r=joel,colin

diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml
index 51039b3d85250feefd1d77f61f2f35216007bd5a..a90796d175bb07dfcc3fe450f4813ec9a2b10d48 100644 (file)
--- a/docs/xml/installation.xml
+++ b/docs/xml/installation.xml
@@ -1,5 +1,5 @@
 <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
-<!-- $Id: installation.xml,v 1.98.2.1 2005/07/09 22:38:26 mozilla%colinogilvie.co.uk Exp $ -->
+<!-- $Id: installation.xml,v 1.98.2.2 2005/07/12 10:55:55 mozilla%colinogilvie.co.uk Exp $ -->
 <chapter id="installing-bugzilla">
   <title>Installing Bugzilla</title>
 
@@ -651,6 +651,14 @@
           'max_allowed_packet' or 'maxattachmentsize' value will not be
           accepted by Bugzilla.
         </para>
+
+        <note>
+          <para>
+            This does not affect Big Files, attachments that are stored directly
+            on disk instead of in the database.  Their maximum size is
+            controlled using the 'maxlocalattachment' parameter.
+          </para>
+        </note>
       </section>
 
 
@@ -707,6 +715,13 @@
           to make a temporary copy of your entire table to do this. Ideally, 
           you should do this when your attachments table is still small.
         </para>
+
+        <note>
+          <para>
+            This does not affect Big Files, attachments that are stored directly
+            on disk instead of in the database.
+          </para>
+        </note>
       </section>
             
       <section id="install-setupdatabase-adduser">

diff --git a/docs/xml/using.xml b/docs/xml/using.xml
index d6c14dbd1847f398f143f741b90f32aba35a5152..720f461e9dc90ccc0bc8b0061c9e053b04b0aa6a 100644 (file)
--- a/docs/xml/using.xml
+++ b/docs/xml/using.xml
@@ -234,8 +234,12 @@
       <listitem>
         <para>
         <emphasis>Attachments:</emphasis>
-        You can attach files (e.g. testcases or patches) to bugs. If there
-        are any attachments, they are listed in this section.</para>
+          You can attach files (e.g. testcases or patches) to bugs. If there
+          are any attachments, they are listed in this section.  Attachments are
+          normally stored in the Bugzilla database, unless they are marked as
+          Big Files, which are stored directly on disk and (unlike attachments
+          kept in the database) may be deleted at some future time.
+        </para>
       </listitem>
 
       <listitem>
@@ -774,7 +778,17 @@
       Content-Type (e.g. application/xhtml+xml), you can override this 
       using a 'content-type' parameter on the URL, e.g.
       <filename>&amp;content-type=text/plain</filename>.
-      </para>     
+      </para> 
+
+      <para>
+        If you have a really large attachment, something that does not need to
+        be recorded forever (as most attachments are), you can mark your
+        attachment as a Big File, Assuming the administrator of the
+        installation has enabled this feature.  Big Files are stored directly on
+        disk instead of in the database, and can be deleted when it is no longer
+        needed.  The maximum size of a Big File is normally larger than the
+        maximum size of a regular attachment.
+      </para>
     </section>
   </section>