From: Aaron Schulz <aschulz@wikimedia.org>
Date: Wed, 6 Dec 2017 21:15:22 +0000 (-0800)
Subject: Change EnqueueJob docs to discourage obsolete use-cases
X-Git-Tag: 1.31.0-rc.0~1201^2
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=78204090ba6b2beaa5ec9f2ce04e43440522c45c;p=lhc%2Fweb%2Fwiklou.git

Change EnqueueJob docs to discourage obsolete use-cases

Bug: T181216
Change-Id: I9332d26ae9a74c3721cff9c497d5356f05efb428
---

diff --git a/includes/jobqueue/jobs/EnqueueJob.php b/includes/jobqueue/jobs/EnqueueJob.php
index 5ffb01b45a..ea7a8d7801 100644
--- a/includes/jobqueue/jobs/EnqueueJob.php
+++ b/includes/jobqueue/jobs/EnqueueJob.php
@@ -24,11 +24,10 @@
 /**
  * Router job that takes jobs and enqueues them to their proper queues
  *
- * This can be used for several things:
- *   - a) Making multi-job enqueues more robust by atomically enqueueing
- *        a single job that pushes the actual jobs (with retry logic)
- *   - b) Masking the latency of pushing jobs to different queues/wikis
- *   - c) Low-latency enqueues to push jobs from warm to hot datacenters
+ * This can be used for getting sets of multiple jobs or sets of jobs intended for multiple
+ * queues to be inserted more robustly. This is a single job that, upon running, enqueues the
+ * wrapped jobs. If some of those fail to enqueue then the EnqueueJob will be retried. Due to
+ * the possibility of duplicate enqueues, the wrapped jobs should be idempotent.
  *
  * @ingroup JobQueue
  * @since 1.25