From: Aaron Schulz <aschulz@wikimedia.org>
Date: Fri, 2 Oct 2015 00:14:35 +0000 (-0700)
Subject: Clean up getLagTimes() docs
X-Git-Tag: 1.31.0-rc.0~9585^2
X-Git-Url: https://git.heureux-cyclage.org/?a=commitdiff_plain;h=f719a254d19cab271ace2a45f7cf525c40e61417;p=lhc%2Fweb%2Fwiklou.git

Clean up getLagTimes() docs

Change-Id: Icc11619136b6ed10f507e25cd0798da975af4ad1
---

diff --git a/includes/db/loadbalancer/LoadBalancer.php b/includes/db/loadbalancer/LoadBalancer.php
index 3fcd34929c..a0ef753b42 100644
--- a/includes/db/loadbalancer/LoadBalancer.php
+++ b/includes/db/loadbalancer/LoadBalancer.php
@@ -1221,12 +1221,14 @@ class LoadBalancer {
 	}
 
 	/**
-	 * Get lag time for each server
+	 * Get an estimate of replication lag (in seconds) for each server
 	 *
 	 * Results are cached for a short time in memcached/process cache
 	 *
+	 * Values may be "false" if replication is too broken to estimate
+	 *
 	 * @param string|bool $wiki
-	 * @return int[] Map of (server index => seconds)
+	 * @return int[] Map of (server index => float|int|bool)
 	 */
 	public function getLagTimes( $wiki = false ) {
 		if ( $this->getServerCount() <= 1 ) {
diff --git a/includes/db/loadbalancer/LoadMonitor.php b/includes/db/loadbalancer/LoadMonitor.php
index 03ce787dd2..438e4fcb91 100644
--- a/includes/db/loadbalancer/LoadMonitor.php
+++ b/includes/db/loadbalancer/LoadMonitor.php
@@ -43,12 +43,14 @@ interface LoadMonitor {
 	public function scaleLoads( &$loads, $group = false, $wiki = false );
 
 	/**
-	 * Return an estimate of replication lag for each server
+	 * Get an estimate of replication lag (in seconds) for each server
+	 *
+	 * Values may be "false" if replication is too broken to estimate
 	 *
 	 * @param array $serverIndexes
 	 * @param string $wiki
 	 *
-	 * @return array Map of (server index => seconds)
+	 * @return array Map of (server index => float|int|bool)
 	 */
 	public function getLagTimes( $serverIndexes, $wiki );