objectcache: Improve entry point docs and fix typo in READ_LATEST
authorTimo Tijhof <krinklemail@gmail.com>
Mon, 7 Dec 2015 19:52:42 +0000 (19:52 +0000)
committerKrinkle <krinklemail@gmail.com>
Mon, 7 Dec 2015 19:54:16 +0000 (19:54 +0000)
Add missing colon in "BagOStuff::READ_LATEST".

Change-Id: I93f55299b49b5240e3ef6354d3a1fca2b416e40d

includes/objectcache/ObjectCache.php

index b4aecee..90a9f7c 100644 (file)
@@ -44,12 +44,13 @@ use MediaWiki\Logger\LoggerFactory;
  *
  * - ObjectCache::getMainWANInstance()
  *   Purpose: Memory cache.
- *   Stored in the local data-center's main cache (uses different cache keys).
- *   Delete events are broadcasted to other DCs. See WANObjectCache for details.
+ *   Stored in the local data-center's main cache (keyspace different from local-cluster cache).
+ *   Delete events are broadcasted to other DCs main cache. See WANObjectCache for details.
  *
  * - ObjectCache::getLocalServerInstance( $fallbackType )
  *   Purpose: Memory cache for very hot keys.
- *   Stored only on the individual web server (often EmptyBagOStuff in CLI mode).
+ *   Stored only on the individual web server (typically APC for web requests,
+ *   and EmptyBagOStuff in CLI mode).
  *   Not replicated to the other servers.
  *
  * - ObjectCache::getLocalClusterInstance()
@@ -62,7 +63,7 @@ use MediaWiki\Logger\LoggerFactory;
  *   Purpose: Ephemeral global storage.
  *   Stored centrally within the primary data-center.
  *   Changes are applied there first and replicated to other DCs (best-effort).
- *   To retrieve the latest value (e.g. not from a slave), use BagOStuff:READ_LATEST.
+ *   To retrieve the latest value (e.g. not from a slave), use BagOStuff::READ_LATEST.
  *   This store may be subject to LRU style evictions.
  *
  * - ObjectCache::getInstance( $cacheType )