Ori.livneh has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/72477


Change subject: Improve documentation and formatting of debug settings file
......................................................................

Improve documentation and formatting of debug settings file

This change uses a comment style that is more in keeping with the PHP code
conventions and adds an explanatory blurb about what the file is and how to use
it. Still quite a bit of room for improvement.

Change-Id: I2869f96f65fe097b2d8d1f041c488ae97e47d2af
---
M settings.d/00-debug.php-example
1 file changed, 40 insertions(+), 17 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/vagrant 
refs/changes/77/72477/1

diff --git a/settings.d/00-debug.php-example b/settings.d/00-debug.php-example
index 4591b6e..6719537 100644
--- a/settings.d/00-debug.php-example
+++ b/settings.d/00-debug.php-example
@@ -1,30 +1,53 @@
 <?php
-## Debug
-## http://www.mediawiki.org/wiki/Manual:How_to_debug
 
+/**
+ * Debug settings for MediaWiki
+ *
+ * This file contains various MediaWiki configurations designed to assist
+ * feature development, profiling, and debugging work. To enable these
+ * settings, remove the '-example' suffix from this file's name. For an
+ * overview of using settings.d/ to manage MediaWiki configurations, see the
+ * README file in this folder. For a detailed description of the configuration
+ * variables set below, and a survey of some common debugging techniques, see
+ * <http://www.mediawiki.org/wiki/Manual:How_to_debug>.
+ */
+
+//
 // Tools
+//
+
 $wgDebugToolbar = false;
 
-// Types
+
+//
+// Output settings
+//
+
 $wgShowDebug = false;
 $wgShowExceptionDetails = true;
-#$wgDebugRedirects = false;
-#$wgShowSQLErrors = true;
-#$wgDebugDumpSql  = true;
-#$wgMemCachedDebug = false;
-#$wgShowDBErrorBacktrace = false;
+// $wgDebugRedirects = false;
+// $wgShowSQLErrors = true;
+// $wgDebugDumpSql  = true;
+// $wgMemCachedDebug = false;
+// $wgShowDBErrorBacktrace = false;
 
-// Log files
+
+//
+// Logging
+//
+
 $mwLogDir = __DIR__ . '/../logs';
 $wgDebugLogFile = "$mwLogDir/mediawiki-debug.log";
 $wgDBerrorLog = "$mwLogDir/dberror.log";
-#$wgRateLimitLog = "$mwLogDir/ratelimit.log";
+// $wgRateLimitLog = "$mwLogDir/ratelimit.log";
 $wgDebugLogFile = "$mwLogDir/debug.log";
-#$wgDebugLogGroups['somegroup'] = "$mwLogDir/debug-somegroup.log"
+// $wgDebugLogGroups['somegroup'] = "$mwLogDir/debug-somegroup.log"
 
-// ResourceLoader
-#$wgDebugRawPage = true;
-#$wgResourceLoaderMaxage['versioned']['server'] = 1;
-#$wgResourceLoaderMaxage['versioned']['client'] = 1;
-#$wgResourceLoaderMaxage['unversioned']['server'] = 1;
-#$wgResourceLoaderMaxage['unversioned']['client'] = 1;
+
+// ResourceLoader-specific
+
+// $wgDebugRawPage = true;
+// $wgResourceLoaderMaxage['versioned']['server'] = 1;
+// $wgResourceLoaderMaxage['versioned']['client'] = 1;
+// $wgResourceLoaderMaxage['unversioned']['server'] = 1;
+// $wgResourceLoaderMaxage['unversioned']['client'] = 1;

-- 
To view, visit https://gerrit.wikimedia.org/r/72477
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I2869f96f65fe097b2d8d1f041c488ae97e47d2af
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/vagrant
Gerrit-Branch: master
Gerrit-Owner: Ori.livneh <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to