From 781fa96acd65d2699eefafaf1ad1fe2cc1fcd786 Mon Sep 17 00:00:00 2001
From: Gabriele Svelto <gsvelto@mozilla.com>
Date: Fri, 13 Apr 2018 16:58:04 +0200
Subject: [PATCH] Bug 1453766 - Improve the documentation of the crash ping's
 metadata fields; r=gfritzsche

MozReview-Commit-ID: 6hD7mcKWrkQ

--HG--
extra : rebase_source : f7c5c4bc94f35c19b36abf6e2e5dc63cbb23fab5
---
 toolkit/components/telemetry/docs/data/crash-ping.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/toolkit/components/telemetry/docs/data/crash-ping.rst b/toolkit/components/telemetry/docs/data/crash-ping.rst
index 88e715487554..737ec54c743e 100644
--- a/toolkit/components/telemetry/docs/data/crash-ping.rst
+++ b/toolkit/components/telemetry/docs/data/crash-ping.rst
@@ -51,16 +51,17 @@ Structure:
           BlockedDllList: <list>, // Windows-only, see WindowsDllBlocklist.cpp for details
           BlocklistInitFailed: 1, // Windows-only, present only if the DLL blocklist initialization failed
           CrashTime: <time>, // Seconds since the Epoch
-          ContainsMemoryReport: 1, // Optional
-          EventLoopNestingLevel: <levels>, // Optional, present only if >0
+          ContainsMemoryReport: 1, // Optional, if set indicates that the crash had a memory report attached
+          EventLoopNestingLevel: <levels>, // Optional, present only if >0, indicates the nesting level of the event-loop
           ipc_channel_error: <error string>, // Optional, contains the string processing error reason for an ipc-based content crash
-          IsGarbageCollecting: 1, // Optional, present only if set to 1
+          IsGarbageCollecting: 1, // Optional, if set indicates that the crash occurred while the garbage collector was running
           MozCrashReason: <reason>, // Optional, contains the string passed to MOZ_CRASH()
           OOMAllocationSize: <size>, // Size of the allocation that caused an OOM
           RemoteType: <type>, // Optional, type of content process, see below for a list of types
           SecondsSinceLastCrash: <duration>, // Seconds elapsed since the last crash occurred
           ShutdownProgress: <phase>, // Optional, contains the shutdown phase in which the crash occurred
           SystemMemoryUsePercentage: <percentage>, // Windows-only, percent of memory in use
+          StartupCrash: 1, // Optional, if set indicates that Firefox crashed during startup
           TelemetrySessionId: <id>, // Active telemetry session ID when the crash was recorded
           TextureUsage: <usage>, // Optional, usage of texture memory in bytes
           TotalPageFile: <size>, // Windows-only, paging file in use