Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update V8 debugger doc to mention --inspect-brk #11495

Closed
wants to merge 1 commit into from
Closed

doc: update V8 debugger doc to mention --inspect-brk #11495

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: update V8 debugger doc to mention --inspect-brk 
Node now supports the `--inspect-brk` flag, which does the same thing
as `--inspect --debug-brk`. One thing that's nice about the new flag is
that it uses "inspect" language -- this is a suggested update to the
docs.
  • Loading branch information
@ide
ide committed Feb 22, 2017
commit 82b90cf3379272c2e0f358bbdf2a7bf965023d10
4 changes: 2 additions & 2 deletions doc/api/debugger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@ V8 Inspector can be enabled by passing the `--inspect` flag when starting a
Node.js application. It is also possible to supply a custom port with that flag,
e.g. `--inspect=9222` will accept DevTools connections on port 9222.

To break on the first line of the application code, provide the `--debug-brk`
flag in addition to `--inspect`.
To break on the first line of the application code, pass the `--inspect-brk`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not going to stop or even slow this PR from landing over this incredibly minor thing I'm about to bring up, but I gotta ask: Why the provide -> pass change? (I think of pass as something you do with arguments, not command-line flags, and so provide feels more correct to me in this context. But I'm not sure if that's my own idiosyncrasy.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The paragraph above says "passing the --inspect flag" so I followed its lead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for consistency, then!

flag instead of `--inspect`.

```txt
$ node --inspect index.js
Expand Down