Skip to content

Commit

Permalink
doc: mark --heap-prof and related flags stable
Browse files Browse the repository at this point in the history
  • Loading branch information
joyeecheung committed Jun 5, 2024
1 parent 56db8c2 commit 1bcba64
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 @@ -1158,9 +1158,14 @@ To allow polyfills to be added,

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: REPLACEME
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 @@ -1181,9 +1186,14 @@ Heap.20190409.202950.15293.0.001.heapprofile

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: REPLACEME
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 @@ -1195,9 +1205,14 @@ The default value is controlled by the

<!-- YAML
added: v12.4.0
changes:
- version:

Check warning on line 1209 in doc/api/cli.md

View workflow job for this annotation

GitHub Actions / lint-pr-url

pr-url doesn't match the URL of the current PR.
- REPLACEME
pr-url: REPLACEME
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 @@ -1206,9 +1221,14 @@ by `--heap-prof`. The default is 512 \* 1024 bytes.

<!-- YAML
added: v12.4.0
changes:
- version:
- REPLACEME
pr-url: REPLACEME
description: The `--heap-prof` flags are now stable.

Check warning on line 1228 in doc/api/cli.md

View workflow job for this annotation

GitHub Actions / lint-pr-url

pr-url doesn't match the URL of the current PR.
-->

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

Expand Down

0 comments on commit 1bcba64

Please sign in to comment.