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

Add documentation line for host:port invocation #28405

Closed

Conversation

@sleekweasel
Copy link

commented Jun 24, 2019

I just wasted a load of time not knowing how to invoke 'node inspect' with host:port to debug a process started with --inspect-port=0 because it didn't show up from a lot of Googling. Having it in the help text would have saved that.

@Trott
Copy link
Member

left a comment

Welcome @sleekweasel and thanks for the pull request. This looks good to me once the hard-coded IP address is removed per one of @richardlau's suggestions.

Update lib/internal/main/print_help.js
Co-Authored-By: Richard Lau <riclau@uk.ibm.com>
@sleekweasel

This comment has been minimized.

Copy link
Author

commented Jun 25, 2019

Argh, I can't believe I conflated localhost with the 192 network! It was a stressful, frustrating day.

@@ -164,7 +164,7 @@ function print(stream) {
options.set('--', { helpText: 'indicate the end of node options' });
stream.write(
'Usage: node [options] [ -e script | script.js | - ] [arguments]\n' +
' node inspect script.js [arguments]\n\n' +
' node inspect [script.js | -e "script" | <host>:<port>] …\n\n' +

This comment has been minimized.

Copy link
@Trott

Trott Jun 25, 2019

Member

This uses an ellipsis character () where everywhere else, we use three dots (...). On the one hand, the ellipsis is more correct. On the other hand, is there a situation where it will be an unprintable character because the terminal only accepts ASCII? Regardless, the code should probably pick one or the other and stick with it.

This comment has been minimized.

Copy link
@Trott

Trott Jul 6, 2019

Member

Linter requires non-ASCII characters (to keep binary size down, believe it or not) so ... it must be.

Also, this should probably align with line 166 in that no " around script and -e comes before the script.js option.

Assuming you left the default checked state for the checkbox about allowing collaborators in this repo to push to your branch, I'll make these updates right now....

@Trott
Trott approved these changes Jun 25, 2019
Copy link
Member

left a comment

LGTM with or without the ellipsis comment being addressed. (It can be addressed in a later pull request if it doesn't get addressed in this one. Might even be a good first contribution for someone.)

@BridgeAR

This comment has been minimized.

@BridgeAR

This comment has been minimized.

Copy link
Member

commented Jul 4, 2019

The commit message should be updated either before landing or while landing and it should include the subsystem (Seems like lib would suffice here).

@Trott

This comment has been minimized.

Copy link
Member

commented Jul 6, 2019

I got rid of -e and - because they are already mentioned in the options list. Folks who reviewed, please take a look. Whoever lands this (I volunteer!) will have to edit that info into the commit message.

@BridgeAR @gireeshpunathil @richardlau

@Trott

This comment has been minimized.

@Trott

This comment has been minimized.

Copy link
Member

commented Jul 12, 2019

Landed in 7008d78

@Trott Trott closed this Jul 12, 2019

Trott added a commit to Trott/io.js that referenced this pull request Jul 12, 2019
doc: add line for inspect host:port invocation
PR-URL: nodejs#28405
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
targos added a commit that referenced this pull request Jul 20, 2019
doc: add line for inspect host:port invocation
PR-URL: #28405
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This was referenced Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.