From 790a8b2f22863972088b2879ddfdfa2840b12297 Mon Sep 17 00:00:00 2001 From: Gireesh Punathil Date: Tue, 18 Oct 2022 12:47:12 +0530 Subject: [PATCH] report,doc: define report version semantics Diagnostics report has a version number representing its format, yet its rule is not defined. This doc change specifies the rule. Refs: https://github.com/nodejs/diagnostics/issues/349 Refs: https://github.com/nodejs/node/pull/28121#discussion_r291787263 --- doc/api/report.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/report.md b/doc/api/report.md index cee349d00736fb..0849da82f7a376 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -519,6 +519,11 @@ includes the date, time, PID and a sequence number. The sequence number helps in associating the report dump with the runtime state if generated multiple times for the same Node.js process. +Diagnostic report has an associated single-digit version number (`report.header.reportVersion`), +uniquely representing the report format. The version number is bumped +when new key is added or removed, or the data type of a value is changed. +Report version definitions are consistent across LTS releases. + ## Configuration Additional runtime configuration of report generation is available via