From 7938238b31f69d1a8bfa8069387cc2374435996c Mon Sep 17 00:00:00 2001 From: Aymen Naghmouchi Date: Thu, 14 Mar 2019 18:12:17 +0100 Subject: [PATCH] doc: add internal documentation This adds documentation that is meant as internal only. As first entry the `--inspect-brk-node` flag got documented here. PR-URL: https://github.com/nodejs/node/pull/26665 Reviewed-By: Rich Trott Reviewed-By: Ruben Bridgewater --- doc/guides/internal/readme.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 doc/guides/internal/readme.md diff --git a/doc/guides/internal/readme.md b/doc/guides/internal/readme.md new file mode 100644 index 00000000000000..2631978e1af01c --- /dev/null +++ b/doc/guides/internal/readme.md @@ -0,0 +1,19 @@ +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 + +## CLI + +### Flags + +#### `--inspect-brk-node[=[host:]port]` + + + +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`.