From 5711d811262421cac77207d9d3fb62d4d9f52855 Mon Sep 17 00:00:00 2001
From: Erik Bernhardson <ebernhardson@wikimedia.org>
Date: Fri, 14 Nov 2014 11:00:36 -0800
Subject: [PATCH] Doc: Mention the php command in autoload.php to regenerate it

Adds a comment to the top of the generated autoload.php directing
developers to the command to regenerate the file so they may just
copy and paste the command.

Change-Id: If098a1eb51ed732378677215c0e438c73d506697
---
 autoload.php                          | 2 +-
 includes/utils/AutoloadGenerator.php  | 7 +++++--
 maintenance/generateLocalAutoload.php | 2 +-
 3 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/autoload.php b/autoload.php
index c5fc22c3ef..488f9ddf9a 100644
--- a/autoload.php
+++ b/autoload.php
@@ -1,5 +1,5 @@
 <?php
-// This file is generated, do not adjust manually
+// This file is generated by maintenance/generateLocalAutoload.php, do not adjust manually
 
 global $wgAutoloadLocalClasses;
 
diff --git a/includes/utils/AutoloadGenerator.php b/includes/utils/AutoloadGenerator.php
index 7cf05bc831..8952947865 100644
--- a/includes/utils/AutoloadGenerator.php
+++ b/includes/utils/AutoloadGenerator.php
@@ -118,8 +118,11 @@ class AutoloadGenerator {
 	/**
 	 * Write out all known classes to autoload.php in
 	 * the provided basedir
+	 *
+	 * @param string $commandName Value used in file comment to direct
+	 *  developers towards the appropriate way to update the autoload.
 	 */
-	public function generateAutoload() {
+	public function generateAutoload( $commandName = 'AutoloadGenerator' ) {
 		$content = array();
 
 		// We need to generate a line each rather than exporting the
@@ -152,7 +155,7 @@ class AutoloadGenerator {
 			$this->basepath . '/autoload.php',
 			<<<EOD
 <?php
-// This file is generated, do not adjust manually
+// This file is generated by $commandName, do not adjust manually
 
 global \${$this->variableName};
 
diff --git a/maintenance/generateLocalAutoload.php b/maintenance/generateLocalAutoload.php
index 5e4cac6fe3..b8caa4d93f 100644
--- a/maintenance/generateLocalAutoload.php
+++ b/maintenance/generateLocalAutoload.php
@@ -21,5 +21,5 @@ foreach ( glob( $base . '/*.php' ) as $file ) {
 $generator->forceClassPath( 'MyLocalSettingsGenerator', "$base/mw-config/overrides.php" );
 
 // Write out the autoload
-$generator->generateAutoload();
+$generator->generateAutoload( 'maintenance/generateLocalAutoload.php' );
 
-- 
2.20.1