Skip to content

Commit 2c2ae80

Browse files
alexandre-abriouxaduh95
authored andcommitted
doc: clarify --max-old-space-size and --max-semi-space-size units
PR-URL: #54477 Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ulises Gascón <[email protected]>
1 parent 6200cf4 commit 2c2ae80

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

doc/api/cli.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3482,7 +3482,11 @@ documented here:
34823482

34833483
### `--perf-prof-unwinding-info`
34843484

3485-
### `--max-old-space-size=SIZE` (in megabytes)
3485+
<!-- Anchor to make sure old links find a target -->
3486+
3487+
<a id="--max-old-space-sizesize-in-megabytes"></a>
3488+
3489+
### `--max-old-space-size=SIZE` (in MiB)
34863490

34873491
Sets the max memory size of V8's old memory section. As memory
34883492
consumption approaches the limit, V8 will spend more time on
@@ -3495,10 +3499,14 @@ On a machine with 2 GiB of memory, consider setting this to
34953499
node --max-old-space-size=1536 index.js
34963500
```
34973501

3498-
### `--max-semi-space-size=SIZE` (in megabytes)
3502+
<!-- Anchor to make sure old links find a target -->
3503+
3504+
<a id="--max-semi-space-sizesize-in-megabytes"></a>
3505+
3506+
### `--max-semi-space-size=SIZE` (in MiB)
34993507

35003508
Sets the maximum [semi-space][] size for V8's [scavenge garbage collector][] in
3501-
MiB (megabytes).
3509+
MiB (mebibytes).
35023510
Increasing the max size of a semi-space may improve throughput for Node.js at
35033511
the cost of more memory consumption.
35043512

doc/api/worker_threads.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1500,8 +1500,8 @@ thread spawned will spawn another until the application crashes.
15001500
[`'close'` event]: #event-close
15011501
[`'exit'` event]: #event-exit
15021502
[`'online'` event]: #event-online
1503-
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-megabytes
1504-
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-megabytes
1503+
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-mib
1504+
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-mib
15051505
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
15061506
[`AsyncResource`]: async_hooks.md#class-asyncresource
15071507
[`Buffer.allocUnsafe()`]: buffer.md#static-method-bufferallocunsafesize

0 commit comments

Comments
 (0)