Fix #7065: cli help documentation for --inspect

[nojvek]

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• documentation is changed or added
• commit message follows commit guidelines

Affected core subsystem(s)

documentation

[nojvek]

Context in: #7086

[nojvek]

@joshgav@jasnell

[sam-github]

needs changing in https://github.com/nodejs/node/blob/master/doc/node.1, too

[nojvek]

is node.1 for man pages?

[sam-github]

Yes. ​

[nojvek]

Fixed.

[fhinkel]

Do reference-style links work if they are linked in another file?

[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/ is defined in debugger.md.

[jasnell]

small, nit... this could be reworded as:

V8 Inspector integration uses the [Chrome Debugging Protocol]{} to attach Node.js instances to debugging and profile tools such as Chrome DevTools and various IDEs. 

[nojvek]

That's how the inspector debugger.md documentation was done so I copied from there. I should point it to the correct link though. How do I build the documentation. Website to test this out?

…

On Thu, Mar 9, 2017 at 2:22 AM F. Hinkelmann ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In doc/api/cli.md <#11660 (comment)>: > @@ -94,6 +94,25 @@ Follows `require()`'s module resolution rules. `module` may be either a path to a file, or a node module name. +### `--inspect[=host:port]` +<!-- YAML +added: v6.5.0 +--> + +Activate inspector on host:port. Default is 127.0.0.1:9229. + +V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js +instances for debugging and profiling. It uses the [Chrome Debugging Protocol][]. Do reference-style links work if they are linked in another file? [Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/ is defined in debugger.md. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11660 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVGVKhJt_6ywbPWy1hQBrPGBGXqwNks5rj9LVgaJpZM4MRXMz> .

[fhinkel]

make doc generates the docs, I think the html files end up in out/doc/api/. Do you want to check if we need to define
[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/
in the file where you're using [Chrome Debugging Protocol]?

[nojvek]

Cli.md I believe debugger.md uses it too.

…

On Thu, Mar 9, 2017 at 8:58 AM F. Hinkelmann ***@***.***> wrote: make doc generates the docs, I think the html files end up in out/doc/api/. Do you want to check if we need to define [Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/ in the file where you're using [Chrome Debugging Protocol]? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11660 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVDnSUeIYOFvxqjlMA49lHde_wgq-ks5rkC-ngaJpZM4MRXMz> .

[fhinkel]

Sorry if I wasn't clear. debugger.md uses and defines a link to the debugging protocol. If we're using a reference-style link, we need to define it in the file where we use it. We can just copy this definition to the end of cli.md.

Could you also fix-up your commit messages according to this guide please.

[nojvek]

Perfect. I will make it happen

…

On Thu, Mar 9, 2017 at 12:02 PM F. Hinkelmann ***@***.***> wrote: Sorry if I wasn't clear. debugger.md uses and defines a link to the debugging protocol. If we're using a reference-style link, we need to define it in the file where we use it. We can just copy this <https://github.com/nodejs/node/blame/master/doc/api/debugger.md#L215> definition to the end of cli.md. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11660 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVHYiaF0d7inu-qYprD1VkARjubsHks5rkFrogaJpZM4MRXMz> .

[cjihrig]

I think --inspect was initially added in 6.3.0. It might have changed slightly since then, but luckily we have per item changelogs now.

[cjihrig]

I think this was introduced in 7.6.0.

[nojvek]

Thanks, I'll update it.

…

On Mon, Mar 13, 2017 at 7:45 AM, Colin Ihrig ***@***.***> wrote: ***@***.**** requested changes on this pull request. ------------------------------ In doc/api/cli.md <#11660 (comment)>: > @@ -94,6 +94,25 @@ Follows `require()`'s module resolution rules. `module` may be either a path to a file, or a node module name. +### `--inspect[=host:port]` +<!-- YAML +added: v6.5.0 I think --inspect was initially added in 6.3.0 <https://nodejs.org/en/blog/release/v6.3.0/>. It might have changed slightly since then, but luckily we have per item changelogs now. ------------------------------ In doc/api/cli.md <#11660 (comment)>: > @@ -94,6 +94,25 @@ Follows `require()`'s module resolution rules. `module` may be either a path to a file, or a node module name. +### `--inspect[=host:port]` +<!-- YAML +added: v6.5.0 +--> + +Activate inspector on host:port. Default is 127.0.0.1:9229. + +V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js +instances for debugging and profiling. It uses the [Chrome Debugging Protocol][]. + + +### `--inspect-brk[=host:port]` +<!-- YAML +added: v6.5.0 I think this was introduced in 7.6.0 <https://nodejs.org/en/blog/release/v7.6.0/>. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11660 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVK1F6s6zv1MD4Y6E_7CSFW2TOr3Wks5rlVaHgaJpZM4MRXMz> .

[nojvek]

@cjihrig Thanks for the version number verification. I wasn't quite 100% sure how to do that.

I have updated the PR with your changes. Looks great, the links work. Would love to see this merged.

[nojvek]

Thanks Colin. I'm wondering who has to finally make a decision to make the merge? I first created a another PR regarding this almost an year ago. It'd make me dysphoric if it turned into another zombie PR.

…

On Tue, Mar 14, 2017 at 9:58 AM, Colin Ihrig ***@***.***> wrote: ***@***.**** approved this pull request. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11660 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVAmbJwVSZl2m6jOlDYEUpCvI606Vks5rlschgaJpZM4MRXMz> .

[jasnell]

small, nit... this could be reworded as:

V8 Inspector integration uses the [Chrome Debugging Protocol]{} to attach Node.js instances to debugging and profile tools such as Chrome DevTools and various IDEs. 

[cjihrig]

@nojvek any committer can land the PR. It should be good after @jasnell's nit is addressed. @fhinkel are you ok with it?

[nojvek]

@jasnell that actually seems confusing. It seems like Node.js is attaching to devtools but its other way around. How about this? ``` V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Node.js instances. The tools attach to Node.js instances on a tcp debug port and communicate using the [Chrome Debugging Protocol][] ```

…

On Tue, Mar 14, 2017 at 10:30 AM, James M Snell ***@***.***> wrote: ***@***.**** approved this pull request. ------------------------------ In doc/api/cli.md <#11660 (comment)>: > @@ -94,6 +94,25 @@ Follows `require()`'s module resolution rules. `module` may be either a path to a file, or a node module name. +### `--inspect[=host:port]` +<!-- YAML +added: v6.5.0 +--> + +Activate inspector on host:port. Default is 127.0.0.1:9229. + +V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js +instances for debugging and profiling. It uses the [Chrome Debugging Protocol][]. small, nit... this could be reworded as: V8 Inspector integration uses the [Chrome Debugging Protocol]{} to attach Node.js instances to debugging and profile tools such as Chrome DevTools and various IDEs. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11660 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVAfza5UFh_1lc0c0YEPu_1m-jqDLks5rls62gaJpZM4MRXMz> .

[jasnell]

small nit here... need to line wrap a max 80 chars

[nojvek]

will do.

…

On Tue, Mar 14, 2017 at 10:17 PM, James M Snell ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In doc/api/cli.md <#11660 (comment)>: > @@ -94,6 +94,23 @@ Follows `require()`'s module resolution rules. `module` may be either a path to a file, or a node module name. +### `--inspect[=host:port]` +<!-- YAML +added: v6.3.0 +--> + +Activate inspector on host:port. Default is 127.0.0.1:9229. + +V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Node.js instances. The tools attach to Node.js instances via a tcp port and communicate using the [Chrome Debugging Protocol][]. small nit here... need to line wrap a max 80 chars — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#11660 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVPmBucxCLgWpfLV7S9KvkgULCqVcks5rl3RQgaJpZM4MRXMz> .

[nojvek]

Done. Let me know if you need anything else.

…

On Wed, Mar 15, 2017 at 10:17 AM, Noj Vek ***@***.***> wrote: will do. On Tue, Mar 14, 2017 at 10:17 PM, James M Snell ***@***.***> wrote: > ***@***.**** commented on this pull request. > ------------------------------ > > In doc/api/cli.md > <#11660 (comment)>: > > > @@ -94,6 +94,23 @@ Follows `require()`'s module resolution > rules. `module` may be either a path to a file, or a node module name. > > > +### `--inspect[=host:port]` > +<!-- YAML > +added: v6.3.0 > +--> > + > +Activate inspector on host:port. Default is 127.0.0.1:9229. > + > +V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Node.js instances. The tools attach to Node.js instances via a tcp port and communicate using the [Chrome Debugging Protocol][]. > > small nit here... need to line wrap a max 80 chars > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#11660 (review)>, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/AA-JVPmBucxCLgWpfLV7S9KvkgULCqVcks5rl3RQgaJpZM4MRXMz> > . >

[jasnell]

Landed in 38299d2

[nojvek]

wohooo! 😁🎉🎉🎇🎇〽〽

…

On Fri, Mar 17, 2017 at 10:26 AM, James M Snell ***@***.***> wrote: ***@***.**** approved this pull request. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#11660 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVAw3QHztynnUl91i_Wt4nbo-GDC7ks5rmsJJgaJpZM4MRXMz> .

[joshgav]

Thanks @nojvek!