[MediaWiki-commits] [Gerrit] mediawiki/core[master]: Document which EtcdConfig parameters are optional

2017-04-19 Thread jenkins-bot (Code Review)
jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/349126 )

Change subject: Document which EtcdConfig parameters are optional
..


Document which EtcdConfig parameters are optional

Change-Id: Ic6b56ed2f8789ae7920cdfc12f34b00db4a76c3a
---
M includes/config/EtcdConfig.php
1 file changed, 5 insertions(+), 5 deletions(-)

Approvals:
  Krinkle: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/includes/config/EtcdConfig.php b/includes/config/EtcdConfig.php
index 0f2f641..d3fbd65 100644
--- a/includes/config/EtcdConfig.php
+++ b/includes/config/EtcdConfig.php
@@ -62,12 +62,12 @@
 *   - 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 += [

-- 
To view, visit https://gerrit.wikimedia.org/r/349126
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Ic6b56ed2f8789ae7920cdfc12f34b00db4a76c3a
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Aaron Schulz 
Gerrit-Reviewer: Krinkle 
Gerrit-Reviewer: jenkins-bot <>

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits


[MediaWiki-commits] [Gerrit] mediawiki/core[master]: Document which EtcdConfig parameters are optional

2017-04-19 Thread Aaron Schulz (Code Review)
Aaron Schulz has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/349126 )

Change subject: Document which EtcdConfig parameters are optional
..

Document which EtcdConfig parameters are optional

Change-Id: Ic6b56ed2f8789ae7920cdfc12f34b00db4a76c3a
---
M includes/config/EtcdConfig.php
1 file changed, 5 insertions(+), 5 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core 
refs/changes/26/349126/1

diff --git a/includes/config/EtcdConfig.php b/includes/config/EtcdConfig.php
index 0f2f641..d3fbd65 100644
--- a/includes/config/EtcdConfig.php
+++ b/includes/config/EtcdConfig.php
@@ -62,12 +62,12 @@
 *   - 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 += [

-- 
To view, visit https://gerrit.wikimedia.org/r/349126
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ic6b56ed2f8789ae7920cdfc12f34b00db4a76c3a
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Aaron Schulz 

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits