Browse Source

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>
v7.x
Rich Trott 9 years ago
parent
commit
112b9cdad7
  1. 17
      doc/api/debugger.md

17
doc/api/debugger.md

@ -20,13 +20,11 @@ break in /home/indutny/Code/git/indutny/myscript.js:1
debug> debug>
``` ```
Node.js's debugger client does not yet support the full range of commands, but Node.js's debugger client is not a full-featured debugger, but simple step and
simple step and inspection are possible. inspection are possible.
Inserting the statement `debugger;` into the source code of a script will Inserting the statement `debugger;` into the source code of a script will
enable a breakpoint at that position in the code. enable a breakpoint at that position in the code:
For example, suppose `myscript.js` is written as:
```js ```js
// myscript.js // myscript.js
@ -81,8 +79,7 @@ debug> quit
``` ```
The `repl` command allows code to be evaluated remotely. The `next` command 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 steps to the next line. Type `help` to see what other commands are available.
available.
Pressing `enter` without typing a command will repeat the previous debugger Pressing `enter` without typing a command will repeat the previous debugger
command. 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 `watchers` will print the active watchers. To remove a watcher, type
`unwatch('my_expression')`. `unwatch('my_expression')`.
## Commands reference ## Command reference
### Stepping ### Stepping
@ -145,7 +142,7 @@ break in test/fixtures/break-in-module/mod.js:23
debug> debug>
``` ```
### Info ### Information
* `backtrace`, `bt` - Print backtrace of current execution frame * `backtrace`, `bt` - Print backtrace of current execution frame
* `list(5)` - List scripts source code with 5 line context (5 lines before and * `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 with the `--debug` command-line flag or by signaling an existing
Node.js process with `SIGUSR1`. 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 using the Node.js debugger by either connecting to the `pid` of the running
process or via URI reference to the listening debugger: process or via URI reference to the listening debugger:

Loading…
Cancel
Save