From 86a9b8c06c446d4afa688bc81832813e0f8e32df Mon Sep 17 00:00:00 2001
From: Waldir Pimenta <waldir@email.com>
Date: Fri, 15 Feb 2013 07:31:48 +0000
Subject: [PATCH] Clean up access points

* Harmonize spacing
* Use // for comments rather than #
* Harmonize call style for 'require', 'include' etc.
* Add missing profileinfo.php5
* Use "./" for path to api.php in api.php5 (to match other php5 files).
* Move documentation related to Setup.php from index.php to WebStart.php
* Remove "Initialise common code." comment in api.php (was already remove
  in most entry points)

Change-Id: I8dc4a79fd13cee49e34f250a4039b3666bd42aca
---
 api.php                                |  1 -
 api.php5                               |  6 +++---
 img_auth.php5                          |  4 ++--
 includes/WebStart.php                  |  5 ++++-
 includes/rcfeed/XMLRCFeedFormatter.php |  1 -
 index.php                              |  3 ---
 index.php5                             |  4 ++--
 load.php5                              |  4 ++--
 mw-config/index.php                    |  2 ++
 mw-config/index.php5                   |  7 ++++---
 opensearch_desc.php5                   |  4 ++--
 profileinfo.php5                       | 24 ++++++++++++++++++++++++
 thumb.php5                             |  4 ++--
 thumb_handler.php                      |  4 ++--
 thumb_handler.php5                     |  4 ++--
 wiki.phtml                             |  2 +-
 16 files changed, 52 insertions(+), 27 deletions(-)
 create mode 100644 profileinfo.php5

diff --git a/api.php b/api.php
index 554c2726bc..e55ec75a33 100644
--- a/api.php
+++ b/api.php
@@ -40,7 +40,6 @@ if ( !function_exists( 'version_compare' ) || version_compare( phpversion(), '5.
 	wfPHPVersionError( 'api.php' );
 }
 
-// Initialise common code.
 require __DIR__ . '/includes/WebStart.php';
 
 wfProfileIn( 'api.php' );
diff --git a/api.php5 b/api.php5
index 1828b7b4d1..524dfd5463 100644
--- a/api.php5
+++ b/api.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of api.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of api.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
@@ -21,4 +21,4 @@
  * @file
  */
 
-require 'api.php';
+require './api.php';
diff --git a/img_auth.php5 b/img_auth.php5
index a86d7c0ba2..7aee69abd9 100644
--- a/img_auth.php5
+++ b/img_auth.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of img_auth.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of img_auth.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
diff --git a/includes/WebStart.php b/includes/WebStart.php
index eb79134337..766b3bf534 100644
--- a/includes/WebStart.php
+++ b/includes/WebStart.php
@@ -1,10 +1,13 @@
 <?php
 /**
- * This does the initial setup for a web request.
+ * This does the initial set up for a web request.
  * It does some security checks, starts the profiler and loads the
  * configuration, and optionally loads Setup.php depending on whether
  * MW_NO_SETUP is defined.
  *
+ * Setup.php (if loaded) then sets up GlobalFunctions, the AutoLoader,
+ * and the configuration globals (though not $wgTitle).
+ *
  * 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
  * the Free Software Foundation; either version 2 of the License, or
diff --git a/includes/rcfeed/XMLRCFeedFormatter.php b/includes/rcfeed/XMLRCFeedFormatter.php
index d5724264ad..d4df91a4b0 100644
--- a/includes/rcfeed/XMLRCFeedFormatter.php
+++ b/includes/rcfeed/XMLRCFeedFormatter.php
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * 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
diff --git a/index.php b/index.php
index 8885d0e675..bc46111bd4 100644
--- a/index.php
+++ b/index.php
@@ -40,9 +40,6 @@ if ( !function_exists( 'version_compare' ) || version_compare( phpversion(), '5.
 	wfPHPVersionError( 'index.php' );
 }
 
-# Initialise common code.  This gives us access to GlobalFunctions, the
-# AutoLoader, and the globals $wgRequest, $wgOut, $wgUser, $wgLang and
-# $wgContLang, amongst others
 require __DIR__ . '/includes/WebStart.php';
 
 $mediaWiki = new MediaWiki();
diff --git a/index.php5 b/index.php5
index b3e40b67d3..b2ffe50863 100644
--- a/index.php5
+++ b/index.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of index.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of index.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
diff --git a/load.php5 b/load.php5
index 9471c650a4..fb3c7646cb 100644
--- a/load.php5
+++ b/load.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of load.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of load.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
diff --git a/mw-config/index.php b/mw-config/index.php
index 570b426edc..fc7eadb5a4 100644
--- a/mw-config/index.php
+++ b/mw-config/index.php
@@ -23,6 +23,8 @@
 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
 define( 'MEDIAWIKI_INSTALL', true );
 
+// Resolve relative to regular MediaWiki root
+// instead of mw-config subdirectory.
 chdir( dirname( __DIR__ ) );
 require dirname( __DIR__ ) . '/includes/WebStart.php';
 
diff --git a/mw-config/index.php5 b/mw-config/index.php5
index bc9e891be4..889865326e 100644
--- a/mw-config/index.php5
+++ b/mw-config/index.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of mw-config/index.php to used in web server requiring .php5
- * extension to execute scripts with PHP5 engine.
+ * Version of mw-config/index.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
@@ -21,5 +21,6 @@
  * @file
  */
 
-define('MW_INSTALL_PHP5_EXT', 1);
+define( 'MW_INSTALL_PHP5_EXT', 1 );
+
 require './index.php';
diff --git a/opensearch_desc.php5 b/opensearch_desc.php5
index 0c499a4d72..a4dde371e6 100644
--- a/opensearch_desc.php5
+++ b/opensearch_desc.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of opensearch_desc.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of opensearch_desc.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
diff --git a/profileinfo.php5 b/profileinfo.php5
new file mode 100644
index 0000000000..14ef421435
--- /dev/null
+++ b/profileinfo.php5
@@ -0,0 +1,24 @@
+<?php
+/**
+ * Version of profileinfo.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+require './profileinfo.php';
diff --git a/thumb.php5 b/thumb.php5
index 2a57d4aa05..d07b86f1af 100644
--- a/thumb.php5
+++ b/thumb.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of thumb.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of thumb.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
diff --git a/thumb_handler.php b/thumb_handler.php
index 7afa9aa774..e2b165b8a9 100644
--- a/thumb_handler.php
+++ b/thumb_handler.php
@@ -24,6 +24,6 @@
 
 define( 'THUMB_HANDLER', true );
 
-# Execute thumb.php, having set THUMB_HANDLER so that
-# it knows to extract params from a thumbnail file URL.
+// Execute thumb.php, having set THUMB_HANDLER so that
+// it knows to extract params from a thumbnail file URL.
 require __DIR__ . '/thumb.php';
diff --git a/thumb_handler.php5 b/thumb_handler.php5
index f160c87958..0e0c3c0b27 100644
--- a/thumb_handler.php5
+++ b/thumb_handler.php5
@@ -1,7 +1,7 @@
 <?php
 /**
- * Version of thumb_handler.php to used in web server requiring .php5 extension
- * to execute scripts with PHP5 engine.
+ * Version of thumb_handler.php to be used in web servers that require the .php5
+ * extension to execute scripts with the PHP5 engine.
  *
  * 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
diff --git a/wiki.phtml b/wiki.phtml
index b5450e1108..a1975457e1 100644
--- a/wiki.phtml
+++ b/wiki.phtml
@@ -1,3 +1,3 @@
 <?php
-// stub file for compatibility with older versions
+// Stub file for compatibility with older versions of MediaWiki
 include_once './index.php';
-- 
2.20.1