Skip to content

Commit 7df1147

Browse files
gireeshpunathilgireeshpunathil
committed
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: nodejs#28121 (comment)
1 parent c6547c5 commit 7df1147

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎doc/api/report.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -519,6 +519,11 @@ includes the date, time, PID and a sequence number. The sequence number helps
519519
in associating the report dump with the runtime state if generated multiple
520520
times for the same Node.js process.
521521

522+
Diagnostic report has an associated single-digit version number (`report.header.reportVersion`),
523+
uniquely representing the report format. The version number is bumped
524+
when new key is added or removed, or the data type of a value is changed.
525+
Current version is 2.
526+
522527
## Configuration
523528

524529
Additional runtime configuration of report generation is available via

0 commit comments

Comments
 (0)