From c492be1f5ab38ed86ae228022b47ae7361fe410c Mon Sep 17 00:00:00 2001 From: Georg Fritzsche Date: Tue, 28 Jul 2015 18:05:35 +0200 Subject: [PATCH] Bug 1187879 - Clarify Telemetry pref default behavior in documentation. r=dexter --- toolkit/components/telemetry/docs/preferences.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/toolkit/components/telemetry/docs/preferences.rst b/toolkit/components/telemetry/docs/preferences.rst index ddcba12bb3f2..967a32ce54d7 100644 --- a/toolkit/components/telemetry/docs/preferences.rst +++ b/toolkit/components/telemetry/docs/preferences.rst @@ -3,9 +3,15 @@ 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: @@ -24,6 +30,10 @@ Sending only happens on official builds with ``MOZ_TELEMETRY_REPORTING`` defined 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.