Adding explantation for why to use User::incEditCount()

... rather than User::incEditCountImmediate() for most cases.

Change-Id: Ia16baabaeaca5c726e1dd1fc2506dc0b85500b6e

diff --git a/includes/user/User.php b/includes/user/User.php
index 3edd49f..3d6cbe4 100644 (file)
--- a/includes/user/User.php
+++ b/includes/user/User.php
@@ -5077,6 +5077,9 @@ class User implements IDBAccessObject {
 
        /**
         * Deferred version of incEditCountImmediate()
+        *
+        * This function, rather than incEditCountImmediate(), should be used for
+        * most cases as it avoids potential deadlocks caused by concurrent editing.
         */
        public function incEditCount() {
                wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle(