Bug 1244295 - Add regression warning to ClientID.jsm getClientID method. r=gfritzsche

MozReview-Commit-ID: Eci1sG9HPem
This commit is contained in:
Michael Comella 2016-02-17 15:31:26 -08:00
parent 7588564b44
commit 66c9b2211c

View File

@ -48,6 +48,11 @@ this.ClientID = Object.freeze({
* data reporting (FHR & Telemetry). Previously exising FHR client IDs are
* migrated to this.
*
* WARNING: This functionality is duplicated for Android (see GeckoProfile.getClientId
* for more). There are Java tests (TestGeckoProfile) to ensure the functionality is
* consistent and Gecko tests to come (bug 1249156). However, THIS IS NOT FOOLPROOF.
* Be careful when changing this code and, in particular, the underlying file format.
*
* @return {Promise<string>} The stable client ID.
*/
getClientID: function() {