FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: update stability of report features · nodejs/node@2e1fb2b · GitHub

/ node Public

Commit 2e1fb2b

Browse files
cjihrig
authored and
MylesBorins
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 <riclau@uk.ibm.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
1 parent cd388b2 commit 2e1fb2b

3 files changed

Lines changed: 50 additions & 17 deletions

File tree

‎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
@@ -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)
Back | FazBrowse Home | New Git URL