doc: clarify `--max-old-space-size` and `--max-semi-space-size` units · nodejs/node@62953ef · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 754
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 62953ef

Browse filesBrowse the repository at this point in the historyBrowse files

alexandre-abrioux

authored and

targos

committed

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
Copy full SHA for 62953ef

2 files changed

+13-5Lines changed: 13 additions & 5 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • cli.md
  • worker_threads.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/cli.md‎

Copy file name to clipboardExpand all lines: doc/api/cli.md

+11-3Lines changed: 11 additions & 3 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -3213,7 +3213,11 @@ documented here:
3213	3213
3214	3214	### `--perf-prof-unwinding-info`
3215	3215
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)
3217	3221
3218	3222	Sets the max memory size of V8's old memory section. As memory
3219	3223	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
3226	3230	node --max-old-space-size=1536 index.js
3227	3231	```
3228	3232
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)
3230	3238
3231	3239	Sets the maximum [semi-space][] size for V8's [scavenge garbage collector][] in
3232		- MiB (megabytes).
	3240	+ MiB (mebibytes).
3233	3241	Increasing the max size of a semi-space may improve throughput for Node.js at
3234	3242	the cost of more memory consumption.
3235	3243

Collapse file

‎doc/api/worker_threads.md‎

Copy file name to clipboardExpand all lines: doc/api/worker_threads.md

+2-2Lines changed: 2 additions & 2 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -1354,8 +1354,8 @@ thread spawned will spawn another until the application crashes.
1354	1354	[`'close'` event]: #event-close
1355	1355	[`'exit'` event]: #event-exit
1356	1356	[`'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
1359	1359	[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
1360	1360	[`AsyncResource`]: async_hooks.md#class-asyncresource
1361	1361	[`Buffer.allocUnsafe()`]: buffer.md#static-method-bufferallocunsafesize

0 commit comments

Comments

0 (0)