lib: replace --diagnostic-report-* with --report-* · nodejs/node@94adfe9 (original) (raw)

`` @@ -106,57 +106,6 @@ should be written to. When used alone, it implies --cpu-prof.

``

106

106

`$ node --cpu-prof-path /tmp/test.cpuprofile index.js

`

107

107

```` ```


`108`

`108`

``

`109`

``

`` -

### `--diagnostic-report-directory=directory`

``

`110`

``

`-

<!-- YAML

`

`111`

``

`-

added: v11.8.0

`

`112`

``

`-

-->

`

`113`

``

`-`

`114`

``

`-

Location at which the report will be generated.

`

`115`

``

`-`

`116`

``

`` -

### `--diagnostic-report-filename=filename`

``

`117`

``

`-

<!-- YAML

`

`118`

``

`-

added: v11.8.0

`

`119`

``

`-

-->

`

`120`

``

`-`

`121`

``

`-

Name of the file to which the report will be written.

`

`122`

``

`-`

`123`

``

`` -

### `--diagnostic-report-on-fatalerror`

``

`124`

``

`-

<!-- YAML

`

`125`

``

`-

added: v11.8.0

`

`126`

``

`-

-->

`

`127`

``

`-`

`128`

``

`-

Enables the report to be triggered on fatal errors (internal errors within

`

`129`

``

`-

the Node.js runtime such as out of memory) that lead to termination of the

`

`130`

``

`` -

application, if `--experimental-report` is enabled. Useful to inspect various

``

`131`

``

`-

diagnostic data elements such as heap, stack, event loop state, resource

`

`132`

``

`-

consumption etc. to reason about the fatal error.

`

`133`

``

`-`

`134`

``

`` -

### `--diagnostic-report-on-signal`

``

`135`

``

`-

<!-- YAML

`

`136`

``

`-

added: v11.8.0

`

`137`

``

`-

-->

`

`138`

``

`-`

`139`

``

`-

Enables report to be generated upon receiving the specified (or predefined)

`

`140`

``

`` -

signal to the running Node.js process, if `--experimental-report` is enabled.

``

`141`

``

`` -

The signal to trigger the report is specified through `--diagnostic-report-signal`.

``

`142`

``

`-`

`143`

``

`` -

### `--diagnostic-report-signal=signal`

``

`144`

``

`-

<!-- YAML

`

`145`

``

`-

added: v11.8.0

`

`146`

``

`-

-->

`

`147`

``

`-`

`148`

``

`-

Sets or resets the signal for report generation (not supported on Windows).

`

`149`

``

`` -

Default signal is `SIGUSR2`.

``

`150`

``

`-`

`151`

``

`` -

### `--diagnostic-report-uncaught-exception`

``

`152`

``

`-

<!-- YAML

`

`153`

``

`-

added: v11.8.0

`

`154`

``

`-

-->

`

`155`

``

`-`

`156`

``

`-

Enables report to be generated on un-caught exceptions, if

`

`157`

``

`` -

`--experimental-report` is enabled. Useful when inspecting JavaScript stack in

``

`158`

``

`-

conjunction with native stack and other runtime environment data.

`

`159`

``

`-`

`160`

`109`

`` ### `--enable-fips`

``

`161`

`110`

`<!-- YAML

`

`162`

`111`

`added: v6.0.0

`

`@@ -492,6 +441,87 @@ file will be created if it does not exist, and will be appended to if it does.

`

`492`

`441`

`If an error occurs while attempting to write the warning to the file, the

`

`493`

`442`

`warning will be written to stderr instead.

`

`494`

`443`

``

``

`444`

`` +

### `--report-directory=directory`

``

``

`445`

`+

<!-- YAML

`

``

`446`

`+

added: v11.8.0

`

``

`447`

`+

changes:

`

``

`448`

`+

- version: REPLACEME

`

``

`449`

`+

pr-url: https://github.com/nodejs/node/pull/27312

`

``

`450`

`` +

description: Changed from `--diagnostic-report-directory` to

``

``

`451`

`` +

`--report-directory`

``

``

`452`

`+

-->

`

``

`453`

`+`

``

`454`

`+

Location at which the report will be generated.

`

``

`455`

`+`

``

`456`

`` +

### `--report-filename=filename`

``

``

`457`

`+

<!-- YAML

`

``

`458`

`+

added: v11.8.0

`

``

`459`

`+

changes:

`

``

`460`

`+

- version: REPLACEME

`

``

`461`

`+

pr-url: https://github.com/nodejs/node/pull/27312

`

``

`462`

`` +

description: changed from `--diagnostic-report-filename` to

``

``

`463`

`` +

`--report-filename`

``

``

`464`

`+

-->

`

``

`465`

`+`

``

`466`

`+

Name of the file to which the report will be written.

`

``

`467`

`+`

``

`468`

`` +

### `--report-on-fatalerror`

``

``

`469`

`+

<!-- YAML

`

``

`470`

`+

added: v11.8.0

`

``

`471`

`+

changes:

`

``

`472`

`+

- version: REPLACEME

`

``

`473`

`+

pr-url: https://github.com/nodejs/node/pull/27312

`

``

`474`

`` +

description: changed from `--diagnostic-report-on-fatalerror` to

``

``

`475`

`` +

`--report-on-fatalerror`

``

``

`476`

`+

-->

`

``

`477`

`+`

``

`478`

`+

Enables the report to be triggered on fatal errors (internal errors within

`

``

`479`

`+

the Node.js runtime such as out of memory) that lead to termination of the

`

``

`480`

`` +

application, if `--experimental-report` is enabled. Useful to inspect various

``

``

`481`

`+

diagnostic data elements such as heap, stack, event loop state, resource

`

``

`482`

`+

consumption etc. to reason about the fatal error.

`

``

`483`

`+`

``

`484`

`` +

### `--report-on-signal`

``

``

`485`

`+

<!-- YAML

`

``

`486`

`+

added: v11.8.0

`

``

`487`

`+

changes:

`

``

`488`

`+

- version: REPLACEME

`

``

`489`

`+

pr-url: https://github.com/nodejs/node/pull/27312

`

``

`490`

`` +

description: changed from `--diagnostic-report-on-signal` to

``

``

`491`

`` +

`--report-on-signal`

``

``

`492`

`+

-->

`

``

`493`

`+`

``

`494`

`+

Enables report to be generated upon receiving the specified (or predefined)

`

``

`495`

`` +

signal to the running Node.js process, if `--experimental-report` is enabled.

``

``

`496`

`` +

The signal to trigger the report is specified through `--report-signal`.

``

``

`497`

`+`

``

`498`

`` +

### `--report-signal=signal`

``

``

`499`

`+

<!-- YAML

`

``

`500`

`+

added: v11.8.0

`

``

`501`

`+

changes:

`

``

`502`

`+

- version: REPLACEME

`

``

`503`

`+

pr-url: https://github.com/nodejs/node/pull/27312

`

``

`504`

`` +

description: changed from `--diagnostic-report-signal` to

``

``

`505`

`` +

`--report-signal`

``

``

`506`

`+

-->

`

``

`507`

`+`

``

`508`

`+

Sets or resets the signal for report generation (not supported on Windows).

`

``

`509`

`` +

Default signal is `SIGUSR2`.

``

``

`510`

`+`

``

`511`

`` +

### `--report-uncaught-exception`

``

``

`512`

`+

<!-- YAML

`

``

`513`

`+

added: v11.8.0

`

``

`514`

`+

changes:

`

``

`515`

`+

- version: REPLACEME

`

``

`516`

`+

pr-url: https://github.com/nodejs/node/pull/27312

`

``

`517`

`` +

description: changed from `--diagnostic-report-uncaught-exception` to

``

``

`518`

`` +

`--report-uncaught-exception`

``

``

`519`

`+

-->

`

``

`520`

`+`

``

`521`

`+

Enables report to be generated on un-caught exceptions, if

`

``

`522`

`` +

`--experimental-report` is enabled. Useful when inspecting JavaScript stack in

``

``

`523`

`+

conjunction with native stack and other runtime environment data.

`

``

`524`

`+`

`495`

`525`

`` ### `--throw-deprecation`

``

`496`

`526`

`<!-- YAML

`

`497`

`527`

`added: v0.11.14

`

`@@ -813,12 +843,12 @@ In case an option value happens to contain a space (for example a path listed in

`

`813`

`843`

```` ```

814

844

``

815

845

`Node.js options that are allowed are:

`

816

``

`` -

``

817

``

`` -

``

818

``

`` -

``

819

``

`` -

``

820

``

`` -

``

821

``

`` -

``

``

846

`` +

``

``

847

`` +

``

``

848

`` +

``

``

849

`` +

``

``

850

`` +

``

``

851

`` +

``

822

852

`` - --enable-fips

``

823

853

`` - --experimental-modules

``

824

854

`` - --experimental-repl-await

``