summaryrefslogtreecommitdiffstats
path: root/docs/en/xml/installation.xml
diff options
context:
space:
mode:
authorjake%bugzilla.org <>2008-04-04 13:47:26 +0200
committerjake%bugzilla.org <>2008-04-04 13:47:26 +0200
commit9165688e3f377aad3a95578ec687549a5d941759 (patch)
tree306ce5ae6bcef93afc124c6bafc7fa0bfe93cde8 /docs/en/xml/installation.xml
parent187ffee241770db5ee4f2a0baf2f51ab10ca6e64 (diff)
downloadbugzilla-9165688e3f377aad3a95578ec687549a5d941759.tar.gz
bugzilla-9165688e3f377aad3a95578ec687549a5d941759.tar.xz
Bug 274404 - Document the new whining functionality that will be available in 2.20.
Patch by A. Karl Kornel <karl@kornel.name> r=colin,joel
Diffstat (limited to 'docs/en/xml/installation.xml')
-rw-r--r--docs/en/xml/installation.xml43
1 files changed, 41 insertions, 2 deletions
diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml
index ac00bb41a..df1ac9c59 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.95 2008/04/04 06:47:25 zach%zachlipton.com Exp $ -->
+<!-- $Id: installation.xml,v 1.96 2008/04/04 06:47:26 jake%bugzilla.org Exp $ -->
<chapter id="installing-bugzilla">
<title>Installing Bugzilla</title>
@@ -1176,7 +1176,7 @@ c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s
</para>
</section>
- <section>
+ <section id="installation-whining-cron">
<title>The Whining Cron</title>
<para>What good are
@@ -1202,6 +1202,45 @@ c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s
</note>
</section>
+ <section id="installation-whining">
+ <title>Whining</title>
+
+ <para>
+ As of Bugzilla 2.20, users can configure Bugzilla to regularly annoy
+ them at regular intervals, by having Bugzilla execute saved searches
+ at certain times and emailing the results to the user. This is known
+ as "Whining". The process of configuring Whining is described
+ in <xref linkend="whining"/>, but for it to work a Perl script must be
+ executed at regular intervals.
+ </para>
+
+ <para>
+ This can be done by adding the following command as a daily
+ crontab entry, in the same manner as explained above for bug
+ graphs. This example runs it every 15 minutes.
+ </para>
+
+ <programlisting>*/15 * * * * cd &lt;your-bugzilla-directory&gt; ; ./whine.pl</programlisting>
+
+ <note>
+ <para>
+ Whines can be executed as often as every 15 minutes, so if you specify
+ longer intervals between executions of whine.pl, some users may not
+ be whined at as often as they would expect. Depending on the person,
+ this can either be a very Good Thing or a very Bad Thing.
+ </para>
+ </note>
+
+ <note>
+ <para>
+ Windows does not have 'cron', but it does have the Task
+ Scheduler, which performs the same duties. There are also
+ third-party tools that can be used to implement cron, such as
+ <ulink url="http://www.nncron.ru/">nncron</ulink>.
+ </para>
+ </note>
+ </section>
+
<section id="patch-viewer">
<title>Patch Viewer</title>