Bug 1252066 - Fix docs; r?gfritzsche draft
authorKate Uistiuzhanina <katejimme@gmail.com>
Wed, 08 Mar 2017 22:40:19 +0300
changeset 495412 54e9db5c496246117c5f99078acf0912e41d5f88
parent 494228 3640733aa055d6631604e6a519d84e819663ecb3
child 548374 d58618a3a8b71063404ff91196f4767ef594f54e
push id48328
push userbmo:katejimme@gmail.com
push dateWed, 08 Mar 2017 19:55:05 +0000
reviewersgfritzsche
bugs1252066
milestone54.0a1
Bug 1252066 - Fix docs; r?gfritzsche MozReview-Commit-ID: A6Y1h1BXk4f
toolkit/components/telemetry/TelemetrySession.jsm
toolkit/components/telemetry/docs/data/main-ping.rst
--- a/toolkit/components/telemetry/TelemetrySession.jsm
+++ b/toolkit/components/telemetry/TelemetrySession.jsm
@@ -1342,17 +1342,17 @@ var Impl = {
 
       payloadObj.addonDetails = protect(() => AddonManagerPrivate.getTelemetryDetails());
 
       let clearUIsession = !(reason == REASON_GATHER_PAYLOAD || reason == REASON_GATHER_SUBSESSION_PAYLOAD);
 
       if (AppConstants.platform == "android") {
         payloadObj.UIMeasurements = protect(() => UITelemetry.getUIMeasurements(clearUIsession));
       }
-      
+
       if (this._slowSQLStartup &&
           Object.keys(this._slowSQLStartup).length != 0 &&
           (Object.keys(this._slowSQLStartup.mainThread).length ||
            Object.keys(this._slowSQLStartup.otherThreads).length)) {
         payloadObj.slowSQLStartup = this._slowSQLStartup;
       }
 
       if (!this._isClassicReason(reason)) {
--- a/toolkit/components/telemetry/docs/data/main-ping.rst
+++ b/toolkit/components/telemetry/docs/data/main-ping.rst
@@ -65,17 +65,17 @@ Structure:
       capturedStacks: {...},
       log: [...],
       webrtc: {...},
       gc: {...},
       fileIOReports: {...},
       lateWrites: {...},
       addonDetails: {...},
       addonHistograms: {...},
-      UIMeasurements: [...],
+      UIMeasurements: [...],  // Android only
       slowSQL: {...},
       slowSQLstartup: {...},
     }
 
 info
 ----
 
 sessionLength
@@ -666,17 +666,17 @@ Structure:
     },
 
 slowSQLStartup
 --------------
 This section contains the slow SQL statements gathered at startup (until the "sessionstore-windows-restored" event is fired). The structure of this section resembles the one for `slowSQL`_.
 
 UIMeasurements
 --------------
-This section contains UI specific telemetry measurements and events. This section is mainly populated with Android-specific data and events (`see here <https://dxr.mozilla.org/mozilla-central/search?q=regexp%3AUITelemetry.%28addEvent|startSession|stopSession%29&redirect=false&case=false>`_) and does not apply to other platforms.
+This section is Android-only and contains UI specific Telemetry measurements and events (`see here <https://dxr.mozilla.org/mozilla-central/search?q=regexp%3AUITelemetry.%28addEvent|startSession|stopSession%29&redirect=false&case=false>`_).
 
 Structure:
 
 .. code-block:: js
 
     "UIMeasurements": [
       {
         "type": "event", // either "session" or "event"