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

doc: add a cli options doc page #5787

Merged
merged 1 commit into from
Mar 21, 2016
Merged

doc: add a cli options doc page #5787

merged 1 commit into from
Mar 21, 2016

Conversation

Fishrock123
Copy link
Contributor

Pull Request check-list

  • Does make -j8 test (UNIX) or vcbuild test nosign (Windows) pass with
    this change (including linting)?
  • Is the commit message formatted according to CONTRIBUTING.md?
  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

Affected core subsystem(s)

doc

Description of change

This page is mostly a mirror of the updated manual page. This came about as a result of this twitter conversation, and I realized there wasn't an easy way to get the options documentation from the website.

cc @nodejs/documentation

Edit: Rendered (but our css makes it look slightly different)

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Mar 18, 2016
cjihrig
cjihrig reviewed Mar 18, 2016
View reviewed changes
doc/api/cli.markdown
Specify ICU data load path. (overrides `NODE_ICU_DATA`)


## ENVIRONMENT VARIABLES
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need to be all caps?

@cjihrig
Copy link
Contributor

cjihrig commented Mar 18, 2016

LGTM with a couple comments.

@Fishrock123 Fishrock123 force-pushed the doc-cli-options branch 2 times, most recently from 70ac750 to 5326d92 Compare March 18, 2016 17:43
@jasnell
Copy link
Member

jasnell commented Mar 18, 2016

LGTM
woohoo!
/cc @nodejs/documentation

chrisdickinson
chrisdickinson reviewed Mar 18, 2016
View reviewed changes
doc/api/cli.markdown

<!--type=misc-->

Node.js come with a wide variety of CLI options with multiple ways to execute scripts, built-in debugging, and a handful of other helpers.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

Node.js comes with a wide variety of CLI options. These options expose multiple ways to execute scripts, built-in debugging, and other helpful runtime options.

@bengl
Copy link
Member

bengl commented Mar 18, 2016

Line wrapping is somewhat inconsistent. Perhaps wrap it at 80?

Fishrock123
Fishrock123 reviewed Mar 18, 2016
View reviewed changes
doc/api/cli.markdown

<!--type=misc-->

Node.js comes with a wide variety of CLI options. These options expose built-in debugging, multiple ways to execute scripts, and other helpful runtime options.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@chrisdickinson Worded it this way so that it didn't sound like "multiple" applied to everything.

@Fishrock123
Copy link
Contributor Author

@bengl Fixed. I forgot about that when copying from the man page.

@bengl
Copy link
Member

bengl commented Mar 18, 2016

@Fishrock123 lines 5 and 154?

@Fishrock123
Copy link
Contributor Author

Oops, didn't notice my editor was wrapping there, thought I had inserted spaces. Fixed.

@bengl
Copy link
Member

bengl commented Mar 18, 2016

Cool, LGTM!

@eljefedelrodeodeljefe
Copy link
Contributor

Yep, nice. LGTM.

@benjamingr
Copy link
Member

Awesome work on all the recent docs PRs lately @Fishrock123 !

benjamingr
benjamingr reviewed Mar 19, 2016
View reviewed changes
doc/api/cli.markdown

<!--type=misc-->

Node.js comes with a wide variety of CLI options. These options expose built-in
Copy link
Member

Choose a reason for hiding this comment

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

CLI options -> command line options perhaps? Are we sure all the users are familiar with the term? Windows users in particular...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was hoping that the title would clarify it, but I suppose I can can do this.

@benjamingr
Copy link
Member

LGTM with nits. To clarify none of the nits prevent the merge IMO and they can be addressed at a later point or now depending on @Fishrock123's opinion.

@Fishrock123
Copy link
Contributor Author

I would have liked if some of this feedback was done when I wrote some of these in the man doc refactor. D:

@eljefedelrodeodeljefe
Copy link
Contributor

I'd be against the nits, since it will become inconsistent to node -h. I'd say land now, improve later (IMO don't do anything). Still LGTM.

@benjamingr
Copy link
Member

To be clear - I'm in the same opinion of @eljefedelrodeodeljefe of land now merge later.

@Fishrock123
Copy link
Contributor Author

ok landing this as-is and making a new updating PR

I'm afraid for this there isn't a better way to keep it in sync, formatting differences and other nits vary quite a bit from the --help, node.1, and this document.

@Fishrock123
Copy link
Contributor Author

Actually, I'm going to add to the comment in https://github.com/nodejs/node/blob/master/src/node.cc#L3296 in this PR also, just to try to help keep them in sync.

@Fishrock123
Copy link
Contributor Author

Ci, since this now modifies node.cc with a comment: https://ci.nodejs.org/job/node-test-pull-request/1992/

@Fishrock123
Copy link
Contributor Author

(Also I added a comment about NODE_PATH that only effects windows, which is less necessary in the man page since manual pages don't really exist on windows.

@Fishrock123
doc: add a cli options doc page
91cf55b 
This page is mostly a mirror of the updated manual page.

PR-URL: nodejs#5787
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
@Fishrock123 Fishrock123 reopened this Mar 21, 2016
@Fishrock123 Fishrock123 merged commit 91cf55b into nodejs:master Mar 21, 2016
@Fishrock123
Copy link
Contributor Author

Oops.

Landed in 91cf55b, will make a new PR to fix some of the docs in multiple spots like tomorrow.

@Fishrock123 Fishrock123 mentioned this pull request Mar 22, 2016
Merged
Fishrock123 added a commit that referenced this pull request Mar 22, 2016
@Fishrock123
doc: add a cli options doc page
e99082e 
This page is mostly a mirror of the updated manual page.

PR-URL: #5787
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
@Fishrock123
doc: add a cli options doc page
6be2acd 
This page is mostly a mirror of the updated manual page.

PR-URL: #5787
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
@Fishrock123
doc: add a cli options doc page
e43e8e3 
This page is mostly a mirror of the updated manual page.

PR-URL: #5787
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@Fishrock123 @cjihrig @jasnell @bengl @eljefedelrodeodeljefe @benjamingr @chrisdickinson @MylesBorins