Skip to content

doc: add example for running with v8-inspector - #8845

Closed
fhinkel wants to merge 1 commit into
nodejs:masterfrom
fhinkel:docInspector
Closed

doc: add example for running with v8-inspector#8845
fhinkel wants to merge 1 commit into
nodejs:masterfrom
fhinkel:docInspector

Conversation

@fhinkel

@fhinkelfhinkel commented Sep 29, 2016

Copy link
Copy Markdown
Member
Checklist
  • make -j8 test (UNIX) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc debugger

Description of change

Add example to show what running Node.js with --inspect
should look like.

Some IDEs do not show the link when running with --inspect.
This example hints to what the full output looks like.

@fhinkelfhinkel added the doc Issues and PRs related to the documentations. label Sep 29, 2016
@nodejs-github-botnodejs-github-bot added debugger doc Issues and PRs related to the documentations. labels Sep 29, 2016
@mscdexmscdex added inspector Issues and PRs related to the V8 inspector protocol and removed debugger labels Sep 29, 2016
addaleax
addaleax approved these changes Sep 29, 2016
View reviewed changes

@addaleaxaddaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thank you!

Comment threaddoc/api/debugger.md Outdated

@addaleaxaddaleaxSep 29, 2016•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: I guess “normal” users don’t call it with the ./? 😄

@fhinkelfhinkelSep 29, 2016

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Thanks, fixed :)

lpinca
lpinca reviewed Sep 29, 2016
View reviewed changes
Comment threaddoc/api/debugger.md Outdated

@lpincalpincaSep 29, 2016•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: I would just use node without ./. It's unlikely that there is a node executable in the folder where the command is run.

Edit: @addaleax won the race condition here 😄.

lpinca
lpinca reviewed Sep 29, 2016
View reviewed changes
Comment threaddoc/api/debugger.md Outdated

@lpincalpincaSep 29, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: maybe it's better to not split this line as it is a URL. I'm not sure though because if it isn't split scrolling is required on small screens.

@fhinkelfhinkelSep 29, 2016

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Changed, no line break in url.

@lpinca

lpinca commented Sep 29, 2016

Copy link
Copy Markdown
Member

@fhinkel while you are at it s/Add/add/ in the first line of commit message.

@fhinkel
doc: add example for running with v8-inspector
0c406a1
Add example to show what running Node.js with `--inspect`
should look like.
Some IDEs do not show the link when running with `--inspect`.
This example hints to what the full output looks like.
@fhinkelfhinkel changed the title doc: Add example for running with v8-inspectordoc: add example for running with v8-inspectorSep 29, 2016
lpinca
lpinca approved these changes Sep 29, 2016
View reviewed changes

@lpincalpinca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

cjihrig
cjihrig approved these changes Sep 29, 2016
View reviewed changes

@cjihrigcjihrig left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, but maybe this should go after the first paragraph of the V8 inspector section.

@MylesBorins

MylesBorins commented Sep 29, 2016

Copy link
Copy Markdown
Contributor

wasn't one of the reasons for not documenting it because it was an experimental feature? /cc @nodejs/ctc

I'm not neccessarily opposed to this, but I do think we should be careful about the support story in experimental features

@cjihrig

cjihrig commented Sep 29, 2016

Copy link
Copy Markdown
Contributor

It's already documented, and comes with a big bold warning that it's experimental. I don't think this PR adds any additional support commitment.

@MylesBorins

MylesBorins commented Sep 29, 2016

Copy link
Copy Markdown
Contributor

I retract my original statement then. This example is a great thing to include

LGTM

addaleax
addaleax approved these changes Sep 29, 2016
View reviewed changes

@addaleaxaddaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! :)

@jasnell

jasnell commented Sep 30, 2016

Copy link
Copy Markdown
Member

LGTM

jasnell pushed a commit that referenced this pull request Sep 30, 2016
@fhinkel@jasnell
doc: add example for running with v8-inspector
bdb8012
Add example to show what running Node.js with `--inspect`
should look like.
Some IDEs do not show the link when running with `--inspect`.
This example hints to what the full output looks like.
PR-URL: #8845
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@jasnell

jasnell commented Sep 30, 2016

Copy link
Copy Markdown
Member

Landed in bdb8012. Thank you!

@jasnelljasnell closed this Sep 30, 2016
MylesBorins pushed a commit that referenced this pull request Sep 30, 2016
@fhinkelMyles Borins
doc: add example for running with v8-inspector
3eb93e1
Add example to show what running Node.js with `--inspect`
should look like.
Some IDEs do not show the link when running with `--inspect`.
This example hints to what the full output looks like.
PR-URL: #8845
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
jasnell pushed a commit that referenced this pull request Oct 6, 2016
@fhinkel@jasnell
doc: add example for running with v8-inspector
13623ce
Add example to show what running Node.js with `--inspect`
should look like.
Some IDEs do not show the link when running with `--inspect`.
This example hints to what the full output looks like.
PR-URL: #8845
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@addaleaxaddaleaxaddaleax approved these changes
@lpincalpincalpinca approved these changes
@cjihrigcjihrigcjihrig approved these changes
+2 more reviewers
@MylesBorinsMylesBorinsMylesBorins approved these changes
@gibfahngibfahngibfahn approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.inspectorIssues and PRs related to the V8 inspector protocol

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@fhinkel@lpinca@MylesBorins@cjihrig@jasnell@addaleax@gibfahn@mscdex@nodejs-github-bot