From d38e12687c9eee4b32b7f42127cca3cf9f476e28 Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Sat, 15 Sep 2012 10:58:56 -0700 Subject: [PATCH] LockManger documentation cleanups. Change-Id: I472306586bd28a4e863afabc0e48d707850761a4 --- .../filebackend/lockmanager/DBLockManager.php | 32 +++++++++---------- .../filebackend/lockmanager/FSLockManager.php | 2 +- .../lockmanager/MemcLockManager.php | 12 +++---- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/includes/filebackend/lockmanager/DBLockManager.php b/includes/filebackend/lockmanager/DBLockManager.php index 204ca3b895..a8fe258b27 100644 --- a/includes/filebackend/lockmanager/DBLockManager.php +++ b/includes/filebackend/lockmanager/DBLockManager.php @@ -54,22 +54,22 @@ class DBLockManager extends QuorumLockManager { * Construct a new instance from configuration. * * $config paramaters include: - * 'dbServers' : Associative array of DB names to server configuration. - * Configuration is an associative array that includes: - * 'host' - DB server name - * 'dbname' - DB name - * 'type' - DB type (mysql,postgres,...) - * 'user' - DB user - * 'password' - DB user password - * 'tablePrefix' - DB table prefix - * 'flags' - DB flags (see DatabaseBase) - * 'dbsByBucket' : Array of 1-16 consecutive integer keys, starting from 0, - * each having an odd-numbered list of DB names (peers) as values. - * Any DB named 'localDBMaster' will automatically use the DB master - * settings for this wiki (without the need for a dbServers entry). - * 'lockExpiry' : Lock timeout (seconds) for dropped connections. [optional] - * This tells the DB server how long to wait before assuming - * connection failure and releasing all the locks for a session. + * - dbServers : Associative array of DB names to server configuration. + * Configuration is an associative array that includes: + * - host : DB server name + * - dbname : DB name + * - type : DB type (mysql,postgres,...) + * - user : DB user + * - password : DB user password + * - tablePrefix : DB table prefix + * - flags : DB flags (see DatabaseBase) + * - dbsByBucket : Array of 1-16 consecutive integer keys, starting from 0, + * each having an odd-numbered list of DB names (peers) as values. + * Any DB named 'localDBMaster' will automatically use the DB master + * settings for this wiki (without the need for a dbServers entry). + * - lockExpiry : Lock timeout (seconds) for dropped connections. [optional] + * This tells the DB server how long to wait before assuming + * connection failure and releasing all the locks for a session. * * @param Array $config */ diff --git a/includes/filebackend/lockmanager/FSLockManager.php b/includes/filebackend/lockmanager/FSLockManager.php index 53f3e9f974..9a6206fd5d 100644 --- a/includes/filebackend/lockmanager/FSLockManager.php +++ b/includes/filebackend/lockmanager/FSLockManager.php @@ -50,7 +50,7 @@ class FSLockManager extends LockManager { * Construct a new instance from configuration. * * $config includes: - * 'lockDirectory' : Directory containing the lock files + * - lockDirectory : Directory containing the lock files * * @param array $config */ diff --git a/includes/filebackend/lockmanager/MemcLockManager.php b/includes/filebackend/lockmanager/MemcLockManager.php index 9e81dbfdb9..57c0463d4c 100644 --- a/includes/filebackend/lockmanager/MemcLockManager.php +++ b/includes/filebackend/lockmanager/MemcLockManager.php @@ -56,12 +56,12 @@ class MemcLockManager extends QuorumLockManager { * Construct a new instance from configuration. * * $config paramaters include: - * - 'lockServers' : Associative array of server names to ":" strings. - * - 'srvsByBucket' : Array of 1-16 consecutive integer keys, starting from 0, - * each having an odd-numbered list of server names (peers) as values. - * - 'memcConfig' : Configuration array for ObjectCache::newFromParams. [optional] - * If set, this must use one of the memcached classes. - * - 'wikiId' : Wiki ID string that all resources are relative to. [optional] + * - lockServers : Associative array of server names to ":" strings. + * - srvsByBucket : Array of 1-16 consecutive integer keys, starting from 0, + * each having an odd-numbered list of server names (peers) as values. + * - memcConfig : Configuration array for ObjectCache::newFromParams. [optional] + * If set, this must use one of the memcached classes. + * - wikiId : Wiki ID string that all resources are relative to. [optional] * * @param Array $config */ -- 2.20.1