doc: clarify `--max-old-space-size` and `--max-semi-space-size` units

PR-URL: https://github.com/nodejs/node/pull/54477
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
pull/54823/head
Alexandre ABRIOUX 2024-09-06 19:33:03 +02:00 committed by GitHub
parent 437e168c06
commit bec80892b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 13 additions and 5 deletions

View File

@ -3452,7 +3452,11 @@ documented here:
### `--perf-prof-unwinding-info`
### `--max-old-space-size=SIZE` (in megabytes)
<!-- Anchor to make sure old links find a target -->
<a id="--max-old-space-sizesize-in-megabytes"></a>
### `--max-old-space-size=SIZE` (in MiB)
Sets the max memory size of V8's old memory section. As memory
consumption approaches the limit, V8 will spend more time on
@ -3465,10 +3469,14 @@ On a machine with 2 GiB of memory, consider setting this to
node --max-old-space-size=1536 index.js
```
### `--max-semi-space-size=SIZE` (in megabytes)
<!-- Anchor to make sure old links find a target -->
<a id="--max-semi-space-sizesize-in-megabytes"></a>
### `--max-semi-space-size=SIZE` (in MiB)
Sets the maximum [semi-space][] size for V8's [scavenge garbage collector][] in
MiB (megabytes).
MiB (mebibytes).
Increasing the max size of a semi-space may improve throughput for Node.js at
the cost of more memory consumption.

View File

@ -1500,8 +1500,8 @@ thread spawned will spawn another until the application crashes.
[`'close'` event]: #event-close
[`'exit'` event]: #event-exit
[`'online'` event]: #event-online
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-megabytes
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-megabytes
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-mib
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-mib
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[`AsyncResource`]: async_hooks.md#class-asyncresource
[`Buffer.allocUnsafe()`]: buffer.md#static-method-bufferallocunsafesize