From: Aaron Schulz <aschulz@wikimedia.org>
Date: Thu, 15 Oct 2015 15:09:48 +0000 (-0700)
Subject: Mention WANObjectCache::TTL_INDEFINITE in set() method
X-Git-Tag: 1.31.0-rc.0~9360^2
X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=d7021c077da8b69d5e4422d1a5c14d86978fd6b6

Mention WANObjectCache::TTL_INDEFINITE in set() method

Change-Id: I6e5cb2e7ba34ceaf4ca128e4b32da99d08917156
---

diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php
index 3b9c832be7..1a0e9bbd98 100644
--- a/includes/libs/objectcache/WANObjectCache.php
+++ b/includes/libs/objectcache/WANObjectCache.php
@@ -289,7 +289,8 @@ class WANObjectCache {
 	 *
 	 * @param string $key Cache key
 	 * @param mixed $value
-	 * @param integer $ttl Seconds to live [0=forever]
+	 * @param integer $ttl Seconds to live. Special values are:
+	 *   - WANObjectCache::TTL_INDEFINITE: Cache forever
 	 * @param array $opts Options map:
 	 *   - lag     : Seconds of slave lag. Typically, this is either the slave lag
 	 *               before the data was read or, if applicable, the slave lag before