Skip to content

Commit

Permalink
doc: update environment vars in manpage and --help
Browse files Browse the repository at this point in the history
- Added NODE_REPL_HISTORY to the environment variables in the --help
  and made all descriptions start with lower case for consistency.

- Added NODE_REPL_HISTORY and NODE_ICU_DATA to the man page.

PR-URL: #2690
Reviewed-By: fishrock123 - Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: evanlucas - Evan Lucas <evanlucas@me.com>
  • Loading branch information
silverwind committed Sep 4, 2015
1 parent 3a731da commit a6cb3a5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
8 changes: 7 additions & 1 deletion doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,15 @@ and servers.

.IP NODE_PATH
\':\'\-separated list of directories prefixed to the module search path.

.IP NODE_DISABLE_COLORS
If set to 1 then colors will not be used in the REPL.
.IP NODE_ICU_DATA
Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small-icu support.
.IP NODE_REPL_HISTORY
Path to the file used to store the persistent REPL history. The default path
is ~/.node_repl_history, which is overridden by this variable. Setting the
value to an empty string ("") disables persistent REPL history.

.SH V8 OPTIONS

Expand Down
7 changes: 4 additions & 3 deletions src/node.cc
Original file line number Diff line number Diff line change
Expand Up @@ -3066,7 +3066,7 @@ static void PrintHelp() {
" --icu-data-dir=dir set ICU data load path to dir\n"
" (overrides NODE_ICU_DATA)\n"
#if !defined(NODE_HAVE_SMALL_ICU)
" Note: linked-in ICU data is\n"
" note: linked-in ICU data is\n"
" present.\n"
#endif
#endif
Expand All @@ -3078,13 +3078,14 @@ static void PrintHelp() {
"NODE_PATH ':'-separated list of directories\n"
#endif
" prefixed to the module search path.\n"
"NODE_DISABLE_COLORS Set to 1 to disable colors in the REPL\n"
"NODE_DISABLE_COLORS set to 1 to disable colors in the REPL\n"
#if defined(NODE_HAVE_I18N_SUPPORT)
"NODE_ICU_DATA Data path for ICU (Intl object) data\n"
"NODE_ICU_DATA data path for ICU (Intl object) data\n"
#if !defined(NODE_HAVE_SMALL_ICU)
" (will extend linked-in data)\n"
#endif
#endif
"NODE_REPL_HISTORY path to the persistent REPL history file\n"
"\n"
"Documentation can be found at https://nodejs.org/\n");
}
Expand Down

2 comments on commit a6cb3a5

@silverwind
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Minor issue here: @Fishrock123's Reviewed-By line with the nick included exceeds our 72 character limit for the commit message body. I suggest getting a shorter e-mail :P

@Fishrock123
Copy link
Contributor

Choose a reason for hiding this comment

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

@silverwind just drop the usernames. This way we can also distinguish what was landed with the CI job.

Please sign in to comment.