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

cli help documentation for --inspect #7065

Closed
nojvek opened this issue May 30, 2016 · 6 comments
Closed

cli help documentation for --inspect #7065

nojvek opened this issue May 30, 2016 · 6 comments
Labels
blocked PRs that are blocked by other issues or PRs. doc Issues and PRs related to the documentations. inspector Issues and PRs related to the V8 inspector protocol

Comments

@nojvek
Copy link

nojvek commented May 30, 2016

Now that --inspect is in, there should be documentation in node -h about inspect, debug, debug-brk, debug-port params.

I volunteer to send this as my first node PR. I believe @Fishrock123 mentioned where I need to make this edits.
@mscdex mscdex added the doc Issues and PRs related to the documentations. label May 30, 2016
@MylesBorins
Copy link
Contributor

@nojvek I'm not sure that there is currently consensus on if this should be documented or not yet... it is not yet considered a stable feature and as such documentation may give the wrong impression (for --inspect).

I'm not sure the best road forward regarding the current debugger.

/cc @nodejs/documentation

@nojvek
Copy link
Author

nojvek commented May 30, 2016

I'm fine with whatever the node gods decide. I think debug, debug-brk and
debug-help should be in the cli help though. I should go ahead with that
right?

What's the criteria for something to be marked as stable?

On Monday, May 30, 2016, Myles Borins notifications@github.com wrote:

@nojvek https://github.com/nojvek I'm not sure that there is currently
consensus on if this should be documented or not yet... it is not yet
considered a stable feature and as such documentation may give the wrong
impression (for --inspect).

I'm not sure the best road forward regarding the current debugger.

/cc @nodejs/documentation
https://github.com/orgs/nodejs/teams/documentation

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

@benjamingr
Copy link
Member

I'm against documenting it at the moment. It's experimental support and we won't be able to properly support usages.

@Fishrock123 Fishrock123 added the blocked PRs that are blocked by other issues or PRs. label May 31, 2016
@nojvek nojvek changed the title cli help documentation for --inspect and --debug cli help documentation for --debug Jun 1, 2016
@nojvek nojvek changed the title cli help documentation for --debug cli help documentation for --debug and --debug-brk Jun 1, 2016
@nojvek
Copy link
Author

nojvek commented Jun 1, 2016 •
edited
Loading

Only adding --debug and --debug-brk. See #7086

/cc @nodejs/documentation

@Fishrock123, should this be still labeled blocked?

@Fishrock123
Copy link
Contributor

A new issue should have been made, changing this back to be about --inspect. Just the pr for those is fine.

@Fishrock123 Fishrock123 changed the title cli help documentation for --debug and --debug-brk cli help documentation for --inspect Jun 1, 2016
@nojvek
Copy link
Author

nojvek commented Jun 1, 2016

I'm sorry I'm confused now. I thought the plan was not to have inspect in
node -h. Its usage is already documented in debugger.md

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

A new issue should have been made, changing this back to be about
--inspect. Just the pr for those is fine.

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

@mscdex mscdex added inspector Issues and PRs related to the V8 inspector protocol and removed debugger labels Jun 3, 2016
jungx098 pushed a commit to jungx098/node that referenced this issue Mar 21, 2017
@jungx098
Fix nodejs#7065: cli help documentation for --inspect
4797a3d 
Adding documentation to node.1 and cli.md

PR-URL: nodejs#11660
Reviewed-By: Eugene Ostroukhov <eostroukhov@google.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas pushed a commit to italoacasas/node that referenced this issue Mar 21, 2017
@italoacasas
Fix nodejs#7065: cli help documentation for --inspect
0c00b65 
Adding documentation to node.1 and cli.md

PR-URL: nodejs#11660
Reviewed-By: Eugene Ostroukhov <eostroukhov@google.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@italoacasas italoacasas mentioned this issue Mar 21, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocked PRs that are blocked by other issues or PRs. doc Issues and PRs related to the documentations. inspector Issues and PRs related to the V8 inspector protocol
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mscdex @MylesBorins @nojvek @Fishrock123 @benjamingr