Fixes #7065: cli help documentation for --debug and --debug-brk

[nojvek]

Checklist

• tests and code linting passes
• a test and/or benchmark is included
• documentation is changed or added
• the commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

Cli documentation for --debug and --debug-brk when node -h is invoked.

cc @Fishrock123

[bnoordhuis]

Long line (80 columns max) and sentences should be properly capitalized. The version number is not correct but I don't really remember when they were added.

[bnoordhuis]

I'd advise against documenting --debug-brk for now. It doesn't really work as advertised and its behavior may change, see #3589.

[Fishrock123]

node debug should really have it's own node-debug.1 man page, fwiw.

[nojvek]

Debug-Brk works for 99% of use cases right? Should an edge case stop it
from being advertised?

Regarding node-debug.1 page, what should go into it?

On Wednesday, June 1, 2016, Jeremiah Senkpiel notifications@github.com
wrote:

node debug should really have it;s own node-debug.1 man page, fwiw.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#7086 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AA-JVI0BQn6QjS7GJ0aoTWuEjogPIsBeks5qHZXLgaJpZM4IrEx_
.

[bnoordhuis]

Debug-Brk works for 99% of use cases right? Should an edge case stop it from being advertised?

Yes, because how it works is almost certainly going to change. If it's documented, we risk breaking code that depends on the current behavior.

[nojvek]

makes sense. Thanks for the explanation.

So the plan is to Remove debug-brk, and keep --debug right ?

Once you confirm, I'll send an update to the PR.

On Wed, Jun 1, 2016 at 8:57 AM, Ben Noordhuis notifications@github.com
wrote:

Debug-Brk works for 99% of use cases right? Should an edge case stop it
from being advertised?

Yes, because how it works is almost certainly going to change. If it's
documented, we risk breaking code that depends on the current behavior.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#7086 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AA-JVAE-qvUmRbcnstix9UUtBqiDnKGfks5qHavvgaJpZM4IrEx_
.

[bnoordhuis]

So the plan is to Remove debug-brk, and keep --debug right ?

Yes.

[owenallenaz]

Looking at the referenced issue #3589 it appears that was solved and closed. With that in mind is --debug-brk still a feature that is going to be cut? I find value in the feature and was hoping to fix the cluster module to properly support it since waiting until a debugger has attached is essential for handling debugging content on start-up and I'm not aware of another way of tackling it.

[joshgav]

Oh, I didn't notice this PR and added the CLI docs in the PR for --inspect-brk: #8979.

@nojvek want to update the rest of the docs to target "inspect" instead and then land? Thank you!

[nojvek]

This is the fairly old PR. Not sure about current state of inspect. Is it considered stable and ready for release? So should I update my PR for inspect rather than debug right ?

…

On Mon, Jan 9, 2017 at 1:56 PM Josh Gavant ***@***.***> wrote: Oh, I didn't notice this PR and added the CLI docs in the PR for --inspect-brk: #8979 <#8979>. @nojvek <https://github.com/nojvek> want to update the rest of the docs to target "inspect" instead and then land? Thank you! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#7086 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVGtC9rmM0vQsQkd-B2UadcZGT0G_ks5rQq0EgaJpZM4IrEx_> .

[jasnell]

@nodejs/v8-inspector ... is this still needed?

[joshgav]

We don't need docs for --debug anymore, but do need to add --inspect and node inspect to the same file (./doc/api/cli.md). @nojvek would be great if you want to do that, I guess in a new PR. Thank you!

If we want to write a man page for node inspect as proposed above for node debug I think it belongs in the node-inspect repo.

[nojvek]

Okay will submit separate PR.

…

On Tue, Feb 28, 2017 at 7:50 PM Josh Gavant ***@***.***> wrote: We don't need docs for --debug anymore, but do need to add --inspect and node inspect to the same file (./doc/api/cli.md <https://github.com/nodejs/node/blob/master/doc/api/cli.md>). @nojvek <https://github.com/nojvek> would be great if you want to do that, I guess in a new PR. Thank you! If we want to write a man page for node inspect as proposed above for node debug I think it belongs in the node-inspect repo <https://github.com/nodejs/node-inspect>. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#7086 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVIpL-3Ibjz-x-DZSF1xiPx2fr9sxks5rhOsMgaJpZM4IrEx_> .

[jasnell]

I assume then that it's ok to close this PR?

[nojvek]

@jasnell you can close this PR.

@joshgav made new PR for cli.md inspect documentation #11660 . Please review