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 8a23db5..d6cb340 100644 (file)
--- 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 cab5782..8ad2b93 100644 (file)
--- 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() {