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.

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

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

Closed
wants to merge 1 commit into from

Conversation

ide
Copy link
Contributor

@ide ide commented Feb 22, 2017

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.

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

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.
@nodejs-github-bot nodejs-github-bot added debugger doc Issues and PRs related to the documentations. labels Feb 22, 2017
Copy link
Member

@gibfahn gibfahn left a comment

Choose a reason for hiding this comment

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

It's also good that you no longer have to use --inspect and --debug-brk, less typing is always nice.

@@ -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!

jasnell pushed a commit that referenced this pull request Feb 27, 2017
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.

PR-URL: #11495
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Josh Gavant <[email protected]>
Reviewed-By: Joyee Cheung <[email protected]>
@jasnell
Copy link
Member

jasnell commented Feb 27, 2017

Landed in ec4440a

@jasnell jasnell closed this Feb 27, 2017
italoacasas pushed a commit to italoacasas/node that referenced this pull request Feb 28, 2017
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.

PR-URL: nodejs#11495
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Josh Gavant <[email protected]>
Reviewed-By: Joyee Cheung <[email protected]>
@italoacasas italoacasas mentioned this pull request Feb 28, 2017
@ide ide deleted the docs-inspect branch August 14, 2017 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants