Skip to content

Commit

Permalink
doc: mark --heap-prof and related flags stable
Browse files Browse the repository at this point in the history
PR-URL: #53343
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Ruy Adorno <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
  • Loading branch information
joyeecheung authored and targos committed Jun 20, 2024
1 parent 0160745 commit cf375e7
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1173,9 +1173,14 @@ To allow polyfills to be added,

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: https://github.com/nodejs/node/pull/53343
description: The `--heap-prof` flags are now stable.
-->

> Stability: 1 - Experimental
> Stability: 2 - Stable
Starts the V8 heap profiler on start up, and writes the heap profile to disk
before exit.
Expand All @@ -1196,9 +1201,14 @@ Heap.20190409.202950.15293.0.001.heapprofile

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: https://github.com/nodejs/node/pull/53343
description: The `--heap-prof` flags are now stable.
-->

> Stability: 1 - Experimental
> Stability: 2 - Stable
Specify the directory where the heap profiles generated by `--heap-prof` will
be placed.
Expand All @@ -1210,9 +1220,14 @@ The default value is controlled by the

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: https://github.com/nodejs/node/pull/53343
description: The `--heap-prof` flags are now stable.
-->

> Stability: 1 - Experimental
> Stability: 2 - Stable
Specify the average sampling interval in bytes for the heap profiles generated
by `--heap-prof`. The default is 512 \* 1024 bytes.
Expand All @@ -1221,9 +1236,14 @@ by `--heap-prof`. The default is 512 \* 1024 bytes.

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: https://github.com/nodejs/node/pull/53343
description: The `--heap-prof` flags are now stable.
-->

> Stability: 1 - Experimental
> Stability: 2 - Stable
Specify the file name of the heap profile generated by `--heap-prof`.

Expand Down

0 comments on commit cf375e7

Please sign in to comment.