From 15eb06032ae167c664ae47b07521f3bd747d053d Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@users.mediawiki.org>
Date: Sat, 19 Jul 2008 12:15:07 +0000
Subject: [PATCH] Fix 12384 : comment on maintenance/*php files

---
 RELEASE-NOTES                        | 1 +
 includes/DefaultSettings.php         | 4 +++-
 maintenance/checkUsernames.php       | 3 +++
 maintenance/clear_stats.php          | 3 +++
 maintenance/deleteImageMemcached.php | 6 +++++-
 maintenance/deleteRevision.php       | 3 +++
 maintenance/getSlaveServer.php       | 2 ++
 maintenance/mctest.php               | 3 +++
 maintenance/ourusers.php             | 6 ++++++
 maintenance/rebuildmessages.php      | 3 ++-
 maintenance/runJobs.php              | 6 ++++++
 maintenance/showJobs.php             | 2 ++
 maintenance/undelete.php             | 2 +-
 maintenance/update.php               | 2 ++
 maintenance/waitForSlave.php         | 1 +
 15 files changed, 43 insertions(+), 4 deletions(-)

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index bc188db7f9..ae5c03f343 100644
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -440,6 +440,7 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
 * (bug 14845) Bug in prefs javascript: Calling an array item without checking
   its existance.
 * Accesskeys for minor edit/watch checkboxes on edit now work in Firefox 3
+* (bug 12384) Comments in maintenance/*php
 
 === API changes in 1.13 ===
 
diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index 72e115a30a..874e171509 100644
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -923,9 +923,11 @@ $wgRedirectSources = false;
 
 
 $wgShowIPinHeader	= true; # For non-logged in users
-$wgMaxNameChars		= 255;  # Maximum number of bytes in username
 $wgMaxSigChars		= 255;  # Maximum number of Unicode characters in signature
 $wgMaxArticleSize	= 2048; # Maximum article size in kilobytes
+# Maximum number of bytes in username. You want to run the maintenance
+# script ./maintenancecheckUsernames.php once you have changed this value
+$wgMaxNameChars		= 255;
 
 $wgMaxPPNodeCount = 1000000;  # A complexity limit on template expansion
 
diff --git a/maintenance/checkUsernames.php b/maintenance/checkUsernames.php
index 3b414ddf6e..fe7fb136f2 100644
--- a/maintenance/checkUsernames.php
+++ b/maintenance/checkUsernames.php
@@ -1,5 +1,8 @@
 <?php
 /**
+ * This script verify that database usernames are actually valid.
+ * An existing usernames can become invalid if User::isValidUserName()
+ * is altered or if we change the $wgMaxNameChars
  * @file
  * @ingroup Maintenance
  */
diff --git a/maintenance/clear_stats.php b/maintenance/clear_stats.php
index 65b4097b15..340ce1e20d 100644
--- a/maintenance/clear_stats.php
+++ b/maintenance/clear_stats.php
@@ -1,5 +1,8 @@
 <?php
 /**
+ * This script remove all statistics tracking from memcached
+ * for ALL wiki !
+ * 
  * @file
  * @ingroup Maintenance
  */
diff --git a/maintenance/deleteImageMemcached.php b/maintenance/deleteImageMemcached.php
index 66126d638d..61d18d7bd0 100644
--- a/maintenance/deleteImageMemcached.php
+++ b/maintenance/deleteImageMemcached.php
@@ -1,6 +1,10 @@
 <?php
-// php deleteImageMemcached.php --until "2005-09-05 00:00:00" --sleep 0 --report 10
 /**
+ * This script delete image informations from memcached.
+ *
+ * Usage example:
+ * php deleteImageMemcached.php --until "2005-09-05 00:00:00" --sleep 0 --report 10
+ *
  * @file
  * @ingroup Maintenance
  */
diff --git a/maintenance/deleteRevision.php b/maintenance/deleteRevision.php
index 63667f6899..3bc4f737a9 100644
--- a/maintenance/deleteRevision.php
+++ b/maintenance/deleteRevision.php
@@ -1,5 +1,8 @@
 <?php
 /**
+ * Delete a given list of revision.
+ * The revision is in fact moved to the archive table.
+ *
  * @file
  * @ingroup Maintenance
  */
diff --git a/maintenance/getSlaveServer.php b/maintenance/getSlaveServer.php
index 97104e08a3..ead78d5dea 100644
--- a/maintenance/getSlaveServer.php
+++ b/maintenance/getSlaveServer.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * This script report the hostname of a slave server.
+ *
  * @file
  * @ingroup Maintenance
  */
diff --git a/maintenance/mctest.php b/maintenance/mctest.php
index 9397464fc8..9d45280c9c 100644
--- a/maintenance/mctest.php
+++ b/maintenance/mctest.php
@@ -1,5 +1,8 @@
 <?php
 /**
+ * This script make several set, incr and get requests on every
+ * memcached server and show a report.
+ *
  * $Id$
  * @file
  * @ingroup Maintenance
diff --git a/maintenance/ourusers.php b/maintenance/ourusers.php
index 2f426a574d..620393fb99 100644
--- a/maintenance/ourusers.php
+++ b/maintenance/ourusers.php
@@ -1,5 +1,11 @@
 <?php
 /**
+ * Wikimedia specific
+ *
+ * This script generates SQL used to update MySQL users on a hardcoded
+ * list of hosts. It takes care of setting the wikiuser for every
+ * database as well as setting up wikiadmin.
+ *
  * @todo document
  * @file
  * @ingroup Maintenance
diff --git a/maintenance/rebuildmessages.php b/maintenance/rebuildmessages.php
index 36bf48e279..dadf15d85e 100644
--- a/maintenance/rebuildmessages.php
+++ b/maintenance/rebuildmessages.php
@@ -1,5 +1,6 @@
 <?php
 /**
+ * This script purge languages messages from memcached
  * @file
  * @ingroup Maintenance
  */
@@ -18,4 +19,4 @@ foreach( $databases as $db ) {
 	if( $wgEnableSidebarCache )
 		$messageMemc->delete( "{$db}:sidebar" );
 	echo "Deleted\n";
-}
\ No newline at end of file
+}
diff --git a/maintenance/runJobs.php b/maintenance/runJobs.php
index d610b8cc32..14d0809196 100644
--- a/maintenance/runJobs.php
+++ b/maintenance/runJobs.php
@@ -1,5 +1,11 @@
 <?php
 /**
+ * This script starts pending jobs.
+ *
+ * Usage:
+ *  --maxjobs <num> (default 10000)
+ *  --type <job_cmd>
+ *
  * @file
  * @ingroup Maintenance
  */
diff --git a/maintenance/showJobs.php b/maintenance/showJobs.php
index 7d2855efca..d4f68db774 100644
--- a/maintenance/showJobs.php
+++ b/maintenance/showJobs.php
@@ -2,6 +2,8 @@
 /**
  * Based on runJobs.php
  *
+ * Report number of jobs currently waiting in master database.
+ *
  * @file
  * @ingroup Maintenance
  * @author Tim Starling
diff --git a/maintenance/undelete.php b/maintenance/undelete.php
index a34537d96b..b7b7df979e 100644
--- a/maintenance/undelete.php
+++ b/maintenance/undelete.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Undelete a page
+ * Undelete a page by fetching it from the archive table
  *
  * @file
  * @ingroup Maintenance
diff --git a/maintenance/update.php b/maintenance/update.php
index fc3742d938..3f48413783 100644
--- a/maintenance/update.php
+++ b/maintenance/update.php
@@ -3,6 +3,8 @@ require_once 'counter.php';
 /**
  * Run all updaters.
  *
+ * This is used when the database schema is modified and we need to apply patches.
+ *
  * @file
  * @todo document
  * @ingroup Maintenance
diff --git a/maintenance/waitForSlave.php b/maintenance/waitForSlave.php
index 179910000b..309d0e7d36 100644
--- a/maintenance/waitForSlave.php
+++ b/maintenance/waitForSlave.php
@@ -1,5 +1,6 @@
 <?php
 /**
+ * @see wfWaitForSlaves()
  * @file
  * @ingroup Maintenance
  */
-- 
2.20.1