Mercurial > public > mercurial-scm > hg
diff mercurial/help/environment.txt @ 12083:ebfc46929f3e stable
help: refer to user configuration file more consistently
Currently, a number of commands and help topics mention the user hgrc
file in different ways. Among these are following:
1. .hgrc - "please specify your commit editor/username in your .hgrc
file", bookmarks, color, hgk, pager, hg help environment
2. $HOME/.hgrc - hg help paths, hgrc(5), hg(1)
3. ~/.hgrc - hgrc(5)
In addition to being inconsistent, none of these make sense on
Windows. This patch replaces the above with a more general term of
"[your] configuration file".
author | Brodie Rao <brodie@bitheap.org> |
---|---|
date | Fri, 27 Aug 2010 22:36:35 -0400 |
parents | 40dfd46d098f |
children | eddc20306ab6 |
line wrap: on
line diff
--- a/mercurial/help/environment.txt Sun Aug 29 23:16:31 2010 +0200 +++ b/mercurial/help/environment.txt Fri Aug 27 22:36:35 2010 -0400 @@ -8,7 +8,7 @@ HGEDITOR This is the name of the editor to run when committing. See EDITOR. - (deprecated, use .hgrc) + (deprecated, use configuration file) HGENCODING This overrides the default locale setting detected by Mercurial. @@ -29,13 +29,13 @@ will be executed with three arguments: local file, remote file, ancestor file. - (deprecated, use .hgrc) + (deprecated, use configuration file) HGRCPATH - A list of files or directories to search for hgrc files. Item - separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, - platform default search path is used. If empty, only the .hg/hgrc - from the current repository is read. + A list of files or directories to search for configuration + files. Item separator is ":" on Unix, ";" on Windows. If HGRCPATH + is not set, platform default search path is used. If empty, only + the .hg/hgrc from the current repository is read. For each element in HGRCPATH: @@ -43,9 +43,9 @@ - otherwise, the file itself will be added HGPLAIN - When set, this disables any options in .hgrc that might change - Mercurial's default output. This includes encoding, defaults, - verbose mode, debug mode, quiet mode, tracebacks, and + When set, this disables any configuration settings that might + change Mercurial's default output. This includes encoding, + defaults, verbose mode, debug mode, quiet mode, tracebacks, and localization. This can be useful when scripting against Mercurial in the face of existing user configuration. @@ -57,12 +57,12 @@ available values will be considered in this order: - HGUSER (deprecated) - - hgrc files from the HGRCPATH + - configuration files from the HGRCPATH - EMAIL - interactive prompt - LOGNAME (with ``@hostname`` appended) - (deprecated, use .hgrc) + (deprecated, use configuration file) EMAIL May be used as the author of a commit; see HGUSER.