From 0a05c0ba77b65dc483034d8fc820c00bdff7038b Mon Sep 17 00:00:00 2001 From: Aymen Naghmouchi Date: Thu, 14 Mar 2019 18:12:17 +0100 Subject: [PATCH 1/7] doc: add internal documentation Signed-off-by: Aymen Naghmouchi --- doc/internal/index.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 doc/internal/index.md diff --git a/doc/internal/index.md b/doc/internal/index.md new file mode 100644 index 00000000000000..81a5a4d2678e78 --- /dev/null +++ b/doc/internal/index.md @@ -0,0 +1,14 @@ +# Internal documentation of Node.js + +## CLI + +### Node.js options: + +#### `--inspect-brk-node[=[host:]port]` + + + +Activate inspector on `host:port` and break at start of node script. +Default `host:port` is `127.0.0.1:9229`. From 2dafa67a71c10cd6563c7389788c3d9c2b370f59 Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Thu, 14 Mar 2019 21:41:26 +0100 Subject: [PATCH 2/7] Update doc/internal/index.md Co-Authored-By: aymen94 --- doc/internal/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/internal/index.md b/doc/internal/index.md index 81a5a4d2678e78..02fd56dc00a87d 100644 --- a/doc/internal/index.md +++ b/doc/internal/index.md @@ -10,5 +10,6 @@ added: v7.6.0 --> -Activate inspector on `host:port` and break at start of node script. +Activate inspector on `host:port` and break at start of the first internal +JavaScript script executed when the inspector is available. Default `host:port` is `127.0.0.1:9229`. From 4ced4778d860d41d1f55291bdbff035458b46015 Mon Sep 17 00:00:00 2001 From: Aymen Naghmouchi Date: Mon, 25 Mar 2019 22:22:25 +0100 Subject: [PATCH 3/7] change directory, add a disclaimer Signed-off-by: Aymen Naghmouchi --- doc/{ => guides}/internal/index.md | 0 doc/guides/internal/readme.md | 4 ++++ 2 files changed, 4 insertions(+) rename doc/{ => guides}/internal/index.md (100%) create mode 100644 doc/guides/internal/readme.md diff --git a/doc/internal/index.md b/doc/guides/internal/index.md similarity index 100% rename from doc/internal/index.md rename to doc/guides/internal/index.md diff --git a/doc/guides/internal/readme.md b/doc/guides/internal/readme.md new file mode 100644 index 00000000000000..53958009a4c0e3 --- /dev/null +++ b/doc/guides/internal/readme.md @@ -0,0 +1,4 @@ +# Disclaimer + +THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. From 432f1428284cb89f5545603604acbf7336fcbbae Mon Sep 17 00:00:00 2001 From: Aymen Naghmouchi Date: Mon, 25 Mar 2019 23:10:09 +0100 Subject: [PATCH 4/7] change disclaimer Signed-off-by: Aymen Naghmouchi --- doc/guides/internal/index.md | 2 ++ doc/guides/internal/readme.md | 4 ---- 2 files changed, 2 insertions(+), 4 deletions(-) delete mode 100644 doc/guides/internal/readme.md diff --git a/doc/guides/internal/index.md b/doc/guides/internal/index.md index 02fd56dc00a87d..a969402734cbe2 100644 --- a/doc/guides/internal/index.md +++ b/doc/guides/internal/index.md @@ -1,3 +1,5 @@ +# we assume no responsibility + # Internal documentation of Node.js ## CLI diff --git a/doc/guides/internal/readme.md b/doc/guides/internal/readme.md deleted file mode 100644 index 53958009a4c0e3..00000000000000 --- a/doc/guides/internal/readme.md +++ /dev/null @@ -1,4 +0,0 @@ -# Disclaimer - -THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. From 630bf3920148b6527ed60c349a496395832e1148 Mon Sep 17 00:00:00 2001 From: Aymen Naghmouchi Date: Tue, 26 Mar 2019 21:01:52 +0100 Subject: [PATCH 5/7] change disclaimer Signed-off-by: Aymen Naghmouchi --- doc/guides/internal/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/guides/internal/index.md b/doc/guides/internal/index.md index a969402734cbe2..9ea6fc7867ba0c 100644 --- a/doc/guides/internal/index.md +++ b/doc/guides/internal/index.md @@ -1,4 +1,4 @@ -# we assume no responsibility +# These flags are for Node.js core development usage only. Do not use these flags in your own applications. These flags are not subjected to semantic versioning rules. The core developers may remove these flags in any version of Node.js. # Internal documentation of Node.js From 18a0b7ef5053f646571b5a2c7dbef05d4921e6f5 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 26 Mar 2019 22:56:01 +0100 Subject: [PATCH 6/7] remove span Co-Authored-By: aymen94 --- doc/guides/internal/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/guides/internal/index.md b/doc/guides/internal/index.md index 9ea6fc7867ba0c..b55328094dad2c 100644 --- a/doc/guides/internal/index.md +++ b/doc/guides/internal/index.md @@ -1,4 +1,6 @@ -# These flags are for Node.js core development usage only. Do not use these flags in your own applications. These flags are not subjected to semantic versioning rules. The core developers may remove these flags in any version of Node.js. +These flags are for Node.js core development usage only. Do not use these flags +in your own applications. These flags are not subjected to semantic versioning +rules. The core developers may remove these flags in any version of Node.js. # Internal documentation of Node.js From 47d71b555c51e1f23ed5d176213e1c1f63ad838f Mon Sep 17 00:00:00 2001 From: Aymen Naghmouchi Date: Thu, 28 Mar 2019 11:45:25 +0100 Subject: [PATCH 7/7] change file name to readme Signed-off-by: Aymen Naghmouchi --- doc/guides/internal/{index.md => readme.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename doc/guides/internal/{index.md => readme.md} (96%) diff --git a/doc/guides/internal/index.md b/doc/guides/internal/readme.md similarity index 96% rename from doc/guides/internal/index.md rename to doc/guides/internal/readme.md index 9ea6fc7867ba0c..a7d00cd7833e59 100644 --- a/doc/guides/internal/index.md +++ b/doc/guides/internal/readme.md @@ -4,7 +4,7 @@ ## CLI -### Node.js options: +### Flags #### `--inspect-brk-node[=[host:]port]`