diff options
| author | Rich Trott <rtrott@gmail.com> | 2016-05-26 16:35:23 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2016-05-29 19:28:18 -0700 |
| commit | 112b9cdad78da77170436fb68b260f99772793ac (patch) | |
| tree | 003d5704bdddd45fc80c1527fb8108207a1840e6 /doc/api/debugger.md | |
| parent | f3971ff117c42bb471e201da29cc4bdaf475129a (diff) | |
| download | android-node-v8-112b9cdad78da77170436fb68b260f99772793ac.tar.gz android-node-v8-112b9cdad78da77170436fb68b260f99772793ac.tar.bz2 android-node-v8-112b9cdad78da77170436fb68b260f99772793ac.zip | |
doc: improve debugger doc prose
PR-URL: https://github.com/nodejs/node/pull/7007
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/debugger.md')
| -rw-r--r-- | doc/api/debugger.md | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/doc/api/debugger.md b/doc/api/debugger.md index 400192ee00..a966ee2b01 100644 --- a/doc/api/debugger.md +++ b/doc/api/debugger.md @@ -20,13 +20,11 @@ break in /home/indutny/Code/git/indutny/myscript.js:1 debug> ``` -Node.js's debugger client does not yet support the full range of commands, but -simple step and inspection are possible. +Node.js's debugger client is not a full-featured debugger, but simple step and +inspection are possible. Inserting the statement `debugger;` into the source code of a script will -enable a breakpoint at that position in the code. - -For example, suppose `myscript.js` is written as: +enable a breakpoint at that position in the code: ```js // myscript.js @@ -81,8 +79,7 @@ debug> quit ``` The `repl` command allows code to be evaluated remotely. The `next` command -steps over to the next line. Type `help` to see what other commands are -available. +steps to the next line. Type `help` to see what other commands are available. Pressing `enter` without typing a command will repeat the previous debugger command. @@ -98,7 +95,7 @@ To begin watching an expression, type `watch('my_expression')`. The command `watchers` will print the active watchers. To remove a watcher, type `unwatch('my_expression')`. -## Commands reference +## Command reference ### Stepping @@ -145,7 +142,7 @@ break in test/fixtures/break-in-module/mod.js:23 debug> ``` -### Info +### Information * `backtrace`, `bt` - Print backtrace of current execution frame * `list(5)` - List scripts source code with 5 line context (5 lines before and @@ -174,7 +171,7 @@ An alternative way of enabling and accessing the debugger is to start Node.js with the `--debug` command-line flag or by signaling an existing Node.js process with `SIGUSR1`. -Once a process has been set in debug mode this way, it can be connected to +Once a process has been set in debug mode this way, it can be inspected using the Node.js debugger by either connecting to the `pid` of the running process or via URI reference to the listening debugger: |