From: Aaron Schulz <aschulz@wikimedia.org>
Date: Wed, 18 Oct 2017 21:25:23 +0000 (-0700)
Subject: objectcache: Mention colons in BagOStuff key generation
X-Git-Tag: 1.31.0-rc.0~1710^2
X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=317d8476da5494b336b1b3ce694ef2f4e96ebd21

objectcache: Mention colons in BagOStuff key generation

Change-Id: I76967245c32aac4eea8d6672e4fc1fac5e5f3d07
---

diff --git a/includes/libs/objectcache/BagOStuff.php b/includes/libs/objectcache/BagOStuff.php
index 8a23db515b..d6cb340551 100644
--- a/includes/libs/objectcache/BagOStuff.php
+++ b/includes/libs/objectcache/BagOStuff.php
@@ -732,7 +732,7 @@ abstract class BagOStuff implements IExpiringStore, LoggerAwareInterface {
 	 * @since 1.27
 	 * @param string $keyspace
 	 * @param array $args
-	 * @return string
+	 * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 	 */
 	public function makeKeyInternal( $keyspace, $args ) {
 		$key = $keyspace;
@@ -747,8 +747,8 @@ abstract class BagOStuff implements IExpiringStore, LoggerAwareInterface {
 	 * Make a global cache key.
 	 *
 	 * @since 1.27
-	 * @param string $keys,... Key component
-	 * @return string
+	 * @param string $keys,... Key component (starting with a key collection name)
+	 * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 	 */
 	public function makeGlobalKey() {
 		return $this->makeKeyInternal( 'global', func_get_args() );
@@ -758,8 +758,8 @@ abstract class BagOStuff implements IExpiringStore, LoggerAwareInterface {
 	 * Make a cache key, scoped to this instance's keyspace.
 	 *
 	 * @since 1.27
-	 * @param string $keys,... Key component
-	 * @return string
+	 * @param string $keys,... Key component (starting with a key collection name)
+	 * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 	 */
 	public function makeKey() {
 		return $this->makeKeyInternal( $this->keyspace, func_get_args() );
diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php
index cab5782f37..8ad2b93d6d 100644
--- a/includes/libs/objectcache/WANObjectCache.php
+++ b/includes/libs/objectcache/WANObjectCache.php
@@ -1315,8 +1315,8 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 
 	/**
 	 * @see BagOStuff::makeKey()
-	 * @param string $keys,... Key component
-	 * @return string
+	 * @param string $keys,... Key component (starting with a key collection name)
+	 * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 	 * @since 1.27
 	 */
 	public function makeKey() {
@@ -1325,8 +1325,8 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 
 	/**
 	 * @see BagOStuff::makeGlobalKey()
-	 * @param string $keys,... Key component
-	 * @return string
+	 * @param string $keys,... Key component (starting with a key collection name)
+	 * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 	 * @since 1.27
 	 */
 	public function makeGlobalKey() {