Update telemetry docs. (bug 1187453, r=vladan)
authorDavid Anderson <danderson@mozilla.com>
Tue, 28 Jul 2015 00:55:25 -0700
changeset 254937 bbfc4a235468722cf40f4fe94a2fc058ebe31206
parent 254936 74f0184fcd5506a502a717c63aaeeaf8aff0f002
child 254938 bc589dd18ad57ab24bd70070855c4c9568796cc5
child 254944 26d59ea97d2d2f1bd46d7ded4c666e37736327bb
push id16737
push usercbook@mozilla.com
push dateTue, 28 Jul 2015 14:44:21 +0000
treeherderb2g-inbound@e7a1dd4f8533 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersvladan
bugs1187453
milestone42.0a1
Update telemetry docs. (bug 1187453, r=vladan)
toolkit/components/telemetry/docs/environment.rst
--- a/toolkit/components/telemetry/docs/environment.rst
+++ b/toolkit/components/telemetry/docs/environment.rst
@@ -134,17 +134,18 @@ Structure::
               ...
             ],
             // Note: currently only added on Desktop. On Linux, only a single
             // monitor is returned representing the entire virtual screen.
             monitors: [
               {
                 screenWidth: <number>,  // screen width in pixels
                 screenHeight: <number>, // screen height in pixels
-                refreshRate: <number>,  // refresh rate in hertz (present on Windows only)
+                refreshRate: <number>,  // refresh rate in hertz (present on Windows only).
+                                        //  (values <= 1 indicate an unknown value)
                 pseudoDisplay: <bool>,  // networked screen (present on Windows only)
                 scale: <number>,        // backing scale factor (present on Mac only)
               },
               ...
             ],
             features: {
               compositor: <string>,     // Layers backend for compositing (eg "d3d11", "none", "opengl")
 
@@ -156,16 +157,18 @@ Structure::
               //   "disabled"    - User explicitly disabled this default feature.
               //   "failed"      - This feature was attempted but failed to initialize.
               //   "available"   - User has this feature available.
               "d3d11" { // This feature is Windows-only.
                 status: <string>,
                 warp: <bool>,           // Software rendering (WARP) mode was chosen.
                 textureSharing: <bool>  // Whether or not texture sharing works.
                 version: <number>,      // The D3D11 device feature level.
+                blacklisted: <bool>,    // Whether D3D11 is blacklisted; use to see whether WARP
+                                        // was blacklist induced or driver-failure induced.
               },
               "d2d" { // This feature is Windows-only.
                 status: <string>,
                 version: <string>,      // Either "1.0" or "1.1".
               },
             },
           },
       },