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

(backport) src/doc: improve man page and --help #10730

Closed
wants to merge 1 commit into from

Conversation

silverwind
Copy link
Contributor

@silverwind silverwind commented Jan 10, 2017

Backport of #10157 to v7.x-staging. cc: @evanlucas

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. v7.x labels Jan 10, 2017
@@ -117,6 +117,15 @@ Print a stack trace whenever synchronous I/O is detected after the first turn
of the event loop.

.TP
.BR \-\-trace\-events\-enabled
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't have this flag on v7.x

Copy link
Contributor Author

Choose a reason for hiding this comment

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

whoops, missed to remove these here, will fix.

Enables the collection of trace event tracing information.

.TP
.BR \-\-trace\-event\-categories " " \fIcategories\fR
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't have this flag either

Copy link
Member

Choose a reason for hiding this comment

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

doh! you're right! good catch

- add missing environment variables to --help
- add missing flags to man page
- sort environment variables alphabetically
- add some highlighting to the man page
- remove stops from descriptions in --help for consistency
- few other minor tweaks to --help

PR-URL: nodejs#10157
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Italo A. Casas <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
@silverwind
Copy link
Contributor Author

Fixed, thanks.

Copy link
Contributor

@evanlucas evanlucas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@silverwind silverwind changed the title src/doc: improve man page and --help (backport) src/doc: improve man page and --help Jan 12, 2017

.TP
.BR NODE_DISABLE_COLORS=1
When set to 1 colors will not be used in the REPL.
.BR NODE_EXTRA_CA_CERTS =\fIfile\fR
Copy link
Member

Choose a reason for hiding this comment

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

has this actually landed in v7 yet?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's in v7.x-staging at least:

node/src/node.cc

Line 4539 in e07b651

if (const char* extra = secure_getenv("NODE_EXTRA_CA_CERTS"))

Copy link
Contributor

Choose a reason for hiding this comment

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

Also in v7.x branch.

@silverwind
Copy link
Contributor Author

Landed on v7.x-staging: 61f6f12.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c++ Issues and PRs that require attention from people who are familiar with C++.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants