Bug 1187879 - Clarify Telemetry pref default behavior in documentation. r=dexter
authorGeorg Fritzsche <georg.fritzsche@googlemail.com>
Tue, 28 Jul 2015 18:05:35 +0200
changeset 255028 72146c45a5902bab7468f6ee5c4a44c0d5dd3175
parent 255027 5c091530338bbc59f74717c4a88754cc18cf7bce
child 255029 f017050afdf21ed44cdf5128a08e5973a226ab8e
push id29127
push userkwierso@gmail.com
push dateWed, 29 Jul 2015 00:53:00 +0000
treeherdermozilla-central@a828e099f0af [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdexter
bugs1187879
milestone42.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1187879 - Clarify Telemetry pref default behavior in documentation. r=dexter
toolkit/components/telemetry/docs/preferences.rst
--- a/toolkit/components/telemetry/docs/preferences.rst
+++ b/toolkit/components/telemetry/docs/preferences.rst
@@ -1,16 +1,22 @@
 Preferences
 ===========
 
 Telemetry behaviour is controlled through the preferences listed here.
 
-*Note:* On official builds (which define ``MOZILLA_OFFICIAL``), Telemetry is only initialized when ``MOZ_TELEMETRY_REPORTING`` is defined.
+Default behaviors
+-----------------
+
+On official builds (which define ``MOZILLA_OFFICIAL``), Telemetry is only initialized when ``MOZ_TELEMETRY_REPORTING`` is defined.
 Sending only happens on official builds with ``MOZ_TELEMETRY_REPORTING`` defined.
 
+Preferences
+-----------
+
 ``toolkit.telemetry.unified``
 
   This controls whether unified behavior is enabled. If true:
 
   * Telemetry is always enabled and recording *base* data.
   * Telemetry will send additional ``main`` pings.
 
 ``toolkit.telemetry.unifiedIsOptIn``
@@ -19,16 +25,20 @@ Sending only happens on official builds 
   Defaults to false & requires a restart.
 
 ``toolkit.telemetry.enabled``
 
   If ``unified`` is off, this controls whether the Telemetry module is enabled.
   If ``unified`` is on, this controls whether to record *extended* data.
   This preference is controlled through the `Preferences` dialog.
 
+  Note that the default value here of this pref depends on the define ``RELEASE_BUILD`` and the channel.
+  If ``RELEASE_BUILD`` is set, ``MOZ_TELEMETRY_ON_BY_DEFAULT`` gets set, which means this pref will default to ``true``.
+  This is overridden by the preferences code on the "beta" channel, the pref also defaults to ``true`` there.
+
 ``datareporting.healthreport.uploadEnabled``
 
   Send the data we record if user has consented to FHR. This preference is controlled through the `Preferences` dialog.
 
 ``toolkit.telemetry.archive.enabled``
 
   Allow pings to be archived locally. This can only be enabled if ``unified`` is on.