Skip to content

doc: remove --expose-gc flag from CLI documentation #58909

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dario-piotrowicz
Copy link
Member

The CLI documentation for --expose-gc has been added in #53078

However it's removal was requested in #53078 (comment) (since this is not something users should generally rely on), but the documentation wasn't fully removed from the PR before it landed.

So I believe that the flag being documented might have been an oversight.

Original context: #58878 (comment)


Note: I'm trying to figure out here if --expose-gc should or not be documented in the CLI documentation, and if it should be I would be inclined to also include it in the manpage for consistency 🤔


Note: I wanted to also mention that the flag is also included in the allowed v8 options and the useful v8 options
(meaning that even after removing the cli flag section some references to it, for advanced users, will still be present in the document)

@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 Jun 30, 2025
Copy link
Member

@jakecastelli jakecastelli left a comment

Choose a reason for hiding this comment

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

This one feels similar to the --expose-internals CLI flag which exists but not documented.

We use --expose-internals exclusively in Core for various testing purposes but outside of core development it is not encouraged.

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.

3 participants