Documentation about sanitycheck.cgi (backported from bug 45207) - Patch by Sam Folk...

diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml
index 5bb85796683e7784c6746c59a540fba90dbbc058..a2f674bb734630f87c807084641f10eab8d20135 100644 (file)
--- a/docs/xml/administration.xml
+++ b/docs/xml/administration.xml
@@ -1636,6 +1636,39 @@ Support: ENTRY, DEFAULT/MANDATORY, CANEDIT
     </section>
   </section>
 
+  <section id="sanitycheck">
+    <title>Checking and Maintaining Database Integrity</title>
+
+    <para>
+    Over time it is possible for the Bugzilla database to become corrupt
+    or to have anomalies.
+    This could happen through normal usage of Bugzilla, manual database
+    administration outside of the Bugzilla user interface, or from some
+    other unexpected event. Bugzilla includes a "Sanity Check" script that
+    can perform several basic database checks, and repair certain problems or
+    inconsistencies. 
+    </para>
+    <para>
+    To run the "Sanity Check" script, log in as an Administrator and click the
+    "Sanity Check" link in the footer. Any problems that are found will be
+    displayed in red letters. If the script is capable of fixing a problem,
+    it will present a link to initiate the fix. If the script can not
+    fix the problem it will require manual database administration or recovery.
+    </para>
+    <para>
+    The "Sanity Check" script should be run on a regular basis as a matter of
+    best practice.
+    </para>
+    <warning>
+      <para>
+      The "Sanity Check" script is no substitute for a competent database
+      administrator. It is only designed to check and repair basic database
+      problems.
+      </para>
+    </warning>
+
+  </section>
+
   <section id="upgrading">
     <title>Upgrading to New Releases</title>