From 6015071beb7bab0cfbfe39da5cd018af5e2807a0 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex.wiki@gmail.com>
Date: Thu, 9 Aug 2012 18:06:18 +0200
Subject: [PATCH] Improve documentation of maintenance scripts.

Change-Id: I21b4fb873e88026108754eb7206e62c82648df0e
---
 maintenance/reassignEdits.php            |  7 +++++++
 maintenance/rebuildFileCache.php         |  8 +++++++-
 maintenance/rebuildImages.php            |  7 ++++++-
 maintenance/rebuildLocalisationCache.php |  8 +++++++-
 maintenance/rebuildall.php               |  6 ++++++
 maintenance/rebuildmessages.php          |  8 +++++++-
 maintenance/rebuildrecentchanges.php     | 10 ++++++++--
 maintenance/rebuildtextindex.php         |  6 ++++++
 maintenance/refreshImageMetadata.php     |  7 ++++++-
 maintenance/removeUnusedAccounts.php     |  6 ++++++
 10 files changed, 66 insertions(+), 7 deletions(-)

diff --git a/maintenance/reassignEdits.php b/maintenance/reassignEdits.php
index da9fa5396e..2afd6e087f 100644
--- a/maintenance/reassignEdits.php
+++ b/maintenance/reassignEdits.php
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @author Rob Church <robchur@gmail.com>
  * @licence GNU General Public Licence 2.0 or later
@@ -24,6 +25,12 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that reassigns edits from a user or IP address
+ * to another user.
+ *
+ * @ingroup Maintenance
+ */
 class ReassignEdits extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/rebuildFileCache.php b/maintenance/rebuildFileCache.php
index ea07f19515..4dbe267f8e 100644
--- a/maintenance/rebuildFileCache.php
+++ b/maintenance/rebuildFileCache.php
@@ -17,11 +17,17 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that builds file cache for content pages.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildFileCache extends Maintenance {
 	public function __construct() {
 		parent::__construct();
@@ -97,7 +103,7 @@ class RebuildFileCache extends Maintenance {
 			foreach ( $res as $row ) {
 				$rebuilt = false;
 				$wgRequestTime = microtime( true ); # bug 22852
-				
+
 				$wgTitle = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
 				if ( null == $wgTitle ) {
 					$this->output( "Page {$row->page_id} has bad title\n" );
diff --git a/maintenance/rebuildImages.php b/maintenance/rebuildImages.php
index 7e3d8c4048..936efd7f04 100644
--- a/maintenance/rebuildImages.php
+++ b/maintenance/rebuildImages.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Script to update image metadata records
+ * Update image metadata records.
  *
  * Usage: php rebuildImages.php [--missing] [--dry-run]
  * Options:
@@ -32,6 +32,11 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to update image metadata records.
+ *
+ * @ingroup Maintenance
+ */
 class ImageBuilder extends Maintenance {
 
 	/**
diff --git a/maintenance/rebuildLocalisationCache.php b/maintenance/rebuildLocalisationCache.php
index ffe66c6c8e..c48fb7421e 100644
--- a/maintenance/rebuildLocalisationCache.php
+++ b/maintenance/rebuildLocalisationCache.php
@@ -25,18 +25,24 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to rebuild the localisation cache.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildLocalisationCache extends Maintenance {
 	public function __construct() {
 		parent::__construct();
 		$this->mDescription = "Rebuild the localisation cache";
 		$this->addOption( 'force', 'Rebuild all files, even ones not out of date' );
 		$this->addOption( 'threads', 'Fork more than one thread', false, true );
-		$this->addOption( 'outdir', 'Override the output directory (normally $wgCacheDirectory)', 
+		$this->addOption( 'outdir', 'Override the output directory (normally $wgCacheDirectory)',
 			false, true );
 	}
 
diff --git a/maintenance/rebuildall.php b/maintenance/rebuildall.php
index dbbed86d25..bc9f732f6c 100644
--- a/maintenance/rebuildall.php
+++ b/maintenance/rebuildall.php
@@ -18,11 +18,17 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that rebuilds link tracking tables from scratch.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildAll extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/rebuildmessages.php b/maintenance/rebuildmessages.php
index de37da7e47..a22d3afbac 100644
--- a/maintenance/rebuildmessages.php
+++ b/maintenance/rebuildmessages.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This script purges all language messages from the cache
+ * Purge all languages from the message cache.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,11 +17,17 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that purges all languages from the message cache.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildMessages extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/rebuildrecentchanges.php b/maintenance/rebuildrecentchanges.php
index 92d6090247..5caa0a8fc0 100644
--- a/maintenance/rebuildrecentchanges.php
+++ b/maintenance/rebuildrecentchanges.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Rebuild link tracking tables from scratch.  This takes several
- * hours, depending on the database size and server configuration.
+ * Rebuild recent changes from scratch.  This takes several hours,
+ * depending on the database size and server configuration.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,12 +18,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @todo Document
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that rebuilds recent changes from scratch.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildRecentchanges extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/rebuildtextindex.php b/maintenance/rebuildtextindex.php
index 494e0a7576..a37d603451 100644
--- a/maintenance/rebuildtextindex.php
+++ b/maintenance/rebuildtextindex.php
@@ -20,12 +20,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @todo document
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that rebuilds search index table from scratch.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildTextIndex extends Maintenance {
 	const RTI_CHUNK_SIZE = 500;
 
diff --git a/maintenance/refreshImageMetadata.php b/maintenance/refreshImageMetadata.php
index 958b2ba191..6623beab23 100644
--- a/maintenance/refreshImageMetadata.php
+++ b/maintenance/refreshImageMetadata.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Script to refresh image metadata fields. See also rebuildImages.php
+ * Refresh image metadata fields. See also rebuildImages.php
  *
  * Usage: php refreshImageMetadata.php
  *
@@ -29,6 +29,11 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to refresh image metadata fields.
+ *
+ * @ingroup Maintenance
+ */
 class RefreshImageMetadata extends Maintenance {
 
 	/**
diff --git a/maintenance/removeUnusedAccounts.php b/maintenance/removeUnusedAccounts.php
index b288c2fb48..490602d5b4 100644
--- a/maintenance/removeUnusedAccounts.php
+++ b/maintenance/removeUnusedAccounts.php
@@ -18,12 +18,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @author Rob Church <robchur@gmail.com>
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that removes unused user accounts from the database.
+ *
+ * @ingroup Maintenance
+ */
 class RemoveUnusedAccounts extends Maintenance {
 	public function __construct() {
 		parent::__construct();
-- 
2.20.1