Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: mark --cpu-prof and --heap-prof as stable #53343

Closed
wants to merge 2 commits into from
Closed

doc: mark --cpu-prof and --heap-prof as stable #53343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51acf22
doc: mark --cpu-prof and related flags stable
joyeecheung Jun 5, 2024
4dda1e7
doc: mark --heap-prof and related flags stable
joyeecheung Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 48 additions & 8 deletions doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,9 +494,14 @@ node -C development app.js

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

> Stability: 1 - Experimental
> Stability: 2 - Stable

Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
before exit.
Expand All @@ -517,9 +522,14 @@ CPU.20190409.202950.15293.0.0.cpuprofile

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

> Stability: 1 - Experimental
> Stability: 2 - Stable

Specify the directory where the CPU profiles generated by `--cpu-prof` will
be placed.
Expand All @@ -531,9 +541,14 @@ The default value is controlled by the

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

> Stability: 1 - Experimental
> Stability: 2 - Stable

Specify the sampling interval in microseconds for the CPU profiles generated
by `--cpu-prof`. The default is 1000 microseconds.
Expand All @@ -542,9 +557,14 @@ by `--cpu-prof`. The default is 1000 microseconds.

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

> Stability: 1 - Experimental
> Stability: 2 - Stable

Specify the file name of the CPU profile generated by `--cpu-prof`.

Expand Down Expand Up @@ -1138,9 +1158,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 @@ -1161,9 +1186,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 @@ -1175,9 +1205,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 @@ -1186,9 +1221,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