From 49da5cd0ee8297125b67c66b8d6efeb3fdc73aef Mon Sep 17 00:00:00 2001 From: Gireesh Punathil Date: Fri, 21 Oct 2022 14:59:14 +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 PR-URL: https://github.com/nodejs/node/pull/45050 Reviewed-By: Rafael Gonzaga Reviewed-By: Richard Lau Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Chengzhong Wu Reviewed-By: Michael Dawson --- doc/api/report.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/report.md b/doc/api/report.md index 6d5341a59a2f4b..f39e55b53e42cf 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -528,6 +528,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