Skip to content

Commit 66e1dc4

Browse files
gireeshpunathilRafaelGSS
authored andcommitted
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]>
1 parent 36acf8a commit 66e1dc4

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/api/report.md

+5
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,11 @@ includes the date, time, PID, and a sequence number. The sequence number helps
528528
in associating the report dump with the runtime state if generated multiple
529529
times for the same Node.js process.
530530

531+
Diagnostic report has an associated single-digit version number (`report.header.reportVersion`),
532+
uniquely representing the report format. The version number is bumped
533+
when new key is added or removed, or the data type of a value is changed.
534+
Report version definitions are consistent across LTS releases.
535+
531536
## Configuration
532537

533538
Additional runtime configuration of report generation is available via

0 commit comments

Comments
 (0)