Skip to content

Commit

Permalink
doc: improve debugger doc prose
Browse files Browse the repository at this point in the history
PR-URL: #7007
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and rvagg committed Jun 2, 2016
1 parent 3c2c4c8 commit 14b3ba3
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions doc/api/debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 14b3ba3

Please sign in to comment.