comparison mercurial/help.py @ 7805:cf6ec23a1bb5

help: better explanation for some of the environment variables In particular, the precedence for usernames is explained in more detail. Thanks to timeless for pointing out the deficiencies here.
author Dirkjan Ochtman <dirkjan@ochtman.nl>
date Sat, 28 Feb 2009 12:23:23 +0100
parents 06afe0f9dbf8
children 6d0cf2a2acad
comparison
equal deleted inserted replaced
7804:06afe0f9dbf8 7805:cf6ec23a1bb5
132 A list of files or directories to search for hgrc files. Item 132 A list of files or directories to search for hgrc files. Item
133 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, 133 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set,
134 platform default search path is used. If empty, only the .hg/hgrc 134 platform default search path is used. If empty, only the .hg/hgrc
135 from the current repository is read. 135 from the current repository is read.
136 136
137 For each element in path, if a directory, all entries in directory 137 For each element in HGRCPATH:
138 ending with ".rc" are added to path. Else, element itself is 138 * if it's a directory, all directories ending with .rc are added
139 added to path. 139 * otherwise, the directory itself will be added
140 140
141 HGUSER:: 141 HGUSER::
142 This is the string used as the author of a commit. 142 This is the string used as the author of a commit. If not set,
143 available values will be considered in this order:
144
145 * HGUSER (deprecated)
146 * hgrc files from the HGRCPATH
147 * EMAIL
148 * interactive prompt
149 * LOGNAME (with '@hostname' appended)
143 150
144 (deprecated, use .hgrc) 151 (deprecated, use .hgrc)
145 152
146 EMAIL:: 153 EMAIL::
147 If HGUSER is not set, this will be used as the author for a commit. 154 May be used as the author of a commit; see HGUSER.
148 155
149 LOGNAME:: 156 LOGNAME::
150 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with 157 May be used as the author of a commit; see HGUSER.
151 '@hostname' appended) as the author value of a commit.
152 158
153 VISUAL:: 159 VISUAL::
154 This is the name of the editor to use when committing. See EDITOR. 160 This is the name of the editor to use when committing. See EDITOR.
155 161
156 EDITOR:: 162 EDITOR::