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: nodejs/diagnostics#349 Refs: #28121 (comment) PR-URL: #45050 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
nodejs · Dec 30, 2022 · d9c06d1 · d9c06d1
1 parent 8cc29a3
commit d9c06d1
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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