From: Aaron Schulz <aschulz@wikimedia.org>
Date: Fri, 15 Aug 2014 22:19:46 +0000 (-0700)
Subject: Added more JobRunner docs
X-Git-Tag: 1.31.0-rc.0~14384^2
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/operations/Bolded_link?a=commitdiff_plain;h=5fc32ab83090d6948d979c04e1e888d3d062bfc3;p=lhc%2Fweb%2Fwiklou.git

Added more JobRunner docs

Change-Id: I4fbb947a2fc2b5f325dff97127bf39edf18f0e13
---

diff --git a/includes/jobqueue/JobRunner.php b/includes/jobqueue/JobRunner.php
index 9a4073f9a0..c5e7f2ea17 100644
--- a/includes/jobqueue/JobRunner.php
+++ b/includes/jobqueue/JobRunner.php
@@ -54,7 +54,11 @@ class JobRunner {
 	 * This method outputs status information only if a debug handler was set.
 	 * Any exceptions are caught and logged, but are not reported as output.
 	 *
-	 * @param array $options
+	 * @param array $options Map of parameters:
+	 *    - type     : the job type (or false for the default types)
+	 *    - maxJobs  : maximum number of jobs to run
+	 *    - maxTime  : maximum time in seconds before stopping
+	 *    - throttle : whether to respect job backoff configuration
 	 * @return array Summary response that can easily be JSON serialized
 	 */
 	public function run( array $options ) {