Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-13 21:35:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1187879 - Clarify Telemetry pref default behavior in documentation. r=dexter

Browse Source
This commit is contained in:
Georg Fritzsche 2015-07-28 18:05:35 +02:00
parent 3e1cc635e6
commit c492be1f5a
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
toolkit/components/telemetry/docs/preferences.rst
View File

@ -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.