From: Aaron Schulz Date: Wed, 19 Apr 2017 23:48:13 +0000 (-0700) Subject: Document which EtcdConfig parameters are optional X-Git-Tag: 1.31.0-rc.0~3460^2 X-Git-Url: https://git.cyclocoop.org/%7B%7B%20url_for%28?a=commitdiff_plain;h=52902b66672df08ecc4834bbaa48edaf78c4d52d;p=lhc%2Fweb%2Fwiklou.git Document which EtcdConfig parameters are optional Change-Id: Ic6b56ed2f8789ae7920cdfc12f34b00db4a76c3a --- diff --git a/includes/config/EtcdConfig.php b/includes/config/EtcdConfig.php index 0f2f64103a..d3fbd654a7 100644 --- a/includes/config/EtcdConfig.php +++ b/includes/config/EtcdConfig.php @@ -62,12 +62,12 @@ class EtcdConfig implements Config, LoggerAwareInterface { * - host: the host address and port * - protocol: either http or https * - directory: the etc "directory" were MediaWiki specific variables are located - * - encoding: one of ("JSON", "YAML") + * - encoding: one of ("JSON", "YAML"). Defaults to JSON. [optional] * - cache: BagOStuff instance or ObjectFactory spec thereof for a server cache. - * The cache will also be used as a fallback if etcd is down. - * - cacheTTL: logical cache TTL in seconds - * - skewTTL: maximum seconds to randomly lower the assigned TTL on cache save - * - timeout: seconds to wait for etcd before throwing an error + * The cache will also be used as a fallback if etcd is down. [optional] + * - cacheTTL: logical cache TTL in seconds [optional] + * - skewTTL: maximum seconds to randomly lower the assigned TTL on cache save [optional] + * - timeout: seconds to wait for etcd before throwing an error [optional] */ public function __construct( array $params ) { $params += [