From: Matthew Flaschen <mflaschen@wikimedia.org>
Date: Wed, 24 Feb 2016 23:22:30 +0000 (-0500)
Subject: IDatabase::commit: Docs re 'flush' exception on explicit transaction
X-Git-Tag: 1.31.0-rc.0~7845
X-Git-Url: http://git.cyclocoop.org/data/%24oldEdit?a=commitdiff_plain;h=d4d086b0cee47b8110eeb12bf870b7a75bd0e05a;p=lhc%2Fweb%2Fwiklou.git

IDatabase::commit: Docs re 'flush' exception on explicit transaction

Change-Id: I44087e92d2186f4e931b3f0766caba1f90f4ebc4
---

diff --git a/includes/db/IDatabase.php b/includes/db/IDatabase.php
index e1d1173b14..7855861281 100644
--- a/includes/db/IDatabase.php
+++ b/includes/db/IDatabase.php
@@ -1334,9 +1334,13 @@ interface IDatabase {
 	 * @param string $fname
 	 * @param string $flush Flush flag, set to 'flush' to disable warnings about
 	 *   explicitly committing implicit transactions, or calling commit when no
-	 *   transaction is in progress. This will silently break any ongoing
-	 *   explicit transaction. Only set the flush flag if you are sure that it
-	 *   is safe to ignore these warnings in your context.
+	 *   transaction is in progress.
+	 *
+	 *   This will trigger an exception if there is an ongoing explicit transaction.
+	 *
+	 *   Only set the flush flag if you are sure that these warnings are not applicable,
+	 *   and no explicit transactions are open.
+	 *
 	 * @throws DBUnexpectedError
 	 */
 	public function commit( $fname = __METHOD__, $flush = '' );