X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=StartProfiler.sample;h=4721a9dde3c6e93c9eb3dc7ed78fa904956b457c;hb=4a9840e271eb6f4c713e6a4991571db390ea3d2b;hp=db5e0ff9e261adad18a34551a204b11aec254b0f;hpb=1bcb2c06e6ee20bd099110ba395e45c953462039;p=lhc%2Fweb%2Fwiklou.git

diff --git a/StartProfiler.sample b/StartProfiler.sample
index db5e0ff9e2..4721a9dde3 100644
--- a/StartProfiler.sample
+++ b/StartProfiler.sample
@@ -1,17 +1,30 @@
 <?php
 
 /**
- * To use a profiler, copy this file to StartProfiler.php,
- * and add something like this:
+ * To use a profiler, copy this file to StartProfiler.php and add:
+ *  $wgProfiler['class'] = 'ProfilerXhprof';
  *
- *   $wgProfiler['class'] = 'Profiler';
+ * For output, add:
+ *  $wgProfiler['output'] = array( 'text' );
+ *    'text' can be one (or more) of 'text' 'udp' or 'db'
+ *    'db' requires creating the profiling table, see patch-profiling.sql
  *
- * Or for a sampling profiler:
- *   if ( !mt_rand( 0, 100 ) ) {
- *       $wgProfiler['class'] = 'Profiler';
- *   } else {
- *       $wgProfiler['class'] = 'ProfilerStub';
- *   }
+ * The 'text' output will be added to the output page in a comment approriate
+ * to the output's mime type. For a text/html page, this display can be
+ * changed to a preformatted text block by setting the 'visible' configuration
+ * flag:
+ *  $wgProfiler['visible'] = true;
  *
- * Configuration of the profiler output can be done in LocalSettings.php
+ * The 'db' output expects a database table that can be created by applying
+ * maintenance/archives/patch-profiling.sql to your database.
+ *
+ * For a rudimentary sampling profiler:
+ *   $wgProfiler['class'] = 'ProfilerXhprof';
+ *   $wgProfiler['output'] = array( 'db' );
+ *   $wgProfiler['sampling'] = 50; // one every 50 requests
+ * This will use ProfilerStub for non-sampled cases.
+ *
+ * For performance, the profiler is always disabled for CLI scripts
+ * as they could be long running and the data would accumulate. Use
+ * the --profiler parameter of maintenance scripts to override this.
  */