Skip to content

Commit 62953ef

Browse files
alexandre-abriouxtargos
authored andcommittedOct 2, 2024
doc: clarify --max-old-space-size and --max-semi-space-size units
PR-URL: #54477 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
1 parent e2bab0f commit 62953ef

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed
 

‎doc/api/cli.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -3213,7 +3213,11 @@ documented here:
32133213

32143214
### `--perf-prof-unwinding-info`
32153215

3216-
### `--max-old-space-size=SIZE` (in megabytes)
3216+
<!-- Anchor to make sure old links find a target -->
3217+
3218+
<a id="--max-old-space-sizesize-in-megabytes"></a>
3219+
3220+
### `--max-old-space-size=SIZE` (in MiB)
32173221

32183222
Sets the max memory size of V8's old memory section. As memory
32193223
consumption approaches the limit, V8 will spend more time on
@@ -3226,10 +3230,14 @@ On a machine with 2 GiB of memory, consider setting this to
32263230
node --max-old-space-size=1536 index.js
32273231
```
32283232

3229-
### `--max-semi-space-size=SIZE` (in megabytes)
3233+
<!-- Anchor to make sure old links find a target -->
3234+
3235+
<a id="--max-semi-space-sizesize-in-megabytes"></a>
3236+
3237+
### `--max-semi-space-size=SIZE` (in MiB)
32303238

32313239
Sets the maximum [semi-space][] size for V8's [scavenge garbage collector][] in
3232-
MiB (megabytes).
3240+
MiB (mebibytes).
32333241
Increasing the max size of a semi-space may improve throughput for Node.js at
32343242
the cost of more memory consumption.
32353243

‎doc/api/worker_threads.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1354,8 +1354,8 @@ thread spawned will spawn another until the application crashes.
13541354
[`'close'` event]: #event-close
13551355
[`'exit'` event]: #event-exit
13561356
[`'online'` event]: #event-online
1357-
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-megabytes
1358-
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-megabytes
1357+
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-mib
1358+
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-mib
13591359
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
13601360
[`AsyncResource`]: async_hooks.md#class-asyncresource
13611361
[`Buffer.allocUnsafe()`]: buffer.md#static-method-bufferallocunsafesize

0 commit comments

Comments
 (0)
Please sign in to comment.