diff options
| author | Aymen Naghmouchi <aymen.aymen@live.it> | 2019-03-14 18:12:17 +0100 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2019-04-15 18:58:52 +0200 |
| commit | 7938238b31f69d1a8bfa8069387cc2374435996c (patch) | |
| tree | 8f73b6dcc198c007ea2d20b5b833d6347c952060 /doc/guides | |
| parent | b468a1dfc3b7557b0ec255de6ae6599d1bc0fc87 (diff) | |
| download | android-node-v8-7938238b31f69d1a8bfa8069387cc2374435996c.tar.gz android-node-v8-7938238b31f69d1a8bfa8069387cc2374435996c.tar.bz2 android-node-v8-7938238b31f69d1a8bfa8069387cc2374435996c.zip | |
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 <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/guides')
| -rw-r--r-- | doc/guides/internal/readme.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/guides/internal/readme.md b/doc/guides/internal/readme.md new file mode 100644 index 0000000000..2631978e1a --- /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]` + +<!-- YAML +added: v7.6.0 +--> + +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`. |