Krinkle has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/390548 )

Change subject: Improve StartProfiler.php file documentation
......................................................................

Improve StartProfiler.php file documentation

In preparation for refactoring.

Bug: T180183
Change-Id: Id27227b23e2e6d70b34f686dcff85b882a88fe45
---
M wmf-config/HHVMRequestInit.php
M wmf-config/StartProfiler.php
2 files changed, 23 insertions(+), 4 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/operations/mediawiki-config 
refs/changes/48/390548/1

diff --git a/wmf-config/HHVMRequestInit.php b/wmf-config/HHVMRequestInit.php
index 1919a72..e70040f 100644
--- a/wmf-config/HHVMRequestInit.php
+++ b/wmf-config/HHVMRequestInit.php
@@ -1,4 +1,6 @@
 <?php
+# WARNING: This file is publicly viewable on the web. Do not put private data 
here.
+
 /**
  * Initialization code for HHVM worker threads.
  *
diff --git a/wmf-config/StartProfiler.php b/wmf-config/StartProfiler.php
index 14dc53d..c3c596a 100644
--- a/wmf-config/StartProfiler.php
+++ b/wmf-config/StartProfiler.php
@@ -1,9 +1,26 @@
 <?php
-// WARNING: This file is publically viewable on the web. Do not put private
-// data here.
+# WARNING: This file is publicly viewable on the web. Do not put private data 
here.
 
-// NOTE: this file is loaded early on in WebStart.php, so be careful with
-// globals.
+# ######################################################################
+# StartProfiler.php is where MediaWiki expects the $wgProfiler setting.
+#
+# This file is included by MediaWiki core's Setup.php. Aside from the
+# `auto_prepend_file`, and the first few lines of /w entrypoint, and first
+# line of WebStart.php file, nothing will have run yet.
+#
+# Specifically, StartProfiler runs *before* MediaWiki's Defines.php,
+# DefaultSettings.php, and wmf-config CommonSettings or InitialiseSettings.
+# ######################################################################
+
+/**
+ * File overview:
+ *
+ * 1. Parse X-Wikimedia-Header.
+ * 2A. One-off debug profile via MediaWiki (output in web response by 
MediaWiki)
+ * 2B. One-off debug profile via XHProf directly, saved to disk in /tmp.
+ * 3. Sampling profiler for production.
+ * 4. One-off debug profile via XHProf, saved to XHGui.
+ */
 
 $XWD = false;
 

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: Id27227b23e2e6d70b34f686dcff85b882a88fe45
Gerrit-PatchSet: 1
Gerrit-Project: operations/mediawiki-config
Gerrit-Branch: master
Gerrit-Owner: Krinkle <krinklem...@gmail.com>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to