1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: mark --heap-prof and related flags stable

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/53343
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Ruy Adorno <ruy@vlt.sh>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
This commit is contained in:
Joyee Cheung 2024-06-05 12:17:10 +02:00 committed by Node.js GitHub Bot
parent 206027b2de
commit 673511f3bf
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/api/cli.md
View File

@ -1175,9 +1175,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.
@ -1198,9 +1203,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.
@ -1212,9 +1222,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.
@ -1223,9 +1238,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`.