Can someone standardi[sz]e SQL already!?

[lhc/web/wiklou.git] / maintenance / Maintenance.php

diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index c4e672f..fda12f9 100644 (file)
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -20,6 +20,11 @@
  * @defgroup Maintenance Maintenance
  */
 
+/**
+ * @defgroup MaintenanceArchive Maintenance archives
+ * @ingroup Maintenance
+ */
+
 // Define this so scripts can easily find doMaintenance.php
 define( 'RUN_MAINTENANCE_IF_MAIN', dirname( __FILE__ ) . '/doMaintenance.php' );
 define( 'DO_MAINTENANCE', RUN_MAINTENANCE_IF_MAIN ); // original name, harmless
@@ -292,6 +297,9 @@ abstract class Maintenance {
                return rtrim( $input );
        }
 
+       /**
+        * @return bool
+        */
        public function isQuiet() {
                return $this->mQuiet;
        }
@@ -314,8 +322,7 @@ abstract class Maintenance {
                        } else {
                                print( $out );
                        }
-               }
-               else {
+               } else {
                        $out = preg_replace( '/\n\z/', '', $out );
                        $this->outputChanneled( $out, $channel );
                }
@@ -362,7 +369,7 @@ abstract class Maintenance {
         * same channel are concatenated, but any intervening messages in another
         * channel start a new line.
         * @param $msg String: the message without trailing newline
-        * @param $channel Channel identifier or null for no
+        * @param $channel string Channel identifier or null for no
         *     channel. Channel comparison uses ===.
         */
        public function outputChanneled( $msg, $channel = null ) {
@@ -947,7 +954,7 @@ abstract class Maintenance {
        public function purgeRedundantText( $delete = true ) {
                # Data should come off the master, wrapped in a transaction
                $dbw = $this->getDB( DB_MASTER );
-               $dbw->begin();
+               $dbw->begin( __METHOD__ );
 
                $tbl_arc = $dbw->tableName( 'archive' );
                $tbl_rev = $dbw->tableName( 'revision' );
@@ -992,7 +999,7 @@ abstract class Maintenance {
                }
 
                # Done
-               $dbw->commit();
+               $dbw->commit( __METHOD__ );
        }
 
        /**
@@ -1022,7 +1029,6 @@ abstract class Maintenance {
                if ( !self::$mCoreScripts ) {
                        $paths = array(
                                dirname( __FILE__ ),
-                               dirname( __FILE__ ) . '/gearman',
                                dirname( __FILE__ ) . '/language',
                                dirname( __FILE__ ) . '/storage',
                        );
@@ -1076,7 +1082,7 @@ abstract class Maintenance {
 
        /**
         * Lock the search index
-        * @param &$db Database object
+        * @param &$db DatabaseBase object
         */
        private function lockSearchindex( &$db ) {
                $write = array( 'searchindex' );
@@ -1086,7 +1092,7 @@ abstract class Maintenance {
 
        /**
         * Unlock the tables
-        * @param &$db Database object
+        * @param &$db DatabaseBase object
         */
        private function unlockSearchindex( &$db ) {
                $db->unlockTables(  __CLASS__ . '::' . __METHOD__ );
@@ -1095,7 +1101,7 @@ abstract class Maintenance {
        /**
         * Unlock and lock again
         * Since the lock is low-priority, queued reads will be able to complete
-        * @param &$db Database object
+        * @param &$db DatabaseBase object
         */
        private function relockSearchindex( &$db ) {
                $this->unlockSearchindex( $db );
@@ -1143,7 +1149,7 @@ abstract class Maintenance {
 
        /**
         * Update the searchindex table for a given pageid
-        * @param $dbw Database: a database write handle
+        * @param $dbw DatabaseBase a database write handle
         * @param $pageId Integer: the page ID to update.
         * @return null|string
         */