Skip to content

Commit a022d38

Browse files
committed
doc: update stability of report features
This commit updates the stability documentation for the report feature. All diagnostic report APIs are now listed as stable, with the exception of report-on-fatalerror, which still has a few bugs to work out. PR-URL: #32242 Fixes: #26293 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
1 parent 9d1a3b6 commit a022d38

File tree

3 files changed

+50
-17
lines changed

3 files changed

+50
-17
lines changed

doc/api/cli.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,9 @@ warning will be written to stderr instead.
596596
<!-- YAML
597597
added: v11.8.0
598598
changes:
599+
- version: REPLACEME
600+
pr-url: https://github.com/nodejs/node/pull/32242
601+
description: This option is no longer considered experimental.
599602
- version: v12.0.0
600603
pr-url: https://github.com/nodejs/node/pull/27312
601604
description: Changed from `--diagnostic-report-directory` to
@@ -608,6 +611,9 @@ Location at which the report will be generated.
608611
<!-- YAML
609612
added: v11.8.0
610613
changes:
614+
- version: REPLACEME
615+
pr-url: https://github.com/nodejs/node/pull/32242
616+
description: This option is no longer considered experimental.
611617
- version: v12.0.0
612618
pr-url: https://github.com/nodejs/node/pull/27312
613619
description: changed from `--diagnostic-report-filename` to
@@ -626,6 +632,8 @@ changes:
626632
`--report-on-fatalerror`
627633
-->
628634

635+
> Stability: 1 - Experimental
636+
629637
Enables the report to be triggered on fatal errors (internal errors within
630638
the Node.js runtime such as out of memory) that lead to termination of the
631639
application. Useful to inspect various diagnostic data elements such as heap,
@@ -636,6 +644,9 @@ error.
636644
<!-- YAML
637645
added: v11.8.0
638646
changes:
647+
- version: REPLACEME
648+
pr-url: https://github.com/nodejs/node/pull/32242
649+
description: This option is no longer considered experimental.
639650
- version: v12.0.0
640651
pr-url: https://github.com/nodejs/node/pull/27312
641652
description: changed from `--diagnostic-report-on-signal` to
@@ -650,6 +661,9 @@ specified through `--report-signal`.
650661
<!-- YAML
651662
added: v11.8.0
652663
changes:
664+
- version: REPLACEME
665+
pr-url: https://github.com/nodejs/node/pull/32242
666+
description: This option is no longer considered experimental.
653667
- version: v12.0.0
654668
pr-url: https://github.com/nodejs/node/pull/27312
655669
description: changed from `--diagnostic-report-signal` to
@@ -663,6 +677,9 @@ Default signal is `SIGUSR2`.
663677
<!-- YAML
664678
added: v11.8.0
665679
changes:
680+
- version: REPLACEME
681+
pr-url: https://github.com/nodejs/node/pull/32242
682+
description: This option is no longer considered experimental.
666683
- version: v12.0.0
667684
pr-url: https://github.com/nodejs/node/pull/27312
668685
description: changed from `--diagnostic-report-uncaught-exception` to

doc/api/process.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1783,10 +1783,12 @@ relied upon to exist.
17831783
## `process.report`
17841784
<!-- YAML
17851785
added: v11.8.0
1786+
changes:
1787+
- version: REPLACEME
1788+
pr-url: https://github.com/nodejs/node/pull/32242
1789+
description: This API is no longer considered experimental.
17861790
-->
17871791

1788-
> Stability: 1 - Experimental
1789-
17901792
* {Object}
17911793

17921794
`process.report` is an object whose methods are used to generate diagnostic
@@ -1796,10 +1798,12 @@ reports for the current process. Additional documentation is available in the
17961798
### `process.report.directory`
17971799
<!-- YAML
17981800
added: v11.12.0
1801+
changes:
1802+
- version: REPLACEME
1803+
pr-url: https://github.com/nodejs/node/pull/32242
1804+
description: This API is no longer considered experimental.
17991805
-->
18001806

1801-
> Stability: 1 - Experimental
1802-
18031807
* {string}
18041808

18051809
Directory where the report is written. The default value is the empty string,
@@ -1813,10 +1817,12 @@ console.log(`Report directory is ${process.report.directory}`);
18131817
### `process.report.filename`
18141818
<!-- YAML
18151819
added: v11.12.0
1820+
changes:
1821+
- version: REPLACEME
1822+
pr-url: https://github.com/nodejs/node/pull/32242
1823+
description: This API is no longer considered experimental.
18161824
-->
18171825

1818-
> Stability: 1 - Experimental
1819-
18201826
* {string}
18211827

18221828
Filename where the report is written. If set to the empty string, the output
@@ -1830,10 +1836,12 @@ console.log(`Report filename is ${process.report.filename}`);
18301836
### `process.report.getReport([err])`
18311837
<!-- YAML
18321838
added: v11.8.0
1839+
changes:
1840+
- version: REPLACEME
1841+
pr-url: https://github.com/nodejs/node/pull/32242
1842+
description: This API is no longer considered experimental.
18331843
-->
18341844

1835-
> Stability: 1 - Experimental
1836-
18371845
* `err` {Error} A custom error used for reporting the JavaScript stack.
18381846
* Returns: {Object}
18391847

@@ -1871,10 +1879,12 @@ console.log(`Report on fatal error: ${process.report.reportOnFatalError}`);
18711879
### `process.report.reportOnSignal`
18721880
<!-- YAML
18731881
added: v11.12.0
1882+
changes:
1883+
- version: REPLACEME
1884+
pr-url: https://github.com/nodejs/node/pull/32242
1885+
description: This API is no longer considered experimental.
18741886
-->
18751887

1876-
> Stability: 1 - Experimental
1877-
18781888
* {boolean}
18791889

18801890
If `true`, a diagnostic report is generated when the process receives the
@@ -1887,10 +1897,12 @@ console.log(`Report on signal: ${process.report.reportOnSignal}`);
18871897
### `process.report.reportOnUncaughtException`
18881898
<!-- YAML
18891899
added: v11.12.0
1900+
changes:
1901+
- version: REPLACEME
1902+
pr-url: https://github.com/nodejs/node/pull/32242
1903+
description: This API is no longer considered experimental.
18901904
-->
18911905

1892-
> Stability: 1 - Experimental
1893-
18941906
* {boolean}
18951907

18961908
If `true`, a diagnostic report is generated on uncaught exception.
@@ -1902,10 +1914,12 @@ console.log(`Report on exception: ${process.report.reportOnUncaughtException}`);
19021914
### `process.report.signal`
19031915
<!-- YAML
19041916
added: v11.12.0
1917+
changes:
1918+
- version: REPLACEME
1919+
pr-url: https://github.com/nodejs/node/pull/32242
1920+
description: This API is no longer considered experimental.
19051921
-->
19061922

1907-
> Stability: 1 - Experimental
1908-
19091923
* {string}
19101924

19111925
The signal used to trigger the creation of a diagnostic report. Defaults to
@@ -1918,10 +1932,12 @@ console.log(`Report signal: ${process.report.signal}`);
19181932
### `process.report.writeReport([filename][, err])`
19191933
<!-- YAML
19201934
added: v11.8.0
1935+
changes:
1936+
- version: REPLACEME
1937+
pr-url: https://github.com/nodejs/node/pull/32242
1938+
description: This API is no longer considered experimental.
19211939
-->
19221940

1923-
> Stability: 1 - Experimental
1924-
19251941
* `filename` {string} Name of the file where the report is written. This
19261942
should be a relative path, that will be appended to the directory specified in
19271943
`process.report.directory`, or the current working directory of the Node.js

doc/api/report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!--introduced_in=v11.8.0-->
44
<!-- type=misc -->
55

6-
> Stability: 1 - Experimental
6+
> Stability: 2 - Stable
77
88
<!-- name=report -->
99

0 commit comments

Comments
 (0)