r92395 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r92394‎ | r92395 | r92396 >
Date:15:48, 17 July 2011
Author:reedy
Status:ok
Tags:
Comment:
Flesh out some TODO documentation from onwiki pages
Modified paths:
  • /trunk/phase3/includes/DefaultSettings.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/DefaultSettings.php
@@ -27,7 +27,7 @@
2828 }
2929
3030 # Create a site configuration object. Not used for much in a default install.
31 -# Note: this (and other things) will break if the autoloader is not enabled.
 31+# Note: this (and other things) will break if the autoloader is not enabled.
3232 # Please include includes/AutoLoader.php before including this file.
3333 $wgConf = new SiteConfiguration;
3434 /** @endcond */
@@ -619,7 +619,7 @@
620620 $wgCustomConvertCommand = false;
621621
622622 /**
623 - * Some tests and extensions use exiv2 to manipulate the EXIF metadata in some image formats.
 623+ * Some tests and extensions use exiv2 to manipulate the EXIF metadata in some image formats.
624624 */
625625 $wgExiv2Command = '/usr/bin/exiv2';
626626
@@ -3305,7 +3305,7 @@
33063306 * when new permissions are introduced and default grants established.
33073307 *
33083308 * If set to an array instead of a boolean, it is assumed that the array is in
3309 - * NS => bool form in order to support per-namespace permissions. Note that
 3309+ * NS => bool form in order to support per-namespace permissions. Note that
33103310 * this feature does not fully work for all permission types.
33113311 *
33123312 * Functionality to make pages inaccessible has not been extensively tested
@@ -3775,7 +3775,7 @@
37763776
37773777
37783778 /**
3779 - * Set this variable if you want to restrict cookies to a certain path within
 3779+ * Set this variable if you want to restrict cookies to a certain path within
37803780 * the domain specified by $wgCookieDomain.
37813781 */
37823782 $wgCookiePath = '/';
@@ -3789,8 +3789,8 @@
37903790 $wgCookieSecure = 'detect';
37913791
37923792 /**
3793 - * By default, MediaWiki checks if the client supports cookies during the
3794 - * login process, so that it can display an informative error message if
 3793+ * By default, MediaWiki checks if the client supports cookies during the
 3794+ * login process, so that it can display an informative error message if
37953795 * cookies are disabled. Set this to true if you want to disable this cookie
37963796 * check.
37973797 */
@@ -4465,12 +4465,31 @@
44664466 * @{
44674467 */
44684468
4469 -/** Override for copyright metadata.
4470 - * TODO: these options need documentation
 4469+/**
 4470+ * Override for copyright metadata.
 4471+ *
 4472+ * This is the name of the page containing information about the wiki's copyright status,
 4473+ * which will be added as a link in the footer if it is specified. It overrides
 4474+ * $wgRightsUrl if both are specified.
44714475 */
44724476 $wgRightsPage = null;
 4477+
 4478+/**
 4479+ * Set this to specify an external URL containing details about the content license used on your wiki.
 4480+ * If $wgRightsPage is set then this setting is ignored.
 4481+ */
44734482 $wgRightsUrl = null;
 4483+
 4484+/**
 4485+ * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link.
 4486+ * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name of the
 4487+ * page will also be used as the link if this variable is not set.
 4488+ */
44744489 $wgRightsText = null;
 4490+
 4491+/**
 4492+ * Override for copyright metadata.
 4493+ */
44754494 $wgRightsIcon = null;
44764495
44774496 /**
@@ -5382,7 +5401,7 @@
53835402 */
53845403
53855404 /**
5386 - * The build directory for HipHop compilation.
 5405+ * The build directory for HipHop compilation.
53875406 * Defaults to $IP/maintenance/hiphop/build.
53885407 */
53895408 $wgHipHopBuildDirectory = false;
@@ -5401,24 +5420,24 @@
54025421 /**
54035422 * Filesystem extensions directory. Defaults to $IP/../extensions.
54045423 *
5405 - * To compile extensions with HipHop, set $wgExtensionsDirectory correctly,
 5424+ * To compile extensions with HipHop, set $wgExtensionsDirectory correctly,
54065425 * and use code like:
5407 - *
 5426+ *
54085427 * require( MWInit::extensionSetupPath( 'Extension/Extension.php' ) );
54095428 *
5410 - * to include the extension setup file from LocalSettings.php. It is not
 5429+ * to include the extension setup file from LocalSettings.php. It is not
54115430 * necessary to set this variable unless you use MWInit::extensionSetupPath().
54125431 */
54135432 $wgExtensionsDirectory = false;
54145433
54155434 /**
5416 - * A list of files that should be compiled into a HipHop build, in addition to
5417 - * those listed in $wgAutoloadClasses. Add to this array in an extension setup
5418 - * file in order to add files to the build.
 5435+ * A list of files that should be compiled into a HipHop build, in addition to
 5436+ * those listed in $wgAutoloadClasses. Add to this array in an extension setup
 5437+ * file in order to add files to the build.
54195438 *
5420 - * The files listed here must either be either absolute paths under $IP or
 5439+ * The files listed here must either be either absolute paths under $IP or
54215440 * under $wgExtensionsDirectory, or paths relative to the virtual source root
5422 - * "$IP/..", i.e. starting with "phase3" for core files, and "extensions" for
 5441+ * "$IP/..", i.e. starting with "phase3" for core files, and "extensions" for
54235442 * extension files.
54245443 */
54255444 $wgCompiledFiles = array();

Status & tagging log