Clean up $wgFileBackends/$wgLockManagers comments
authorAaron Schulz <aschulz@wikimedia.org>
Thu, 1 Aug 2019 18:25:27 +0000 (14:25 -0400)
committerAaron Schulz <aschulz@wikimedia.org>
Thu, 1 Aug 2019 18:25:27 +0000 (14:25 -0400)
Change-Id: Ib9692176f0e100f3b0c39544109ef2d8a8c8cd92

includes/DefaultSettings.php

index 608ef6a..a3772b9 100644 (file)
@@ -738,10 +738,11 @@ $wgUploadDialog = [
  *
  * This is an array of file backend configuration arrays.
  * Each backend configuration has the following parameters:
- *  - 'name'         : A unique name for the backend
- *  - 'class'        : The file backend class to use
- *  - 'wikiId'       : A unique string that identifies the wiki (container prefix)
- *  - 'lockManager'  : The name of a lock manager (see $wgLockManagers)
+ *  - name        : A unique name for the backend
+ *  - class       : The file backend class to use
+ *  - wikiId      : A unique string that identifies the wiki (container prefix)
+ *  - lockManager : The name of a lock manager (see $wgLockManagers) [optional]
+ *  - fileJournal : File journal configuration for FileJournal::__construct() [optional]
  *
  * See FileBackend::__construct() for more details.
  * Additional parameters are specific to the file backend class used.
@@ -774,8 +775,8 @@ $wgFileBackends = [];
 /**
  * Array of configuration arrays for each lock manager.
  * Each backend configuration has the following parameters:
- *  - 'name'        : A unique name for the lock manager
- *  - 'class'       : The lock manger class to use
+ *  - name  : A unique name for the lock manager
+ *  - class : The lock manger class to use
  *
  * See LockManager::__construct() for more details.
  * Additional parameters are specific to the lock manager class used.