From 0090f54ea77bae15547585c0dbfcf4f229ce5c01 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Sat, 14 Mar 2020 22:00:07 +0530
Subject: [PATCH 1/9] doc: add useful v8 option section

This adds new section for v8 options and --max-old-space-size
Fixes: https://github.com/nodejs/node/issues/32252
---
 doc/api/cli.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 66cb665fa82e9f..f6383a81f449d9 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1180,6 +1180,8 @@ V8 options that are allowed are:
 `--perf-basic-prof-only-functions`, `--perf-basic-prof`,
 `--perf-prof-unwinding-info`, and `--perf-prof` are only available on Linux.
 
+### Useful v8 Options
+## 
 ### `NODE_PATH=path[:…]`
 <!-- YAML
 added: v0.1.32
@@ -1385,6 +1387,20 @@ threadpool by setting the `'UV_THREADPOOL_SIZE'` environment variable to a value
 greater than `4` (its current default value). For more information, see the
 [libuv threadpool documentation][].
 
+## Useful v8 Options
+
+These are v8 options and fall outside Node.js' responsibility.
+
+V8 options that are allowed are:
+
+### `--max-old-space-size`
+
+Sets the max memory size of V8 old memory section. As memory consumption approaches the limit, V8 will spend more time on garbage collection in an effort to free unused memory.
+
+On a machine with 2GB of memory it suggested to set 1.5GB to leave some memory for other uses and avoid swapping.
+
+E.g. `node --max-old-space-size=1536 index.js`
+
 [`--openssl-config`]: #cli_openssl_config_file
 [`Buffer`]: buffer.html#buffer_class_buffer
 [`SlowBuffer`]: buffer.html#buffer_class_slowbuffer

From 5209db887b6485d995ce30a57f1d5134d1ed5c65 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Sat, 14 Mar 2020 22:22:33 +0530
Subject: [PATCH 2/9] doc: add useful v8 option section

Fixed a typo addition in doc/cli.md
Fixes: https://github.com/nodejs/node/issues/32252
---
 doc/api/cli.md | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index f6383a81f449d9..0871f051bb3810 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1180,8 +1180,6 @@ V8 options that are allowed are:
 `--perf-basic-prof-only-functions`, `--perf-basic-prof`,
 `--perf-prof-unwinding-info`, and `--perf-prof` are only available on Linux.
 
-### Useful v8 Options
-## 
 ### `NODE_PATH=path[:…]`
 <!-- YAML
 added: v0.1.32
@@ -1387,7 +1385,7 @@ threadpool by setting the `'UV_THREADPOOL_SIZE'` environment variable to a value
 greater than `4` (its current default value). For more information, see the
 [libuv threadpool documentation][].
 
-## Useful v8 Options
+## Useful v8 options
 
 These are v8 options and fall outside Node.js' responsibility.
 

From 2e8653421ca1052a0fcf7658aaf77fb60a60f314 Mon Sep 17 00:00:00 2001
From: Nimit Aggarwal <nimitagg95@gmail.com>
Date: Tue, 17 Mar 2020 11:22:10 +0530
Subject: [PATCH 3/9] Update doc/api/cli.md

Co-Authored-By: mscdex <mscdex@users.noreply.github.com>
---
 doc/api/cli.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 0871f051bb3810..6fd64ae53908aa 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1385,7 +1385,7 @@ threadpool by setting the `'UV_THREADPOOL_SIZE'` environment variable to a value
 greater than `4` (its current default value). For more information, see the
 [libuv threadpool documentation][].
 
-## Useful v8 options
+## Useful V8 options
 
 These are v8 options and fall outside Node.js' responsibility.
 

From 2f36d8db23fc0a06f2fe2e4ac25ec0331d079d1f Mon Sep 17 00:00:00 2001
From: Nimit Aggarwal <nimitagg95@gmail.com>
Date: Tue, 17 Mar 2020 11:22:36 +0530
Subject: [PATCH 4/9] Update doc/api/cli.md

Co-Authored-By: mscdex <mscdex@users.noreply.github.com>
---
 doc/api/cli.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 6fd64ae53908aa..a22b513e00b31e 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1387,7 +1387,7 @@ greater than `4` (its current default value). For more information, see the
 
 ## Useful V8 options
 
-These are v8 options and fall outside Node.js' responsibility.
+These are V8 options and fall outside Node.js' responsibility.
 
 V8 options that are allowed are:
 

From 0cf3b11f7b9db6be5654be2ec972394ce87c43b4 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Tue, 17 Mar 2020 19:57:18 +0530
Subject: [PATCH 5/9] doc: add to cli.md V8 options

---
 doc/api/cli.md | 26 +++++++++++++++++---------
 1 file changed, 17 insertions(+), 9 deletions(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index a22b513e00b31e..b5b3010318dd9c 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1387,15 +1387,23 @@ greater than `4` (its current default value). For more information, see the
 
 ## Useful V8 options
 
-These are V8 options and fall outside Node.js' responsibility.
-
-V8 options that are allowed are:
-
-### `--max-old-space-size`
-
-Sets the max memory size of V8 old memory section. As memory consumption approaches the limit, V8 will spend more time on garbage collection in an effort to free unused memory.
-
-On a machine with 2GB of memory it suggested to set 1.5GB to leave some memory for other uses and avoid swapping.
+V8 has its own set of CLI options. Any V8 CLI option that is provided to `node` will 
+be passed on to V8 to handle. V8's options have _no stability guarantee_. 
+The V8 team themselves don't consider them to be part of their formal API, 
+and reserve the right to change them at any time. The Node.js team does not 
+consider them covered by the Node.js stability guarantees. Many of the V8 
+options are of interest only to V8 developers. Despite this, there is a small 
+set of V8 options that are widely applicable to the Node.js, and they are 
+documented here. V8 options that are allowed are:
+
+### `--max-old-space-size=SIZE` (in Mbytes)
+
+Sets the max memory size of V8 old memory section. As memory 
+consumption approaches the limit, V8 will spend more time on 
+garbage collection in an effort to free unused memory.
+
+On a machine with 2GB of memory it suggested to set 1.5GB 
+to leave some memory for other uses and avoid swapping.
 
 E.g. `node --max-old-space-size=1536 index.js`
 

From 030fe45bd08bc65ca7eaee1ed482fde6c2f89e20 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Tue, 17 Mar 2020 20:14:35 +0530
Subject: [PATCH 6/9] doc: fix trailing whitespace in cli.md

Signed-off-by: Nimit <nimitagg95@gmail.com>
---
 doc/api/cli.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index b5b3010318dd9c..34410ee24b3619 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1387,22 +1387,22 @@ greater than `4` (its current default value). For more information, see the
 
 ## Useful V8 options
 
-V8 has its own set of CLI options. Any V8 CLI option that is provided to `node` will 
-be passed on to V8 to handle. V8's options have _no stability guarantee_. 
-The V8 team themselves don't consider them to be part of their formal API, 
-and reserve the right to change them at any time. The Node.js team does not 
-consider them covered by the Node.js stability guarantees. Many of the V8 
-options are of interest only to V8 developers. Despite this, there is a small 
-set of V8 options that are widely applicable to the Node.js, and they are 
+V8 has its own set of CLI options. Any V8 CLI option that is provided to `node` will
+be passed on to V8 to handle. V8's options have _no stability guarantee_.
+The V8 team themselves don't consider them to be part of their formal API,
+and reserve the right to change them at any time. The Node.js team does not
+consider them covered by the Node.js stability guarantees. Many of the V8
+options are of interest only to V8 developers. Despite this, there is a small
+set of V8 options that are widely applicable to the Node.js, and they are
 documented here. V8 options that are allowed are:
 
 ### `--max-old-space-size=SIZE` (in Mbytes)
 
-Sets the max memory size of V8 old memory section. As memory 
-consumption approaches the limit, V8 will spend more time on 
+Sets the max memory size of V8 old memory section. As memory
+consumption approaches the limit, V8 will spend more time on
 garbage collection in an effort to free unused memory.
 
-On a machine with 2GB of memory it suggested to set 1.5GB 
+On a machine with 2GB of memory it suggested to set 1.5GB
 to leave some memory for other uses and avoid swapping.
 
 E.g. `node --max-old-space-size=1536 index.js`

From 6208729ba25c98501a1e024b75ab1b2dba1e94a2 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Tue, 17 Mar 2020 23:48:52 +0530
Subject: [PATCH 7/9] doc: update cli.md for fixes

Signed-off-by: Nimit <nimitagg95@gmail.com>
---
 doc/api/cli.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 34410ee24b3619..b92a45ca7b6508 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1393,17 +1393,17 @@ The V8 team themselves don't consider them to be part of their formal API,
 and reserve the right to change them at any time. The Node.js team does not
 consider them covered by the Node.js stability guarantees. Many of the V8
 options are of interest only to V8 developers. Despite this, there is a small
-set of V8 options that are widely applicable to the Node.js, and they are
-documented here. V8 options that are allowed are:
+set of V8 options that are widely applicable to Node.js, and they are
+documented here:
 
 ### `--max-old-space-size=SIZE` (in Mbytes)
 
-Sets the max memory size of V8 old memory section. As memory
+Sets the max memory size of V8's old memory section. As memory
 consumption approaches the limit, V8 will spend more time on
 garbage collection in an effort to free unused memory.
 
-On a machine with 2GB of memory it suggested to set 1.5GB
-to leave some memory for other uses and avoid swapping.
+On a machine with 2GB of memory it is suggested to set this to
+1536 (1.5GB) to leave some memory for other uses and avoid swapping.
 
 E.g. `node --max-old-space-size=1536 index.js`
 

From fd932293d0d8b10465709bc5ae87e250b13a62f7 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Fri, 3 Apr 2020 22:21:50 +0530
Subject: [PATCH 8/9] fix language cli.md

Signed-off-by: Nimit <nimitagg95@gmail.com>
---
 doc/api/cli.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index b92a45ca7b6508..f85b428c0550fc 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1387,11 +1387,11 @@ greater than `4` (its current default value). For more information, see the
 
 ## Useful V8 options
 
-V8 has its own set of CLI options. Any V8 CLI option that is provided to `node` will
-be passed on to V8 to handle. V8's options have _no stability guarantee_.
+V8 has its own set of CLI options. Any V8 CLI option that is provided to `node`
+will be passed on to V8 to handle. V8's options have _no stability guarantee_.
 The V8 team themselves don't consider them to be part of their formal API,
-and reserve the right to change them at any time. The Node.js team does not
-consider them covered by the Node.js stability guarantees. Many of the V8
+and reserve the right to change them at any time. Likewise, they are not
+covered by the Node.js stability guarantees. Many of the V8
 options are of interest only to V8 developers. Despite this, there is a small
 set of V8 options that are widely applicable to Node.js, and they are
 documented here:
@@ -1402,7 +1402,7 @@ Sets the max memory size of V8's old memory section. As memory
 consumption approaches the limit, V8 will spend more time on
 garbage collection in an effort to free unused memory.
 
-On a machine with 2GB of memory it is suggested to set this to
+On a machine with 2GB of memory, consider setting this to
 1536 (1.5GB) to leave some memory for other uses and avoid swapping.
 
 E.g. `node --max-old-space-size=1536 index.js`

From aafe9fdc38cf8f42259e834fb112099edc56d8a1 Mon Sep 17 00:00:00 2001
From: Nimit <nimitagg95@gmail.com>
Date: Mon, 6 Apr 2020 23:36:43 +0530
Subject: [PATCH 9/9] fix example formatting

Signed-off-by: Nimit <nimitagg95@gmail.com>
---
 doc/api/cli.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index f85b428c0550fc..5e011d568d04d6 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1405,7 +1405,9 @@ garbage collection in an effort to free unused memory.
 On a machine with 2GB of memory, consider setting this to
 1536 (1.5GB) to leave some memory for other uses and avoid swapping.
 
-E.g. `node --max-old-space-size=1536 index.js`
+```console
+$ node --max-old-space-size=1536 index.js
+```
 
 [`--openssl-config`]: #cli_openssl_config_file
 [`Buffer`]: buffer.html#buffer_class_buffer