Skip to content

doc: clarify V8 option stability in --v8-options docs#62373

Open
lilianakatrina684-a11y wants to merge 1 commit intonodejs:mainfrom
lilianakatrina684-a11y:docs-v8-options-stability
Open

doc: clarify V8 option stability in --v8-options docs#62373
lilianakatrina684-a11y wants to merge 1 commit intonodejs:mainfrom
lilianakatrina684-a11y:docs-v8-options-stability

Conversation

@lilianakatrina684-a11y
Copy link

Summary

  • clarify in the --v8-options docs that V8 flags are outside Node.js stability guarantees
  • note that individual V8 flags may change or be removed between releases

Closes #62341

@nodejs-github-bot nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Mar 21, 2026
not consistent with the system configuration that the users have for some reason.

### `--v8-options`
### --v8-options
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were the backticks removed?
They consistently are set everywhere else

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already covered in the doc: https://nodejs.org/docs/latest/api/cli.html#useful-v8-options

V8 has its own set of CLI options. Any V8 CLI option that is provided to node will be passed on to V8 to handle. V8's options have no stability guarantee. The V8 team themselves don't consider them to be part of their formal API, and reserve the right to change them at any time

@ZeroPointSix
Copy link

Closing this because the existing CLI docs already cover the V8 stability note that this PR tried to add. I will avoid duplicating that wording.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

v8 flag removal: --detailed-error-stack-trace

5 participants