Node: doc: `--max-old-space-size` should be documented

Created on 13 Mar 2020  路  5Comments  路  Source: nodejs/node

Even though --max-old-space-size is a V8 flag, I would expect us to document it, given that it鈥檚 probably the most useful V8 flag for Node.js users overall.

Refs: #32251

doc good first issue

Most helpful comment

@nimit95 ... definitely a good first issue. It would be good to include some explanation around best practices in use, at least in the cli.md doc part.

All 5 comments

+1 ... Let's just make sure that v8 flags that are documented are separated off in their own section of cli.md with clear indication in the docs that they fall outside Node.js' responsibility and therefore cannot be covered by the semver rules. Beyond that, I'm very much +1 on documenting useful v8 options.

Obviously, we should get @nodejs/v8 folks to review those first tho ;-)

If this is a good first issue, I would like to work on it. :)

@nimit95 ... definitely a good first issue. It would be good to include some explanation around best practices in use, at least in the cli.md doc part.

Will make a PR and submit.

@nimit95 You already made the changes, great! It would nice if you open the PR now.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

danialkhansari picture danialkhansari  路  3Comments

srl295 picture srl295  路  3Comments

stevenvachon picture stevenvachon  路  3Comments

jmichae3 picture jmichae3  路  3Comments

akdor1154 picture akdor1154  路  3Comments