Revert "Bug 1363725 - Change inconsistent occurrence of 'all_child', 'all_childs' to 'all_children' and 'AllChilds' to 'AllChildren' in code and docs." r?Dexter draft
authorChris H-C <chutten@mozilla.com>
Fri, 12 Jan 2018 10:37:02 -0500
changeset 719666 6dd3693967f6977baaabb5595d92ec63dcb98736
parent 719593 d2edd256c3aadb1cea48da0c8f62f725bd53cb76
child 745863 36463324e71e5a23aa58f84d1e4405f0c78723f5
push id95327
push userbmo:chutten@mozilla.com
push dateFri, 12 Jan 2018 15:38:13 +0000
reviewersDexter
bugs1363725
milestone59.0a1
Revert "Bug 1363725 - Change inconsistent occurrence of 'all_child', 'all_childs' to 'all_children' and 'AllChilds' to 'AllChildren' in code and docs." r?Dexter This reverts commit c238437964d1bfedd389ae72fd0da0f5f119211a. It caused upstream processing headaches. We'll need to address those before relanding. MozReview-Commit-ID: Ae2d8iMPQuz
toolkit/components/telemetry/Histograms.json
toolkit/components/telemetry/Scalars.yaml
toolkit/components/telemetry/TelemetryCommon.cpp
toolkit/components/telemetry/TelemetryCommon.h
toolkit/components/telemetry/docs/collection/events.rst
toolkit/components/telemetry/docs/collection/histograms.rst
toolkit/components/telemetry/docs/collection/scalars.rst
toolkit/components/telemetry/shared_telemetry_utils.py
--- a/toolkit/components/telemetry/Histograms.json
+++ b/toolkit/components/telemetry/Histograms.json
@@ -7761,17 +7761,17 @@
     "kind": "linear",
     "low": 1,
     "high": 10000,
     "n_buckets": 10,
     "bug_numbers": [1335343],
     "description": "a testing histogram; not meant to be touched"
   },
   "TELEMETRY_TEST_ALL_CHILD_PROCESSES": {
-    "record_in_processes": ["all_children"],
+    "record_in_processes": ["all_childs"],
     "alert_emails": ["telemetry-client-dev@mozilla.com"],
     "expires_in_version": "never",
     "kind": "linear",
     "low": 1,
     "high": 10000,
     "n_buckets": 10,
     "bug_numbers": [1335343],
     "description": "a testing histogram; not meant to be touched"
--- a/toolkit/components/telemetry/Scalars.yaml
+++ b/toolkit/components/telemetry/Scalars.yaml
@@ -1024,65 +1024,65 @@ telemetry.discarded:
     description: >
       Number of discarded accumulations to histograms in child processes
     expires: "never"
     kind: uint
     notification_emails:
       - telemetry-client-dev@mozilla.com
     release_channel_collection: opt-out
     record_in_processes:
-      - 'all_children'
+      - 'all_childs'
   keyed_accumulations:
     bug_numbers:
       - 1369041
     description: >
       Number of discarded accumulations to keyed histograms in child processes
     expires: "never"
     kind: uint
     notification_emails:
       - telemetry-client-dev@mozilla.com
     release_channel_collection: opt-out
     record_in_processes:
-      - 'all_children'
+      - 'all_childs'
   scalar_actions:
     bug_numbers:
       - 1369041
     description: >
       Number of discarded actions on scalars in child processes
     expires: "never"
     kind: uint
     notification_emails:
       - telemetry-client-dev@mozilla.com
     release_channel_collection: opt-out
     record_in_processes:
-      - 'all_children'
+      - 'all_childs'
   keyed_scalar_actions:
     bug_numbers:
       - 1369041
     description: >
       Number of discarded actions on keyed scalars in child processes
     expires: "never"
     kind: uint
     notification_emails:
       - telemetry-client-dev@mozilla.com
     release_channel_collection: opt-out
     record_in_processes:
-      - 'all_children'
+      - 'all_childs'
   child_events:
     bug_numbers:
       - 1369041
     description: >
       Number of discarded events in child processes
     expires: "never"
     kind: uint
     notification_emails:
       - telemetry-client-dev@mozilla.com
     release_channel_collection: opt-out
     record_in_processes:
-      - 'all_children'
+      - 'all_childs'
 
 # The following section contains graphics-related scalars.
 gfx.advanced.layers:
   failure_id:
     bug_numbers:
       - 1365879
     description: >
       Each key is a failure for initializing Advanced Layers, and each value
@@ -1532,13 +1532,13 @@ telemetry.test:
     bug_numbers:
       - 1278556
     description: A testing string scalar; not meant to be touched.
     expires: never
     kind: string
     notification_emails:
       - telemetry-client-dev@mozilla.com
     record_in_processes:
-      - 'all_children'
+      - 'all_childs'
 
 # NOTE: Please don't add new definitions below this point. Consider adding
 # them earlier in the file and leave the telemetry.test category as the last
 # one for readability.
--- a/toolkit/components/telemetry/TelemetryCommon.cpp
+++ b/toolkit/components/telemetry/TelemetryCommon.cpp
@@ -65,23 +65,23 @@ CanRecordDataset(uint32_t aDataset, bool
   // We're not recording extended telemetry or this is not the base
   // dataset. Bail out.
   return false;
 }
 
 bool
 CanRecordInProcess(RecordedProcessType processes, GeckoProcessType processType)
 {
-  bool recordAllChildren = !!(processes & RecordedProcessType::AllChildren);
+  bool recordAllChild = !!(processes & RecordedProcessType::AllChilds);
   // We can use (1 << ProcessType) due to the way RecordedProcessType is defined.
   bool canRecordProcess =
     !!(processes & static_cast<RecordedProcessType>(1 << processType));
 
   return canRecordProcess ||
-         ((processType != GeckoProcessType_Default) && recordAllChildren);
+         ((processType != GeckoProcessType_Default) && recordAllChild);
 }
 
 bool
 CanRecordInProcess(RecordedProcessType processes, ProcessID processId)
 {
   return CanRecordInProcess(processes, GetGeckoProcessType(processId));
 }
 
--- a/toolkit/components/telemetry/TelemetryCommon.h
+++ b/toolkit/components/telemetry/TelemetryCommon.h
@@ -13,21 +13,21 @@
 #include "mozilla/TypedEnumBits.h"
 #include "mozilla/TelemetryProcessEnums.h"
 
 namespace mozilla {
 namespace Telemetry {
 namespace Common {
 
 enum class RecordedProcessType : uint32_t {
-  Main         = (1 << GeckoProcessType_Default),  // Also known as "parent process"
-  Content      = (1 << GeckoProcessType_Content),
-  Gpu          = (1 << GeckoProcessType_GPU),
-  AllChildren  = 0xFFFFFFFF - 1,  // All the child processes (i.e. content, gpu, ...)
-  All          = 0xFFFFFFFF       // All the processes
+  Main       = (1 << GeckoProcessType_Default),  // Also known as "parent process"
+  Content    = (1 << GeckoProcessType_Content),
+  Gpu        = (1 << GeckoProcessType_GPU),
+  AllChilds  = 0xFFFFFFFF - 1,  // All the children processes (i.e. content, gpu, ...)
+  All        = 0xFFFFFFFF       // All the processes
 };
 MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(RecordedProcessType);
 
 template<class EntryType>
 class AutoHashtable : public nsTHashtable<EntryType>
 {
 public:
   explicit AutoHashtable(uint32_t initLength =
--- a/toolkit/components/telemetry/docs/collection/events.rst
+++ b/toolkit/components/telemetry/docs/collection/events.rst
@@ -100,17 +100,17 @@ The following event properties are valid
 - ``objects`` *(required, list of strings)*: The valid event objects.
 - ``description`` *(required, string)*: Description of the event and its semantics.
 - ``release_channel_collection`` *(optional, string)*: This can be set to ``opt-in`` (default) or ``opt-out``.
 - ``record_in_processes`` *(required, list of strings)*: A list of processes the event can be recorded in. Currently supported values are:
 
   - ``main``
   - ``content``
   - ``gpu``
-  - ``all_children`` (record in all the child processes)
+  - ``all_child`` (record in all the child processes)
   - ``all`` (record in all the processes).
 
 - ``bug_numbers`` *(required, list of numbers)*: A list of Bugzilla bug numbers that are relevant to this event.
 - ``notification_emails`` *(required, list of strings)*: A list of emails of owners for this event. This is used for contact for data reviews and potentially to email alerts.
 - expiry: There are two properties that can specify expiry, at least one needs to be set:
 
   - ``expiry_version`` *(string)*: The version number in which the event expires, e.g. ``"50"``, or ``"never"``. A version number of type "N" and "N.0" is automatically converted to "N.0a1" in order to expire the event also in the development channels. For events that never expire the value ``never`` can be used.
 
--- a/toolkit/components/telemetry/docs/collection/histograms.rst
+++ b/toolkit/components/telemetry/docs/collection/histograms.rst
@@ -125,17 +125,17 @@ The possible fields in a histogram decla
 
 ``record_in_processes``
 -----------------------
 Required. This field is a list of processes this histogram can be recorded in. Currently-supported values are:
 
 - ``main``
 - ``content``
 - ``gpu``
-- ``all_children`` (record in all child processes)
+- ``all_childs`` (record in all child processes)
 - ``all`` (record in all processes)
 
 ``alert_emails``
 ----------------
 Required. This field is a list of e-mail addresses that should be notified when the distribution of the histogram changes significantly from one build-id to the other. This can be useful to detect regressions. Note that all alerts will be sent automatically to mozilla.dev.telemetry-alerts.
 
 ``expires_in_version``
 ----------------------
--- a/toolkit/components/telemetry/docs/collection/scalars.rst
+++ b/toolkit/components/telemetry/docs/collection/scalars.rst
@@ -152,17 +152,17 @@ Required Fields
 - ``expires``: The version number in which the scalar expires, e.g. "30"; a version number of type "N" and "N.0" is automatically converted to "N.0a1" in order to expire the scalar also in the development channels. A telemetry probe acting on an expired scalar will print a warning into the browser console. For scalars that never expire the value ``never`` can be used.
 - ``kind``: A string representing the scalar type. Allowed values are ``uint``, ``string`` and ``boolean``.
 - ``notification_emails``: A list of email addresses to notify with alerts of expiring probes. More importantly, these are used by the data steward to verify that the probe is still useful.
 - ``record_in_processes``: A list of processes the scalar is allowed to record in. Currently supported values are:
 
   - ``main``;
   - ``content``;
   - ``gpu``;
-  - ``all_children`` (record in all the child processes);
+  - ``all_child`` (record in all the child processes);
   - ``all`` (record in all the processes).
 
 Optional Fields
 ---------------
 
 - ``cpp_guard``: A string that gets inserted as an ``#ifdef`` directive around the automatically generated C++ declaration. This is typically used for platform-specific scalars, e.g. ``ANDROID``.
 - ``release_channel_collection``: This can be either ``opt-in`` (default) or ``opt-out``. With the former the scalar is submitted by default on pre-release channels, unless the user has opted out. With the latter the scalar is submitted by default on release and pre-release channels, unless the user has opted out.
 - ``keyed``: A boolean that determines whether this is a keyed scalar. It defaults to ``False``.
--- a/toolkit/components/telemetry/shared_telemetry_utils.py
+++ b/toolkit/components/telemetry/shared_telemetry_utils.py
@@ -10,17 +10,17 @@ from __future__ import print_function
 import re
 import yaml
 import sys
 
 # This is a list of flags that determine which process a measurement is allowed
 # to record from.
 KNOWN_PROCESS_FLAGS = {
     'all': 'All',
-    'all_children': 'AllChildren',
+    'all_childs': 'AllChilds',
     'main': 'Main',
     'content': 'Content',
     'gpu': 'Gpu',
 }
 
 PROCESS_ENUM_PREFIX = "mozilla::Telemetry::Common::RecordedProcessType::"