Skip to content

Commit 5587d66

Browse files
cjihrigtargos
authored andcommitted
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: nodejs#32242 Fixes: nodejs#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 45c8c2d commit 5587d66

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
@@ -618,6 +618,9 @@ warning will be written to stderr instead.
618618
<!-- YAML
619619
added: v11.8.0
620620
changes:
621+
- version: REPLACEME
622+
pr-url: https://github.com/nodejs/node/pull/32242
623+
description: This option is no longer considered experimental.
621624
- version: v12.0.0
622625
pr-url: https://github.com/nodejs/node/pull/27312
623626
description: Changed from `--diagnostic-report-directory` to
@@ -630,6 +633,9 @@ Location at which the report will be generated.
630633
<!-- YAML
631634
added: v11.8.0
632635
changes:
636+
- version: REPLACEME
637+
pr-url: https://github.com/nodejs/node/pull/32242
638+
description: This option is no longer considered experimental.
633639
- version: v12.0.0
634640
pr-url: https://github.com/nodejs/node/pull/27312
635641
description: changed from `--diagnostic-report-filename` to
@@ -648,6 +654,8 @@ changes:
648654
`--report-on-fatalerror`
649655
-->
650656

657+
> Stability: 1 - Experimental
658+
651659
Enables the report to be triggered on fatal errors (internal errors within
652660
the Node.js runtime such as out of memory) that lead to termination of the
653661
application. Useful to inspect various diagnostic data elements such as heap,
@@ -658,6 +666,9 @@ error.
658666
<!-- YAML
659667
added: v11.8.0
660668
changes:
669+
- version: REPLACEME
670+
pr-url: https://github.com/nodejs/node/pull/32242
671+
description: This option is no longer considered experimental.
661672
- version: v12.0.0
662673
pr-url: https://github.com/nodejs/node/pull/27312
663674
description: changed from `--diagnostic-report-on-signal` to
@@ -672,6 +683,9 @@ specified through `--report-signal`.
672683
<!-- YAML
673684
added: v11.8.0
674685
changes:
686+
- version: REPLACEME
687+
pr-url: https://github.com/nodejs/node/pull/32242
688+
description: This option is no longer considered experimental.
675689
- version: v12.0.0
676690
pr-url: https://github.com/nodejs/node/pull/27312
677691
description: changed from `--diagnostic-report-signal` to
@@ -685,6 +699,9 @@ Default signal is `SIGUSR2`.
685699
<!-- YAML
686700
added: v11.8.0
687701
changes:
702+
- version: REPLACEME
703+
pr-url: https://github.com/nodejs/node/pull/32242
704+
description: This option is no longer considered experimental.
688705
- version: v12.0.0
689706
pr-url: https://github.com/nodejs/node/pull/27312
690707
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
@@ -1755,10 +1755,12 @@ relied upon to exist.
17551755
## `process.report`
17561756
<!-- YAML
17571757
added: v11.8.0
1758+
changes:
1759+
- version: REPLACEME
1760+
pr-url: https://github.com/nodejs/node/pull/32242
1761+
description: This API is no longer considered experimental.
17581762
-->
17591763

1760-
> Stability: 1 - Experimental
1761-
17621764
* {Object}
17631765

17641766
`process.report` is an object whose methods are used to generate diagnostic
@@ -1768,10 +1770,12 @@ reports for the current process. Additional documentation is available in the
17681770
### `process.report.directory`
17691771
<!-- YAML
17701772
added: v11.12.0
1773+
changes:
1774+
- version: REPLACEME
1775+
pr-url: https://github.com/nodejs/node/pull/32242
1776+
description: This API is no longer considered experimental.
17711777
-->
17721778

1773-
> Stability: 1 - Experimental
1774-
17751779
* {string}
17761780

17771781
Directory where the report is written. The default value is the empty string,
@@ -1785,10 +1789,12 @@ console.log(`Report directory is ${process.report.directory}`);
17851789
### `process.report.filename`
17861790
<!-- YAML
17871791
added: v11.12.0
1792+
changes:
1793+
- version: REPLACEME
1794+
pr-url: https://github.com/nodejs/node/pull/32242
1795+
description: This API is no longer considered experimental.
17881796
-->
17891797

1790-
> Stability: 1 - Experimental
1791-
17921798
* {string}
17931799

17941800
Filename where the report is written. If set to the empty string, the output
@@ -1802,10 +1808,12 @@ console.log(`Report filename is ${process.report.filename}`);
18021808
### `process.report.getReport([err])`
18031809
<!-- YAML
18041810
added: v11.8.0
1811+
changes:
1812+
- version: REPLACEME
1813+
pr-url: https://github.com/nodejs/node/pull/32242
1814+
description: This API is no longer considered experimental.
18051815
-->
18061816

1807-
> Stability: 1 - Experimental
1808-
18091817
* `err` {Error} A custom error used for reporting the JavaScript stack.
18101818
* Returns: {Object}
18111819

@@ -1843,10 +1851,12 @@ console.log(`Report on fatal error: ${process.report.reportOnFatalError}`);
18431851
### `process.report.reportOnSignal`
18441852
<!-- YAML
18451853
added: v11.12.0
1854+
changes:
1855+
- version: REPLACEME
1856+
pr-url: https://github.com/nodejs/node/pull/32242
1857+
description: This API is no longer considered experimental.
18461858
-->
18471859

1848-
> Stability: 1 - Experimental
1849-
18501860
* {boolean}
18511861

18521862
If `true`, a diagnostic report is generated when the process receives the
@@ -1859,10 +1869,12 @@ console.log(`Report on signal: ${process.report.reportOnSignal}`);
18591869
### `process.report.reportOnUncaughtException`
18601870
<!-- YAML
18611871
added: v11.12.0
1872+
changes:
1873+
- version: REPLACEME
1874+
pr-url: https://github.com/nodejs/node/pull/32242
1875+
description: This API is no longer considered experimental.
18621876
-->
18631877

1864-
> Stability: 1 - Experimental
1865-
18661878
* {boolean}
18671879

18681880
If `true`, a diagnostic report is generated on uncaught exception.
@@ -1874,10 +1886,12 @@ console.log(`Report on exception: ${process.report.reportOnUncaughtException}`);
18741886
### `process.report.signal`
18751887
<!-- YAML
18761888
added: v11.12.0
1889+
changes:
1890+
- version: REPLACEME
1891+
pr-url: https://github.com/nodejs/node/pull/32242
1892+
description: This API is no longer considered experimental.
18771893
-->
18781894

1879-
> Stability: 1 - Experimental
1880-
18811895
* {string}
18821896

18831897
The signal used to trigger the creation of a diagnostic report. Defaults to
@@ -1890,10 +1904,12 @@ console.log(`Report signal: ${process.report.signal}`);
18901904
### `process.report.writeReport([filename][, err])`
18911905
<!-- YAML
18921906
added: v11.8.0
1907+
changes:
1908+
- version: REPLACEME
1909+
pr-url: https://github.com/nodejs/node/pull/32242
1910+
description: This API is no longer considered experimental.
18931911
-->
18941912

1895-
> Stability: 1 - Experimental
1896-
18971913
* `filename` {string} Name of the file where the report is written. This
18981914
should be a relative path, that will be appended to the directory specified in
18991915
`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)