From: Gervase Markham <gerv@gerv.net>
Date: Fri, 31 Oct 2014 10:47:04 +0000 (+0000)
Subject: Make docs for dependency graphing more clear.
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ba9ca333c87c1331eaac7d3a615622b00cbe3ff6;p=thirdparty%2Fbugzilla.git

Make docs for dependency graphing more clear.
---

diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst
index 9b4704f3f9..0ca3852982 100644
--- a/docs/en/rst/administering/parameters.rst
+++ b/docs/en/rst/administering/parameters.rst
@@ -354,24 +354,36 @@ collapsed_comment_tags
 Graphs
 ======
 
-This page has a parameter that sets the location of a Web Dot
-server, or of the Web Dot binary on the local system, that is used
-to generate dependency graphs. Web Dot is a CGI program that creates
-images from :file:`.dot` graphic description files. If
-no Web Dot server or binary is specified, then dependency graphs will
-be disabled.
+Bugzilla can draw graphs of bug dependency relationships, using a tool called
+:file:`dot` (from the `GraphViz project <http://graphviz.org/>`_) or a web
+service called Web Dot. This page allows you to set the location of the binary
+or service. If no Web Dot server or binary is specified, then dependency
+graphs will be disabled.
 
 webdotbase
-    It is possible to show graphs of dependent bugs. You may set this parameter to any of the following:
+    You may set this parameter to any of the following:
 
-    * A complete file path to :command:`dot` (part of GraphViz) will generate the graphs locally.
-    * A URL prefix pointing to an installation of the webdot package will generate the graphs remotely.
-    * A blank value will disable dependency graphing.
+    * A complete file path to :command:`dot` (part of GraphViz), which will
+      generate the graphs locally.
+    * A URL prefix pointing to an installation of the webdot package, which
+      will generate the graphs remotely.
+    * A blank value, which will disable dependency graphing.
 
-    The default value is a publicly-accessible webdot server. If you change this value, make certain that the webdot server can read files from your webdot directory. On Apache you do this by editing the :file:`.htaccess` file, for other systems the needed measures may vary. You can run :command:`checksetup.pl` to recreate the :file:`.htaccess` file if it has been lost.
+    The default value is blank. We recommend using a local install of
+    :file:`dot`. If you change this value to a web service, make certain that
+    the webdot server can read files from your webdot directory. On Apache
+    you do this by editing the :file:`.htaccess` file; for other systems the
+    needed measures may vary. You can run :command:`checksetup.pl` to
+    recreate the :file:`.htaccess` file if it has been lost.
 
 font_file
-    You can specify the full path to a TrueType font file which will be used to display text (labels, legends, ...) in charts and graphical reports. To support as many languages as possible, we recommend to specify a TrueType font such as Unifont which supports all printable characters in the Basic Multilingual Plane. If you leave this parameter empty, a default font will be used, but its support is limited to English characters only and so other characters will be displayed incorrectly. 
+    You can specify the full path to a TrueType font file which will be used
+    to display text (labels, legends, ...) in charts and graphical reports.
+    To support as many languages as possible, we recommend to specify a
+    TrueType font such as Unifont which supports all printable characters in
+    the Basic Multilingual Plane. If you leave this parameter empty, a default
+    font will be used, but its support is limited to English characters only
+    and so other characters will be displayed incorrectly. 
 
 .. _param-group-security: