* Fixed bogus dollar signs left in $tmpGlobals array keys in r108300.
authorAaron Schulz <aaron@users.mediawiki.org>
Sat, 7 Jan 2012 03:46:54 +0000 (03:46 +0000)
committerAaron Schulz <aaron@users.mediawiki.org>
Sat, 7 Jan 2012 03:46:54 +0000 (03:46 +0000)
* Various documentation cleanups.

includes/filerepo/backend/FileBackend.php
includes/filerepo/backend/lockmanager/DBLockManager.php
includes/filerepo/backend/lockmanager/FSLockManager.php
includes/filerepo/backend/lockmanager/LSLockManager.php
tests/phpunit/includes/parser/NewParserTest.php
tests/phpunit/suites/UploadFromUrlTestSuite.php

index 35f74a0..2a8bb8d 100644 (file)
@@ -527,6 +527,7 @@ abstract class FileBackend extends FileBackendBase {
        /**
         * Create a file in the backend with the given contents.
         * Do not call this function from places outside FileBackend and FileOp.
+        * 
         * $params include:
         *     content       : the raw file contents
         *     dst           : destination storage path
@@ -549,6 +550,7 @@ abstract class FileBackend extends FileBackendBase {
        /**
         * Store a file into the backend from a file on disk.
         * Do not call this function from places outside FileBackend and FileOp.
+        * 
         * $params include:
         *     src           : source path on disk
         *     dst           : destination storage path
@@ -571,6 +573,7 @@ abstract class FileBackend extends FileBackendBase {
        /**
         * Copy a file from one storage path to another in the backend.
         * Do not call this function from places outside FileBackend and FileOp.
+        * 
         * $params include:
         *     src           : source storage path
         *     dst           : destination storage path
@@ -593,6 +596,7 @@ abstract class FileBackend extends FileBackendBase {
        /**
         * Delete a file at the storage path.
         * Do not call this function from places outside FileBackend and FileOp.
+        * 
         * $params include:
         *     src                 : source storage path
         *     ignoreMissingSource : do nothing if the source file does not exist
@@ -614,6 +618,7 @@ abstract class FileBackend extends FileBackendBase {
        /**
         * Move a file from one storage path to another in the backend.
         * Do not call this function from places outside FileBackend and FileOp.
+        * 
         * $params include:
         *     src           : source storage path
         *     dst           : destination storage path
index 3110d5b..ac9c079 100644 (file)
@@ -32,6 +32,7 @@ class DBLockManager extends LockManager {
 
        /**
         * Construct a new instance from configuration.
+        * 
         * $config paramaters include:
         *     'dbServers'   : Associative array of DB names to server configuration.
         *                     Configuration is an associative array that includes:
index beb7087..be5fda9 100644 (file)
@@ -5,7 +5,7 @@
  * All locks are non-blocking, which avoids deadlocks.
  *
  * This should work fine for small sites running off one server.
- * Do not use this with 'lockDir' set to an NFS mount unless the
+ * Do not use this with 'lockDirectory' set to an NFS mount unless the
  * NFS client is at least version 2.6.12. Otherwise, the BSD flock()
  * locks will be ignored; see http://nfs.sourceforge.net/#section_d.
  *
@@ -24,7 +24,16 @@ class FSLockManager extends LockManager {
        /** @var Array Map of (locked key => lock type => lock file handle) */
        protected $handles = array();
 
+       /**
+        * Construct a new instance from configuration.
+        * 
+        * $config includes:
+        *     'lockDirectory' : Directory containing the lock files
+        *
+        * @param array $config
+        */
        function __construct( array $config ) {
+               parent::__construct( $config );
                $this->lockDir = $config['lockDirectory'];
        }
 
index 45ccaae..383c77c 100644 (file)
@@ -33,6 +33,7 @@ class LSLockManager extends LockManager {
 
        /**
         * Construct a new instance from configuration.
+        * 
         * $config paramaters include:
         *     'lockServers'  : Associative array of server names to configuration.
         *                      Configuration is an associative array that includes:
index 7a0299b..c4ccece 100644 (file)
@@ -243,7 +243,6 @@ class NewParserTest extends MediaWikiTestCase {
                                        'containerPaths' => array(
                                                'local-public' => "$this->uploadDir",
                                                'local-thumb'  => "$this->uploadDir/thumb",
-                                               'local-temp'   => "$this->uploadDir/temp",
                                        )
                                ) )
                        ),
index 7b0b8e9..5f82b52 100644 (file)
@@ -22,13 +22,13 @@ class UploadFromUrlTestSuite extends PHPUnit_Framework_TestSuite {
 
                $tmpGlobals = array();
 
-               $tmpGlobals['$wgScript'] = '/index.php';
-               $tmpGlobals['$wgScriptPath'] = '/';
-               $tmpGlobals['$wgArticlePath'] = '/wiki/$1';
-               $tmpGlobals['$wgStyleSheetPath'] = '/skins';
-               $tmpGlobals['$wgStylePath'] = '/skins';
-               $tmpGlobals['$wgThumbnailScriptPath'] = false;
-               $tmpGlobals['$wgLocalFileRepo'] = array(
+               $tmpGlobals['wgScript'] = '/index.php';
+               $tmpGlobals['wgScriptPath'] = '/';
+               $tmpGlobals['wgArticlePath'] = '/wiki/$1';
+               $tmpGlobals['wgStyleSheetPath'] = '/skins';
+               $tmpGlobals['wgStylePath'] = '/skins';
+               $tmpGlobals['wgThumbnailScriptPath'] = false;
+               $tmpGlobals['wgLocalFileRepo'] = array(
                        'class'           => 'LocalRepo',
                        'name'            => 'local',
                        'url'             => 'http://example.com/images',