bug 1404343 - Document the "DEFAULTPREF_VALUE" policy for userPrefs r?Dexter draft
authorChris H-C <chutten@mozilla.com>
Thu, 23 Nov 2017 15:29:37 -0500
changeset 702787 e1f678e2a0e2c73d4c33e62ee454f56db699ddb2
parent 702786 ee164c0bec840acb88f9a9f49dfede3231d82f36
child 741586 3cd594ce98919685c51af03d54a8ea7db200e552
push id90618
push userbmo:chutten@mozilla.com
push dateThu, 23 Nov 2017 20:31:20 +0000
reviewersDexter
bugs1404343
milestone59.0a1
bug 1404343 - Document the "DEFAULTPREF_VALUE" policy for userPrefs r?Dexter MozReview-Commit-ID: 4AMTgZGOZ3x
toolkit/components/telemetry/docs/data/environment.rst
--- a/toolkit/components/telemetry/docs/data/environment.rst
+++ b/toolkit/components/telemetry/docs/data/environment.rst
@@ -50,18 +50,17 @@ Structure:
         telemetryEnabled: <bool>, // false on failure
         locale: <string>, // e.g. "it", null on failure
         update: {
           channel: <string>, // e.g. "release", null on failure
           enabled: <bool>, // true on failure
           autoDownload: <bool>, // true on failure
         },
         userPrefs: {
-          // Only prefs which are changed from the default value are listed
-          // in this block
+          // Only prefs which are changed are listed in this block
           "pref.name.value": value // some prefs send the value
           "pref.name.url": "<user-set>" // For some privacy-sensitive prefs
             // only the fact that the value has been changed is recorded
         },
         attribution: { // optional, only present if the installation has attribution data
           // all of these values are optional.
           source: <string>, // referring partner domain, when install happens via a known partner
           medium: <string>, // category of the source, such as "organic" for a search engine
@@ -327,17 +326,17 @@ searchCohort
 
 If the user has been enrolled into a search default change experiment, this contains the string identifying the experiment the user is taking part in. Most user profiles will never be part of any search default change experiment, and will not send this value.
 
 userPrefs
 ~~~~~~~~~
 
 This object contains user preferences.
 
-Each key in the object is the name of a preference. A key's value depends on the policy with which the preference was collected. There are two such policies, "value" and "state". For preferences collected under the "value" policy, the value will be the preference's value. For preferences collected under the "state" policy, the value will be an opaque marker signifying only that the preference has a user value. The "state" policy is therefore used when user privacy is a concern.
+Each key in the object is the name of a preference. A key's value depends on the policy with which the preference was collected. There are three such policies, "value", "state", and "default value". For preferences collected under the "value" policy, the value will be the preference's value. For preferences collected under the "state" policy, the value will be an opaque marker signifying only that the preference has a user value. The "state" policy is therefore used when user privacy is a concern. For preferences collected under the "default value" policy, the value will be the preference's default value, if the preference exists. If the preference does not exist, there is no key or value.
 
 The following is a partial list of collected preferences.
 
 - ``browser.search.suggest.enabled``: The "master switch" for search suggestions everywhere in Firefox (search bar, urlbar, etc.). Defaults to true.
 
 - ``browser.urlbar.suggest.searches``: True if search suggestions are enabled in the urlbar. Defaults to false.
 
 - ``browser.urlbar.userMadeSearchSuggestionsChoice``: True if the user has clicked Yes or No in the urlbar's opt-in notification. Defaults to false.