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>
This commit is contained in:
Aymen Naghmouchi 2019-03-14 18:12:17 +01:00 committed by Ruben Bridgewater
parent b468a1dfc3
commit 7938238b31
No known key found for this signature in database
GPG Key ID: F07496B3EB3C1762

View File

@ -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`.