##// END OF EJS Templates
ui: add new config flag for interface selection...
Simon Farnsworth -
r28542:71e12fc5 default
parent child Browse files
Show More
@@ -1,2070 +1,2079 b''
1 The Mercurial system uses a set of configuration files to control
1 The Mercurial system uses a set of configuration files to control
2 aspects of its behavior.
2 aspects of its behavior.
3
3
4 Troubleshooting
4 Troubleshooting
5 ===============
5 ===============
6
6
7 If you're having problems with your configuration,
7 If you're having problems with your configuration,
8 :hg:`config --debug` can help you understand what is introducing
8 :hg:`config --debug` can help you understand what is introducing
9 a setting into your environment.
9 a setting into your environment.
10
10
11 See :hg:`help config.syntax` and :hg:`help config.files`
11 See :hg:`help config.syntax` and :hg:`help config.files`
12 for information about how and where to override things.
12 for information about how and where to override things.
13
13
14 Structure
14 Structure
15 =========
15 =========
16
16
17 The configuration files use a simple ini-file format. A configuration
17 The configuration files use a simple ini-file format. A configuration
18 file consists of sections, led by a ``[section]`` header and followed
18 file consists of sections, led by a ``[section]`` header and followed
19 by ``name = value`` entries::
19 by ``name = value`` entries::
20
20
21 [ui]
21 [ui]
22 username = Firstname Lastname <firstname.lastname@example.net>
22 username = Firstname Lastname <firstname.lastname@example.net>
23 verbose = True
23 verbose = True
24
24
25 The above entries will be referred to as ``ui.username`` and
25 The above entries will be referred to as ``ui.username`` and
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27
27
28 Files
28 Files
29 =====
29 =====
30
30
31 Mercurial reads configuration data from several files, if they exist.
31 Mercurial reads configuration data from several files, if they exist.
32 These files do not exist by default and you will have to create the
32 These files do not exist by default and you will have to create the
33 appropriate configuration files yourself:
33 appropriate configuration files yourself:
34
34
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36
36
37 Global configuration like the username setting is typically put into:
37 Global configuration like the username setting is typically put into:
38
38
39 .. container:: windows
39 .. container:: windows
40
40
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42
42
43 .. container:: unix.plan9
43 .. container:: unix.plan9
44
44
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46
46
47 The names of these files depend on the system on which Mercurial is
47 The names of these files depend on the system on which Mercurial is
48 installed. ``*.rc`` files from a single directory are read in
48 installed. ``*.rc`` files from a single directory are read in
49 alphabetical order, later ones overriding earlier ones. Where multiple
49 alphabetical order, later ones overriding earlier ones. Where multiple
50 paths are given below, settings from earlier paths override later
50 paths are given below, settings from earlier paths override later
51 ones.
51 ones.
52
52
53 .. container:: verbose.unix
53 .. container:: verbose.unix
54
54
55 On Unix, the following files are consulted:
55 On Unix, the following files are consulted:
56
56
57 - ``<repo>/.hg/hgrc`` (per-repository)
57 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``$HOME/.hgrc`` (per-user)
58 - ``$HOME/.hgrc`` (per-user)
59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 - ``/etc/mercurial/hgrc`` (per-system)
61 - ``/etc/mercurial/hgrc`` (per-system)
62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 - ``<internal>/default.d/*.rc`` (defaults)
63 - ``<internal>/default.d/*.rc`` (defaults)
64
64
65 .. container:: verbose.windows
65 .. container:: verbose.windows
66
66
67 On Windows, the following files are consulted:
67 On Windows, the following files are consulted:
68
68
69 - ``<repo>/.hg/hgrc`` (per-repository)
69 - ``<repo>/.hg/hgrc`` (per-repository)
70 - ``%USERPROFILE%\.hgrc`` (per-user)
70 - ``%USERPROFILE%\.hgrc`` (per-user)
71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 - ``%HOME%\.hgrc`` (per-user)
72 - ``%HOME%\.hgrc`` (per-user)
73 - ``%HOME%\Mercurial.ini`` (per-user)
73 - ``%HOME%\Mercurial.ini`` (per-user)
74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 - ``<install-dir>\Mercurial.ini`` (per-installation)
76 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 - ``<internal>/default.d/*.rc`` (defaults)
77 - ``<internal>/default.d/*.rc`` (defaults)
78
78
79 .. note::
79 .. note::
80
80
81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 is used when running 32-bit Python on 64-bit Windows.
82 is used when running 32-bit Python on 64-bit Windows.
83
83
84 .. container:: windows
84 .. container:: windows
85
85
86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87
87
88 .. container:: verbose.plan9
88 .. container:: verbose.plan9
89
89
90 On Plan9, the following files are consulted:
90 On Plan9, the following files are consulted:
91
91
92 - ``<repo>/.hg/hgrc`` (per-repository)
92 - ``<repo>/.hg/hgrc`` (per-repository)
93 - ``$home/lib/hgrc`` (per-user)
93 - ``$home/lib/hgrc`` (per-user)
94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 - ``/lib/mercurial/hgrc`` (per-system)
96 - ``/lib/mercurial/hgrc`` (per-system)
97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 - ``<internal>/default.d/*.rc`` (defaults)
98 - ``<internal>/default.d/*.rc`` (defaults)
99
99
100 Per-repository configuration options only apply in a
100 Per-repository configuration options only apply in a
101 particular repository. This file is not version-controlled, and
101 particular repository. This file is not version-controlled, and
102 will not get transferred during a "clone" operation. Options in
102 will not get transferred during a "clone" operation. Options in
103 this file override options in all other configuration files.
103 this file override options in all other configuration files.
104
104
105 .. container:: unix.plan9
105 .. container:: unix.plan9
106
106
107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 belong to a trusted user or to a trusted group. See
108 belong to a trusted user or to a trusted group. See
109 :hg:`help config.trusted` for more details.
109 :hg:`help config.trusted` for more details.
110
110
111 Per-user configuration file(s) are for the user running Mercurial. Options
111 Per-user configuration file(s) are for the user running Mercurial. Options
112 in these files apply to all Mercurial commands executed by this user in any
112 in these files apply to all Mercurial commands executed by this user in any
113 directory. Options in these files override per-system and per-installation
113 directory. Options in these files override per-system and per-installation
114 options.
114 options.
115
115
116 Per-installation configuration files are searched for in the
116 Per-installation configuration files are searched for in the
117 directory where Mercurial is installed. ``<install-root>`` is the
117 directory where Mercurial is installed. ``<install-root>`` is the
118 parent directory of the **hg** executable (or symlink) being run.
118 parent directory of the **hg** executable (or symlink) being run.
119
119
120 .. container:: unix.plan9
120 .. container:: unix.plan9
121
121
122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 files apply to all Mercurial commands executed by any user in any
124 files apply to all Mercurial commands executed by any user in any
125 directory.
125 directory.
126
126
127 Per-installation configuration files are for the system on
127 Per-installation configuration files are for the system on
128 which Mercurial is running. Options in these files apply to all
128 which Mercurial is running. Options in these files apply to all
129 Mercurial commands executed by any user in any directory. Registry
129 Mercurial commands executed by any user in any directory. Registry
130 keys contain PATH-like strings, every part of which must reference
130 keys contain PATH-like strings, every part of which must reference
131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 be read. Mercurial checks each of these locations in the specified
132 be read. Mercurial checks each of these locations in the specified
133 order until one or more configuration files are detected.
133 order until one or more configuration files are detected.
134
134
135 Per-system configuration files are for the system on which Mercurial
135 Per-system configuration files are for the system on which Mercurial
136 is running. Options in these files apply to all Mercurial commands
136 is running. Options in these files apply to all Mercurial commands
137 executed by any user in any directory. Options in these files
137 executed by any user in any directory. Options in these files
138 override per-installation options.
138 override per-installation options.
139
139
140 Mercurial comes with some default configuration. The default configuration
140 Mercurial comes with some default configuration. The default configuration
141 files are installed with Mercurial and will be overwritten on upgrades. Default
141 files are installed with Mercurial and will be overwritten on upgrades. Default
142 configuration files should never be edited by users or administrators but can
142 configuration files should never be edited by users or administrators but can
143 be overridden in other configuration files. So far the directory only contains
143 be overridden in other configuration files. So far the directory only contains
144 merge tool configuration but packagers can also put other default configuration
144 merge tool configuration but packagers can also put other default configuration
145 there.
145 there.
146
146
147 Syntax
147 Syntax
148 ======
148 ======
149
149
150 A configuration file consists of sections, led by a ``[section]`` header
150 A configuration file consists of sections, led by a ``[section]`` header
151 and followed by ``name = value`` entries (sometimes called
151 and followed by ``name = value`` entries (sometimes called
152 ``configuration keys``)::
152 ``configuration keys``)::
153
153
154 [spam]
154 [spam]
155 eggs=ham
155 eggs=ham
156 green=
156 green=
157 eggs
157 eggs
158
158
159 Each line contains one entry. If the lines that follow are indented,
159 Each line contains one entry. If the lines that follow are indented,
160 they are treated as continuations of that entry. Leading whitespace is
160 they are treated as continuations of that entry. Leading whitespace is
161 removed from values. Empty lines are skipped. Lines beginning with
161 removed from values. Empty lines are skipped. Lines beginning with
162 ``#`` or ``;`` are ignored and may be used to provide comments.
162 ``#`` or ``;`` are ignored and may be used to provide comments.
163
163
164 Configuration keys can be set multiple times, in which case Mercurial
164 Configuration keys can be set multiple times, in which case Mercurial
165 will use the value that was configured last. As an example::
165 will use the value that was configured last. As an example::
166
166
167 [spam]
167 [spam]
168 eggs=large
168 eggs=large
169 ham=serrano
169 ham=serrano
170 eggs=small
170 eggs=small
171
171
172 This would set the configuration key named ``eggs`` to ``small``.
172 This would set the configuration key named ``eggs`` to ``small``.
173
173
174 It is also possible to define a section multiple times. A section can
174 It is also possible to define a section multiple times. A section can
175 be redefined on the same and/or on different configuration files. For
175 be redefined on the same and/or on different configuration files. For
176 example::
176 example::
177
177
178 [foo]
178 [foo]
179 eggs=large
179 eggs=large
180 ham=serrano
180 ham=serrano
181 eggs=small
181 eggs=small
182
182
183 [bar]
183 [bar]
184 eggs=ham
184 eggs=ham
185 green=
185 green=
186 eggs
186 eggs
187
187
188 [foo]
188 [foo]
189 ham=prosciutto
189 ham=prosciutto
190 eggs=medium
190 eggs=medium
191 bread=toasted
191 bread=toasted
192
192
193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 respectively. As you can see there only thing that matters is the last
195 respectively. As you can see there only thing that matters is the last
196 value that was set for each of the configuration keys.
196 value that was set for each of the configuration keys.
197
197
198 If a configuration key is set multiple times in different
198 If a configuration key is set multiple times in different
199 configuration files the final value will depend on the order in which
199 configuration files the final value will depend on the order in which
200 the different configuration files are read, with settings from earlier
200 the different configuration files are read, with settings from earlier
201 paths overriding later ones as described on the ``Files`` section
201 paths overriding later ones as described on the ``Files`` section
202 above.
202 above.
203
203
204 A line of the form ``%include file`` will include ``file`` into the
204 A line of the form ``%include file`` will include ``file`` into the
205 current configuration file. The inclusion is recursive, which means
205 current configuration file. The inclusion is recursive, which means
206 that included files can include other files. Filenames are relative to
206 that included files can include other files. Filenames are relative to
207 the configuration file in which the ``%include`` directive is found.
207 the configuration file in which the ``%include`` directive is found.
208 Environment variables and ``~user`` constructs are expanded in
208 Environment variables and ``~user`` constructs are expanded in
209 ``file``. This lets you do something like::
209 ``file``. This lets you do something like::
210
210
211 %include ~/.hgrc.d/$HOST.rc
211 %include ~/.hgrc.d/$HOST.rc
212
212
213 to include a different configuration file on each computer you use.
213 to include a different configuration file on each computer you use.
214
214
215 A line with ``%unset name`` will remove ``name`` from the current
215 A line with ``%unset name`` will remove ``name`` from the current
216 section, if it has been set previously.
216 section, if it has been set previously.
217
217
218 The values are either free-form text strings, lists of text strings,
218 The values are either free-form text strings, lists of text strings,
219 or Boolean values. Boolean values can be set to true using any of "1",
219 or Boolean values. Boolean values can be set to true using any of "1",
220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 (all case insensitive).
221 (all case insensitive).
222
222
223 List values are separated by whitespace or comma, except when values are
223 List values are separated by whitespace or comma, except when values are
224 placed in double quotation marks::
224 placed in double quotation marks::
225
225
226 allow_read = "John Doe, PhD", brian, betty
226 allow_read = "John Doe, PhD", brian, betty
227
227
228 Quotation marks can be escaped by prefixing them with a backslash. Only
228 Quotation marks can be escaped by prefixing them with a backslash. Only
229 quotation marks at the beginning of a word is counted as a quotation
229 quotation marks at the beginning of a word is counted as a quotation
230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231
231
232 Sections
232 Sections
233 ========
233 ========
234
234
235 This section describes the different sections that may appear in a
235 This section describes the different sections that may appear in a
236 Mercurial configuration file, the purpose of each section, its possible
236 Mercurial configuration file, the purpose of each section, its possible
237 keys, and their possible values.
237 keys, and their possible values.
238
238
239 ``alias``
239 ``alias``
240 ---------
240 ---------
241
241
242 Defines command aliases.
242 Defines command aliases.
243
243
244 Aliases allow you to define your own commands in terms of other
244 Aliases allow you to define your own commands in terms of other
245 commands (or aliases), optionally including arguments. Positional
245 commands (or aliases), optionally including arguments. Positional
246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 are expanded by Mercurial before execution. Positional arguments not
247 are expanded by Mercurial before execution. Positional arguments not
248 already used by ``$N`` in the definition are put at the end of the
248 already used by ``$N`` in the definition are put at the end of the
249 command to be executed.
249 command to be executed.
250
250
251 Alias definitions consist of lines of the form::
251 Alias definitions consist of lines of the form::
252
252
253 <alias> = <command> [<argument>]...
253 <alias> = <command> [<argument>]...
254
254
255 For example, this definition::
255 For example, this definition::
256
256
257 latest = log --limit 5
257 latest = log --limit 5
258
258
259 creates a new command ``latest`` that shows only the five most recent
259 creates a new command ``latest`` that shows only the five most recent
260 changesets. You can define subsequent aliases using earlier ones::
260 changesets. You can define subsequent aliases using earlier ones::
261
261
262 stable5 = latest -b stable
262 stable5 = latest -b stable
263
263
264 .. note::
264 .. note::
265
265
266 It is possible to create aliases with the same names as
266 It is possible to create aliases with the same names as
267 existing commands, which will then override the original
267 existing commands, which will then override the original
268 definitions. This is almost always a bad idea!
268 definitions. This is almost always a bad idea!
269
269
270 An alias can start with an exclamation point (``!``) to make it a
270 An alias can start with an exclamation point (``!``) to make it a
271 shell alias. A shell alias is executed with the shell and will let you
271 shell alias. A shell alias is executed with the shell and will let you
272 run arbitrary commands. As an example, ::
272 run arbitrary commands. As an example, ::
273
273
274 echo = !echo $@
274 echo = !echo $@
275
275
276 will let you do ``hg echo foo`` to have ``foo`` printed in your
276 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 terminal. A better example might be::
277 terminal. A better example might be::
278
278
279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
280
280
281 which will make ``hg purge`` delete all unknown files in the
281 which will make ``hg purge`` delete all unknown files in the
282 repository in the same manner as the purge extension.
282 repository in the same manner as the purge extension.
283
283
284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 expand to the command arguments. Unmatched arguments are
285 expand to the command arguments. Unmatched arguments are
286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 arguments quoted individually and separated by a space. These expansions
288 arguments quoted individually and separated by a space. These expansions
289 happen before the command is passed to the shell.
289 happen before the command is passed to the shell.
290
290
291 Shell aliases are executed in an environment where ``$HG`` expands to
291 Shell aliases are executed in an environment where ``$HG`` expands to
292 the path of the Mercurial that was used to execute the alias. This is
292 the path of the Mercurial that was used to execute the alias. This is
293 useful when you want to call further Mercurial commands in a shell
293 useful when you want to call further Mercurial commands in a shell
294 alias, as was done above for the purge alias. In addition,
294 alias, as was done above for the purge alias. In addition,
295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297
297
298 .. note::
298 .. note::
299
299
300 Some global configuration options such as ``-R`` are
300 Some global configuration options such as ``-R`` are
301 processed before shell aliases and will thus not be passed to
301 processed before shell aliases and will thus not be passed to
302 aliases.
302 aliases.
303
303
304
304
305 ``annotate``
305 ``annotate``
306 ------------
306 ------------
307
307
308 Settings used when displaying file annotations. All values are
308 Settings used when displaying file annotations. All values are
309 Booleans and default to False. See :hg:`help config.diff` for
309 Booleans and default to False. See :hg:`help config.diff` for
310 related options for the diff command.
310 related options for the diff command.
311
311
312 ``ignorews``
312 ``ignorews``
313 Ignore white space when comparing lines.
313 Ignore white space when comparing lines.
314
314
315 ``ignorewsamount``
315 ``ignorewsamount``
316 Ignore changes in the amount of white space.
316 Ignore changes in the amount of white space.
317
317
318 ``ignoreblanklines``
318 ``ignoreblanklines``
319 Ignore changes whose lines are all blank.
319 Ignore changes whose lines are all blank.
320
320
321
321
322 ``auth``
322 ``auth``
323 --------
323 --------
324
324
325 Authentication credentials for HTTP authentication. This section
325 Authentication credentials for HTTP authentication. This section
326 allows you to store usernames and passwords for use when logging
326 allows you to store usernames and passwords for use when logging
327 *into* HTTP servers. See :hg:`help config.web` if
327 *into* HTTP servers. See :hg:`help config.web` if
328 you want to configure *who* can login to your HTTP server.
328 you want to configure *who* can login to your HTTP server.
329
329
330 Each line has the following format::
330 Each line has the following format::
331
331
332 <name>.<argument> = <value>
332 <name>.<argument> = <value>
333
333
334 where ``<name>`` is used to group arguments into authentication
334 where ``<name>`` is used to group arguments into authentication
335 entries. Example::
335 entries. Example::
336
336
337 foo.prefix = hg.intevation.de/mercurial
337 foo.prefix = hg.intevation.de/mercurial
338 foo.username = foo
338 foo.username = foo
339 foo.password = bar
339 foo.password = bar
340 foo.schemes = http https
340 foo.schemes = http https
341
341
342 bar.prefix = secure.example.org
342 bar.prefix = secure.example.org
343 bar.key = path/to/file.key
343 bar.key = path/to/file.key
344 bar.cert = path/to/file.cert
344 bar.cert = path/to/file.cert
345 bar.schemes = https
345 bar.schemes = https
346
346
347 Supported arguments:
347 Supported arguments:
348
348
349 ``prefix``
349 ``prefix``
350 Either ``*`` or a URI prefix with or without the scheme part.
350 Either ``*`` or a URI prefix with or without the scheme part.
351 The authentication entry with the longest matching prefix is used
351 The authentication entry with the longest matching prefix is used
352 (where ``*`` matches everything and counts as a match of length
352 (where ``*`` matches everything and counts as a match of length
353 1). If the prefix doesn't include a scheme, the match is performed
353 1). If the prefix doesn't include a scheme, the match is performed
354 against the URI with its scheme stripped as well, and the schemes
354 against the URI with its scheme stripped as well, and the schemes
355 argument, q.v., is then subsequently consulted.
355 argument, q.v., is then subsequently consulted.
356
356
357 ``username``
357 ``username``
358 Optional. Username to authenticate with. If not given, and the
358 Optional. Username to authenticate with. If not given, and the
359 remote site requires basic or digest authentication, the user will
359 remote site requires basic or digest authentication, the user will
360 be prompted for it. Environment variables are expanded in the
360 be prompted for it. Environment variables are expanded in the
361 username letting you do ``foo.username = $USER``. If the URI
361 username letting you do ``foo.username = $USER``. If the URI
362 includes a username, only ``[auth]`` entries with a matching
362 includes a username, only ``[auth]`` entries with a matching
363 username or without a username will be considered.
363 username or without a username will be considered.
364
364
365 ``password``
365 ``password``
366 Optional. Password to authenticate with. If not given, and the
366 Optional. Password to authenticate with. If not given, and the
367 remote site requires basic or digest authentication, the user
367 remote site requires basic or digest authentication, the user
368 will be prompted for it.
368 will be prompted for it.
369
369
370 ``key``
370 ``key``
371 Optional. PEM encoded client certificate key file. Environment
371 Optional. PEM encoded client certificate key file. Environment
372 variables are expanded in the filename.
372 variables are expanded in the filename.
373
373
374 ``cert``
374 ``cert``
375 Optional. PEM encoded client certificate chain file. Environment
375 Optional. PEM encoded client certificate chain file. Environment
376 variables are expanded in the filename.
376 variables are expanded in the filename.
377
377
378 ``schemes``
378 ``schemes``
379 Optional. Space separated list of URI schemes to use this
379 Optional. Space separated list of URI schemes to use this
380 authentication entry with. Only used if the prefix doesn't include
380 authentication entry with. Only used if the prefix doesn't include
381 a scheme. Supported schemes are http and https. They will match
381 a scheme. Supported schemes are http and https. They will match
382 static-http and static-https respectively, as well.
382 static-http and static-https respectively, as well.
383 (default: https)
383 (default: https)
384
384
385 If no suitable authentication entry is found, the user is prompted
385 If no suitable authentication entry is found, the user is prompted
386 for credentials as usual if required by the remote.
386 for credentials as usual if required by the remote.
387
387
388
388
389 ``committemplate``
389 ``committemplate``
390 ------------------
390 ------------------
391
391
392 ``changeset``
392 ``changeset``
393 String: configuration in this section is used as the template to
393 String: configuration in this section is used as the template to
394 customize the text shown in the editor when committing.
394 customize the text shown in the editor when committing.
395
395
396 In addition to pre-defined template keywords, commit log specific one
396 In addition to pre-defined template keywords, commit log specific one
397 below can be used for customization:
397 below can be used for customization:
398
398
399 ``extramsg``
399 ``extramsg``
400 String: Extra message (typically 'Leave message empty to abort
400 String: Extra message (typically 'Leave message empty to abort
401 commit.'). This may be changed by some commands or extensions.
401 commit.'). This may be changed by some commands or extensions.
402
402
403 For example, the template configuration below shows as same text as
403 For example, the template configuration below shows as same text as
404 one shown by default::
404 one shown by default::
405
405
406 [committemplate]
406 [committemplate]
407 changeset = {desc}\n\n
407 changeset = {desc}\n\n
408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
409 HG: {extramsg}
409 HG: {extramsg}
410 HG: --
410 HG: --
411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
412 "HG: branch merge\n")
412 "HG: branch merge\n")
413 }HG: branch '{branch}'\n{if(activebookmark,
413 }HG: branch '{branch}'\n{if(activebookmark,
414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
415 "HG: subrepo {subrepo}\n" }{file_adds %
415 "HG: subrepo {subrepo}\n" }{file_adds %
416 "HG: added {file}\n" }{file_mods %
416 "HG: added {file}\n" }{file_mods %
417 "HG: changed {file}\n" }{file_dels %
417 "HG: changed {file}\n" }{file_dels %
418 "HG: removed {file}\n" }{if(files, "",
418 "HG: removed {file}\n" }{if(files, "",
419 "HG: no files changed\n")}
419 "HG: no files changed\n")}
420
420
421 .. note::
421 .. note::
422
422
423 For some problematic encodings (see :hg:`help win32mbcs` for
423 For some problematic encodings (see :hg:`help win32mbcs` for
424 detail), this customization should be configured carefully, to
424 detail), this customization should be configured carefully, to
425 avoid showing broken characters.
425 avoid showing broken characters.
426
426
427 For example, if a multibyte character ending with backslash (0x5c) is
427 For example, if a multibyte character ending with backslash (0x5c) is
428 followed by the ASCII character 'n' in the customized template,
428 followed by the ASCII character 'n' in the customized template,
429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
430 (and the multibyte character is broken, too).
430 (and the multibyte character is broken, too).
431
431
432 Customized template is used for commands below (``--edit`` may be
432 Customized template is used for commands below (``--edit`` may be
433 required):
433 required):
434
434
435 - :hg:`backout`
435 - :hg:`backout`
436 - :hg:`commit`
436 - :hg:`commit`
437 - :hg:`fetch` (for merge commit only)
437 - :hg:`fetch` (for merge commit only)
438 - :hg:`graft`
438 - :hg:`graft`
439 - :hg:`histedit`
439 - :hg:`histedit`
440 - :hg:`import`
440 - :hg:`import`
441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
442 - :hg:`rebase`
442 - :hg:`rebase`
443 - :hg:`shelve`
443 - :hg:`shelve`
444 - :hg:`sign`
444 - :hg:`sign`
445 - :hg:`tag`
445 - :hg:`tag`
446 - :hg:`transplant`
446 - :hg:`transplant`
447
447
448 Configuring items below instead of ``changeset`` allows showing
448 Configuring items below instead of ``changeset`` allows showing
449 customized message only for specific actions, or showing different
449 customized message only for specific actions, or showing different
450 messages for each action.
450 messages for each action.
451
451
452 - ``changeset.backout`` for :hg:`backout`
452 - ``changeset.backout`` for :hg:`backout`
453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
458 - ``changeset.gpg.sign`` for :hg:`sign`
458 - ``changeset.gpg.sign`` for :hg:`sign`
459 - ``changeset.graft`` for :hg:`graft`
459 - ``changeset.graft`` for :hg:`graft`
460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
464 - ``changeset.import.bypass`` for :hg:`import --bypass`
464 - ``changeset.import.bypass`` for :hg:`import --bypass`
465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
466 - ``changeset.import.normal.normal`` for :hg:`import` on other
466 - ``changeset.import.normal.normal`` for :hg:`import` on other
467 - ``changeset.mq.qnew`` for :hg:`qnew`
467 - ``changeset.mq.qnew`` for :hg:`qnew`
468 - ``changeset.mq.qfold`` for :hg:`qfold`
468 - ``changeset.mq.qfold`` for :hg:`qfold`
469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
473 - ``changeset.shelve.shelve`` for :hg:`shelve`
473 - ``changeset.shelve.shelve`` for :hg:`shelve`
474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
475 - ``changeset.tag.remove`` for :hg:`tag --remove`
475 - ``changeset.tag.remove`` for :hg:`tag --remove`
476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
478
478
479 These dot-separated lists of names are treated as hierarchical ones.
479 These dot-separated lists of names are treated as hierarchical ones.
480 For example, ``changeset.tag.remove`` customizes the commit message
480 For example, ``changeset.tag.remove`` customizes the commit message
481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
482 commit message for :hg:`tag` regardless of ``--remove`` option.
482 commit message for :hg:`tag` regardless of ``--remove`` option.
483
483
484 When the external editor is invoked for a commit, the corresponding
484 When the external editor is invoked for a commit, the corresponding
485 dot-separated list of names without the ``changeset.`` prefix
485 dot-separated list of names without the ``changeset.`` prefix
486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
487 variable.
487 variable.
488
488
489 In this section, items other than ``changeset`` can be referred from
489 In this section, items other than ``changeset`` can be referred from
490 others. For example, the configuration to list committed files up
490 others. For example, the configuration to list committed files up
491 below can be referred as ``{listupfiles}``::
491 below can be referred as ``{listupfiles}``::
492
492
493 [committemplate]
493 [committemplate]
494 listupfiles = {file_adds %
494 listupfiles = {file_adds %
495 "HG: added {file}\n" }{file_mods %
495 "HG: added {file}\n" }{file_mods %
496 "HG: changed {file}\n" }{file_dels %
496 "HG: changed {file}\n" }{file_dels %
497 "HG: removed {file}\n" }{if(files, "",
497 "HG: removed {file}\n" }{if(files, "",
498 "HG: no files changed\n")}
498 "HG: no files changed\n")}
499
499
500 ``decode/encode``
500 ``decode/encode``
501 -----------------
501 -----------------
502
502
503 Filters for transforming files on checkout/checkin. This would
503 Filters for transforming files on checkout/checkin. This would
504 typically be used for newline processing or other
504 typically be used for newline processing or other
505 localization/canonicalization of files.
505 localization/canonicalization of files.
506
506
507 Filters consist of a filter pattern followed by a filter command.
507 Filters consist of a filter pattern followed by a filter command.
508 Filter patterns are globs by default, rooted at the repository root.
508 Filter patterns are globs by default, rooted at the repository root.
509 For example, to match any file ending in ``.txt`` in the root
509 For example, to match any file ending in ``.txt`` in the root
510 directory only, use the pattern ``*.txt``. To match any file ending
510 directory only, use the pattern ``*.txt``. To match any file ending
511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
512 For each file only the first matching filter applies.
512 For each file only the first matching filter applies.
513
513
514 The filter command can start with a specifier, either ``pipe:`` or
514 The filter command can start with a specifier, either ``pipe:`` or
515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
516
516
517 A ``pipe:`` command must accept data on stdin and return the transformed
517 A ``pipe:`` command must accept data on stdin and return the transformed
518 data on stdout.
518 data on stdout.
519
519
520 Pipe example::
520 Pipe example::
521
521
522 [encode]
522 [encode]
523 # uncompress gzip files on checkin to improve delta compression
523 # uncompress gzip files on checkin to improve delta compression
524 # note: not necessarily a good idea, just an example
524 # note: not necessarily a good idea, just an example
525 *.gz = pipe: gunzip
525 *.gz = pipe: gunzip
526
526
527 [decode]
527 [decode]
528 # recompress gzip files when writing them to the working dir (we
528 # recompress gzip files when writing them to the working dir (we
529 # can safely omit "pipe:", because it's the default)
529 # can safely omit "pipe:", because it's the default)
530 *.gz = gzip
530 *.gz = gzip
531
531
532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
533 with the name of a temporary file that contains the data to be
533 with the name of a temporary file that contains the data to be
534 filtered by the command. The string ``OUTFILE`` is replaced with the name
534 filtered by the command. The string ``OUTFILE`` is replaced with the name
535 of an empty temporary file, where the filtered data must be written by
535 of an empty temporary file, where the filtered data must be written by
536 the command.
536 the command.
537
537
538 .. container:: windows
538 .. container:: windows
539
539
540 .. note::
540 .. note::
541
541
542 The tempfile mechanism is recommended for Windows systems,
542 The tempfile mechanism is recommended for Windows systems,
543 where the standard shell I/O redirection operators often have
543 where the standard shell I/O redirection operators often have
544 strange effects and may corrupt the contents of your files.
544 strange effects and may corrupt the contents of your files.
545
545
546 This filter mechanism is used internally by the ``eol`` extension to
546 This filter mechanism is used internally by the ``eol`` extension to
547 translate line ending characters between Windows (CRLF) and Unix (LF)
547 translate line ending characters between Windows (CRLF) and Unix (LF)
548 format. We suggest you use the ``eol`` extension for convenience.
548 format. We suggest you use the ``eol`` extension for convenience.
549
549
550
550
551 ``defaults``
551 ``defaults``
552 ------------
552 ------------
553
553
554 (defaults are deprecated. Don't use them. Use aliases instead.)
554 (defaults are deprecated. Don't use them. Use aliases instead.)
555
555
556 Use the ``[defaults]`` section to define command defaults, i.e. the
556 Use the ``[defaults]`` section to define command defaults, i.e. the
557 default options/arguments to pass to the specified commands.
557 default options/arguments to pass to the specified commands.
558
558
559 The following example makes :hg:`log` run in verbose mode, and
559 The following example makes :hg:`log` run in verbose mode, and
560 :hg:`status` show only the modified files, by default::
560 :hg:`status` show only the modified files, by default::
561
561
562 [defaults]
562 [defaults]
563 log = -v
563 log = -v
564 status = -m
564 status = -m
565
565
566 The actual commands, instead of their aliases, must be used when
566 The actual commands, instead of their aliases, must be used when
567 defining command defaults. The command defaults will also be applied
567 defining command defaults. The command defaults will also be applied
568 to the aliases of the commands defined.
568 to the aliases of the commands defined.
569
569
570
570
571 ``diff``
571 ``diff``
572 --------
572 --------
573
573
574 Settings used when displaying diffs. Everything except for ``unified``
574 Settings used when displaying diffs. Everything except for ``unified``
575 is a Boolean and defaults to False. See :hg:`help config.annotate`
575 is a Boolean and defaults to False. See :hg:`help config.annotate`
576 for related options for the annotate command.
576 for related options for the annotate command.
577
577
578 ``git``
578 ``git``
579 Use git extended diff format.
579 Use git extended diff format.
580
580
581 ``nobinary``
581 ``nobinary``
582 Omit git binary patches.
582 Omit git binary patches.
583
583
584 ``nodates``
584 ``nodates``
585 Don't include dates in diff headers.
585 Don't include dates in diff headers.
586
586
587 ``noprefix``
587 ``noprefix``
588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
589
589
590 ``showfunc``
590 ``showfunc``
591 Show which function each change is in.
591 Show which function each change is in.
592
592
593 ``ignorews``
593 ``ignorews``
594 Ignore white space when comparing lines.
594 Ignore white space when comparing lines.
595
595
596 ``ignorewsamount``
596 ``ignorewsamount``
597 Ignore changes in the amount of white space.
597 Ignore changes in the amount of white space.
598
598
599 ``ignoreblanklines``
599 ``ignoreblanklines``
600 Ignore changes whose lines are all blank.
600 Ignore changes whose lines are all blank.
601
601
602 ``unified``
602 ``unified``
603 Number of lines of context to show.
603 Number of lines of context to show.
604
604
605 ``email``
605 ``email``
606 ---------
606 ---------
607
607
608 Settings for extensions that send email messages.
608 Settings for extensions that send email messages.
609
609
610 ``from``
610 ``from``
611 Optional. Email address to use in "From" header and SMTP envelope
611 Optional. Email address to use in "From" header and SMTP envelope
612 of outgoing messages.
612 of outgoing messages.
613
613
614 ``to``
614 ``to``
615 Optional. Comma-separated list of recipients' email addresses.
615 Optional. Comma-separated list of recipients' email addresses.
616
616
617 ``cc``
617 ``cc``
618 Optional. Comma-separated list of carbon copy recipients'
618 Optional. Comma-separated list of carbon copy recipients'
619 email addresses.
619 email addresses.
620
620
621 ``bcc``
621 ``bcc``
622 Optional. Comma-separated list of blind carbon copy recipients'
622 Optional. Comma-separated list of blind carbon copy recipients'
623 email addresses.
623 email addresses.
624
624
625 ``method``
625 ``method``
626 Optional. Method to use to send email messages. If value is ``smtp``
626 Optional. Method to use to send email messages. If value is ``smtp``
627 (default), use SMTP (see the ``[smtp]`` section for configuration).
627 (default), use SMTP (see the ``[smtp]`` section for configuration).
628 Otherwise, use as name of program to run that acts like sendmail
628 Otherwise, use as name of program to run that acts like sendmail
629 (takes ``-f`` option for sender, list of recipients on command line,
629 (takes ``-f`` option for sender, list of recipients on command line,
630 message on stdin). Normally, setting this to ``sendmail`` or
630 message on stdin). Normally, setting this to ``sendmail`` or
631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
632
632
633 ``charsets``
633 ``charsets``
634 Optional. Comma-separated list of character sets considered
634 Optional. Comma-separated list of character sets considered
635 convenient for recipients. Addresses, headers, and parts not
635 convenient for recipients. Addresses, headers, and parts not
636 containing patches of outgoing messages will be encoded in the
636 containing patches of outgoing messages will be encoded in the
637 first character set to which conversion from local encoding
637 first character set to which conversion from local encoding
638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
639 conversion fails, the text in question is sent as is.
639 conversion fails, the text in question is sent as is.
640 (default: '')
640 (default: '')
641
641
642 Order of outgoing email character sets:
642 Order of outgoing email character sets:
643
643
644 1. ``us-ascii``: always first, regardless of settings
644 1. ``us-ascii``: always first, regardless of settings
645 2. ``email.charsets``: in order given by user
645 2. ``email.charsets``: in order given by user
646 3. ``ui.fallbackencoding``: if not in email.charsets
646 3. ``ui.fallbackencoding``: if not in email.charsets
647 4. ``$HGENCODING``: if not in email.charsets
647 4. ``$HGENCODING``: if not in email.charsets
648 5. ``utf-8``: always last, regardless of settings
648 5. ``utf-8``: always last, regardless of settings
649
649
650 Email example::
650 Email example::
651
651
652 [email]
652 [email]
653 from = Joseph User <joe.user@example.com>
653 from = Joseph User <joe.user@example.com>
654 method = /usr/sbin/sendmail
654 method = /usr/sbin/sendmail
655 # charsets for western Europeans
655 # charsets for western Europeans
656 # us-ascii, utf-8 omitted, as they are tried first and last
656 # us-ascii, utf-8 omitted, as they are tried first and last
657 charsets = iso-8859-1, iso-8859-15, windows-1252
657 charsets = iso-8859-1, iso-8859-15, windows-1252
658
658
659
659
660 ``extensions``
660 ``extensions``
661 --------------
661 --------------
662
662
663 Mercurial has an extension mechanism for adding new features. To
663 Mercurial has an extension mechanism for adding new features. To
664 enable an extension, create an entry for it in this section.
664 enable an extension, create an entry for it in this section.
665
665
666 If you know that the extension is already in Python's search path,
666 If you know that the extension is already in Python's search path,
667 you can give the name of the module, followed by ``=``, with nothing
667 you can give the name of the module, followed by ``=``, with nothing
668 after the ``=``.
668 after the ``=``.
669
669
670 Otherwise, give a name that you choose, followed by ``=``, followed by
670 Otherwise, give a name that you choose, followed by ``=``, followed by
671 the path to the ``.py`` file (including the file name extension) that
671 the path to the ``.py`` file (including the file name extension) that
672 defines the extension.
672 defines the extension.
673
673
674 To explicitly disable an extension that is enabled in an hgrc of
674 To explicitly disable an extension that is enabled in an hgrc of
675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
676 or ``foo = !`` when path is not supplied.
676 or ``foo = !`` when path is not supplied.
677
677
678 Example for ``~/.hgrc``::
678 Example for ``~/.hgrc``::
679
679
680 [extensions]
680 [extensions]
681 # (the color extension will get loaded from Mercurial's path)
681 # (the color extension will get loaded from Mercurial's path)
682 color =
682 color =
683 # (this extension will get loaded from the file specified)
683 # (this extension will get loaded from the file specified)
684 myfeature = ~/.hgext/myfeature.py
684 myfeature = ~/.hgext/myfeature.py
685
685
686
686
687 ``format``
687 ``format``
688 ----------
688 ----------
689
689
690 ``usegeneraldelta``
690 ``usegeneraldelta``
691 Enable or disable the "generaldelta" repository format which improves
691 Enable or disable the "generaldelta" repository format which improves
692 repository compression by allowing "revlog" to store delta against arbitrary
692 repository compression by allowing "revlog" to store delta against arbitrary
693 revision instead of the previous stored one. This provides significant
693 revision instead of the previous stored one. This provides significant
694 improvement for repositories with branches.
694 improvement for repositories with branches.
695
695
696 Repositories with this on-disk format require Mercurial version 1.9.
696 Repositories with this on-disk format require Mercurial version 1.9.
697
697
698 Enabled by default.
698 Enabled by default.
699
699
700 ``dotencode``
700 ``dotencode``
701 Enable or disable the "dotencode" repository format which enhances
701 Enable or disable the "dotencode" repository format which enhances
702 the "fncache" repository format (which has to be enabled to use
702 the "fncache" repository format (which has to be enabled to use
703 dotencode) to avoid issues with filenames starting with ._ on
703 dotencode) to avoid issues with filenames starting with ._ on
704 Mac OS X and spaces on Windows.
704 Mac OS X and spaces on Windows.
705
705
706 Repositories with this on-disk format require Mercurial version 1.7.
706 Repositories with this on-disk format require Mercurial version 1.7.
707
707
708 Enabled by default.
708 Enabled by default.
709
709
710 ``usefncache``
710 ``usefncache``
711 Enable or disable the "fncache" repository format which enhances
711 Enable or disable the "fncache" repository format which enhances
712 the "store" repository format (which has to be enabled to use
712 the "store" repository format (which has to be enabled to use
713 fncache) to allow longer filenames and avoids using Windows
713 fncache) to allow longer filenames and avoids using Windows
714 reserved names, e.g. "nul".
714 reserved names, e.g. "nul".
715
715
716 Repositories with this on-disk format require Mercurial version 1.1.
716 Repositories with this on-disk format require Mercurial version 1.1.
717
717
718 Enabled by default.
718 Enabled by default.
719
719
720 ``usestore``
720 ``usestore``
721 Enable or disable the "store" repository format which improves
721 Enable or disable the "store" repository format which improves
722 compatibility with systems that fold case or otherwise mangle
722 compatibility with systems that fold case or otherwise mangle
723 filenames. Disabling this option will allow you to store longer filenames
723 filenames. Disabling this option will allow you to store longer filenames
724 in some situations at the expense of compatibility.
724 in some situations at the expense of compatibility.
725
725
726 Repositories with this on-disk format require Mercurial version 0.9.4.
726 Repositories with this on-disk format require Mercurial version 0.9.4.
727
727
728 Enabled by default.
728 Enabled by default.
729
729
730 ``graph``
730 ``graph``
731 ---------
731 ---------
732
732
733 Web graph view configuration. This section let you change graph
733 Web graph view configuration. This section let you change graph
734 elements display properties by branches, for instance to make the
734 elements display properties by branches, for instance to make the
735 ``default`` branch stand out.
735 ``default`` branch stand out.
736
736
737 Each line has the following format::
737 Each line has the following format::
738
738
739 <branch>.<argument> = <value>
739 <branch>.<argument> = <value>
740
740
741 where ``<branch>`` is the name of the branch being
741 where ``<branch>`` is the name of the branch being
742 customized. Example::
742 customized. Example::
743
743
744 [graph]
744 [graph]
745 # 2px width
745 # 2px width
746 default.width = 2
746 default.width = 2
747 # red color
747 # red color
748 default.color = FF0000
748 default.color = FF0000
749
749
750 Supported arguments:
750 Supported arguments:
751
751
752 ``width``
752 ``width``
753 Set branch edges width in pixels.
753 Set branch edges width in pixels.
754
754
755 ``color``
755 ``color``
756 Set branch edges color in hexadecimal RGB notation.
756 Set branch edges color in hexadecimal RGB notation.
757
757
758 ``hooks``
758 ``hooks``
759 ---------
759 ---------
760
760
761 Commands or Python functions that get automatically executed by
761 Commands or Python functions that get automatically executed by
762 various actions such as starting or finishing a commit. Multiple
762 various actions such as starting or finishing a commit. Multiple
763 hooks can be run for the same action by appending a suffix to the
763 hooks can be run for the same action by appending a suffix to the
764 action. Overriding a site-wide hook can be done by changing its
764 action. Overriding a site-wide hook can be done by changing its
765 value or setting it to an empty string. Hooks can be prioritized
765 value or setting it to an empty string. Hooks can be prioritized
766 by adding a prefix of ``priority.`` to the hook name on a new line
766 by adding a prefix of ``priority.`` to the hook name on a new line
767 and setting the priority. The default priority is 0.
767 and setting the priority. The default priority is 0.
768
768
769 Example ``.hg/hgrc``::
769 Example ``.hg/hgrc``::
770
770
771 [hooks]
771 [hooks]
772 # update working directory after adding changesets
772 # update working directory after adding changesets
773 changegroup.update = hg update
773 changegroup.update = hg update
774 # do not use the site-wide hook
774 # do not use the site-wide hook
775 incoming =
775 incoming =
776 incoming.email = /my/email/hook
776 incoming.email = /my/email/hook
777 incoming.autobuild = /my/build/hook
777 incoming.autobuild = /my/build/hook
778 # force autobuild hook to run before other incoming hooks
778 # force autobuild hook to run before other incoming hooks
779 priority.incoming.autobuild = 1
779 priority.incoming.autobuild = 1
780
780
781 Most hooks are run with environment variables set that give useful
781 Most hooks are run with environment variables set that give useful
782 additional information. For each hook below, the environment
782 additional information. For each hook below, the environment
783 variables it is passed are listed with names of the form ``$HG_foo``.
783 variables it is passed are listed with names of the form ``$HG_foo``.
784
784
785 ``changegroup``
785 ``changegroup``
786 Run after a changegroup has been added via push, pull or unbundle. ID of the
786 Run after a changegroup has been added via push, pull or unbundle. ID of the
787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
788 from which changes came is in ``$HG_URL``.
788 from which changes came is in ``$HG_URL``.
789
789
790 ``commit``
790 ``commit``
791 Run after a changeset has been created in the local repository. ID
791 Run after a changeset has been created in the local repository. ID
792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
794
794
795 ``incoming``
795 ``incoming``
796 Run after a changeset has been pulled, pushed, or unbundled into
796 Run after a changeset has been pulled, pushed, or unbundled into
797 the local repository. The ID of the newly arrived changeset is in
797 the local repository. The ID of the newly arrived changeset is in
798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
799
799
800 ``outgoing``
800 ``outgoing``
801 Run after sending changes from local repository to another. ID of
801 Run after sending changes from local repository to another. ID of
802 first changeset sent is in ``$HG_NODE``. Source of operation is in
802 first changeset sent is in ``$HG_NODE``. Source of operation is in
803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
804
804
805 ``post-<command>``
805 ``post-<command>``
806 Run after successful invocations of the associated command. The
806 Run after successful invocations of the associated command. The
807 contents of the command line are passed as ``$HG_ARGS`` and the result
807 contents of the command line are passed as ``$HG_ARGS`` and the result
808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
810 the python data internally passed to <command>. ``$HG_OPTS`` is a
810 the python data internally passed to <command>. ``$HG_OPTS`` is a
811 dictionary of options (with unspecified options set to their defaults).
811 dictionary of options (with unspecified options set to their defaults).
812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
813
813
814 ``pre-<command>``
814 ``pre-<command>``
815 Run before executing the associated command. The contents of the
815 Run before executing the associated command. The contents of the
816 command line are passed as ``$HG_ARGS``. Parsed command line arguments
816 command line are passed as ``$HG_ARGS``. Parsed command line arguments
817 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
817 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
818 representations of the data internally passed to <command>. ``$HG_OPTS``
818 representations of the data internally passed to <command>. ``$HG_OPTS``
819 is a dictionary of options (with unspecified options set to their
819 is a dictionary of options (with unspecified options set to their
820 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
820 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
821 failure, the command doesn't execute and Mercurial returns the failure
821 failure, the command doesn't execute and Mercurial returns the failure
822 code.
822 code.
823
823
824 ``prechangegroup``
824 ``prechangegroup``
825 Run before a changegroup is added via push, pull or unbundle. Exit
825 Run before a changegroup is added via push, pull or unbundle. Exit
826 status 0 allows the changegroup to proceed. Non-zero status will
826 status 0 allows the changegroup to proceed. Non-zero status will
827 cause the push, pull or unbundle to fail. URL from which changes
827 cause the push, pull or unbundle to fail. URL from which changes
828 will come is in ``$HG_URL``.
828 will come is in ``$HG_URL``.
829
829
830 ``precommit``
830 ``precommit``
831 Run before starting a local commit. Exit status 0 allows the
831 Run before starting a local commit. Exit status 0 allows the
832 commit to proceed. Non-zero status will cause the commit to fail.
832 commit to proceed. Non-zero status will cause the commit to fail.
833 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
833 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
834
834
835 ``prelistkeys``
835 ``prelistkeys``
836 Run before listing pushkeys (like bookmarks) in the
836 Run before listing pushkeys (like bookmarks) in the
837 repository. Non-zero status will cause failure. The key namespace is
837 repository. Non-zero status will cause failure. The key namespace is
838 in ``$HG_NAMESPACE``.
838 in ``$HG_NAMESPACE``.
839
839
840 ``preoutgoing``
840 ``preoutgoing``
841 Run before collecting changes to send from the local repository to
841 Run before collecting changes to send from the local repository to
842 another. Non-zero status will cause failure. This lets you prevent
842 another. Non-zero status will cause failure. This lets you prevent
843 pull over HTTP or SSH. Also prevents against local pull, push
843 pull over HTTP or SSH. Also prevents against local pull, push
844 (outbound) or bundle commands, but not effective, since you can
844 (outbound) or bundle commands, but not effective, since you can
845 just copy files instead then. Source of operation is in
845 just copy files instead then. Source of operation is in
846 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
846 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
847 SSH or HTTP repository. If "push", "pull" or "bundle", operation
847 SSH or HTTP repository. If "push", "pull" or "bundle", operation
848 is happening on behalf of repository on same system.
848 is happening on behalf of repository on same system.
849
849
850 ``prepushkey``
850 ``prepushkey``
851 Run before a pushkey (like a bookmark) is added to the
851 Run before a pushkey (like a bookmark) is added to the
852 repository. Non-zero status will cause the key to be rejected. The
852 repository. Non-zero status will cause the key to be rejected. The
853 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
853 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
854 the old value (if any) is in ``$HG_OLD``, and the new value is in
854 the old value (if any) is in ``$HG_OLD``, and the new value is in
855 ``$HG_NEW``.
855 ``$HG_NEW``.
856
856
857 ``pretag``
857 ``pretag``
858 Run before creating a tag. Exit status 0 allows the tag to be
858 Run before creating a tag. Exit status 0 allows the tag to be
859 created. Non-zero status will cause the tag to fail. ID of
859 created. Non-zero status will cause the tag to fail. ID of
860 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
860 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
861 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
861 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
862
862
863 ``pretxnopen``
863 ``pretxnopen``
864 Run before any new repository transaction is open. The reason for the
864 Run before any new repository transaction is open. The reason for the
865 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
865 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
866 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
866 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
867 transaction from being opened.
867 transaction from being opened.
868
868
869 ``pretxnclose``
869 ``pretxnclose``
870 Run right before the transaction is actually finalized. Any repository change
870 Run right before the transaction is actually finalized. Any repository change
871 will be visible to the hook program. This lets you validate the transaction
871 will be visible to the hook program. This lets you validate the transaction
872 content or change it. Exit status 0 allows the commit to proceed. Non-zero
872 content or change it. Exit status 0 allows the commit to proceed. Non-zero
873 status will cause the transaction to be rolled back. The reason for the
873 status will cause the transaction to be rolled back. The reason for the
874 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
874 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
875 the transaction will be in ``HG_TXNID``. The rest of the available data will
875 the transaction will be in ``HG_TXNID``. The rest of the available data will
876 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
876 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
877 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
877 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
878 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
878 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
879 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
879 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
880
880
881 ``txnclose``
881 ``txnclose``
882 Run after any repository transaction has been committed. At this
882 Run after any repository transaction has been committed. At this
883 point, the transaction can no longer be rolled back. The hook will run
883 point, the transaction can no longer be rolled back. The hook will run
884 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
884 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
885 details about available variables.
885 details about available variables.
886
886
887 ``txnabort``
887 ``txnabort``
888 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
888 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
889 docs for details about available variables.
889 docs for details about available variables.
890
890
891 ``pretxnchangegroup``
891 ``pretxnchangegroup``
892 Run after a changegroup has been added via push, pull or unbundle, but before
892 Run after a changegroup has been added via push, pull or unbundle, but before
893 the transaction has been committed. Changegroup is visible to hook program.
893 the transaction has been committed. Changegroup is visible to hook program.
894 This lets you validate incoming changes before accepting them. Passed the ID
894 This lets you validate incoming changes before accepting them. Passed the ID
895 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
895 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
896 Exit status 0 allows the transaction to commit. Non-zero status will cause
896 Exit status 0 allows the transaction to commit. Non-zero status will cause
897 the transaction to be rolled back and the push, pull or unbundle will fail.
897 the transaction to be rolled back and the push, pull or unbundle will fail.
898 URL that was source of changes is in ``$HG_URL``.
898 URL that was source of changes is in ``$HG_URL``.
899
899
900 ``pretxncommit``
900 ``pretxncommit``
901 Run after a changeset has been created but the transaction not yet
901 Run after a changeset has been created but the transaction not yet
902 committed. Changeset is visible to hook program. This lets you
902 committed. Changeset is visible to hook program. This lets you
903 validate commit message and changes. Exit status 0 allows the
903 validate commit message and changes. Exit status 0 allows the
904 commit to proceed. Non-zero status will cause the transaction to
904 commit to proceed. Non-zero status will cause the transaction to
905 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
905 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
906 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
906 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
907
907
908 ``preupdate``
908 ``preupdate``
909 Run before updating the working directory. Exit status 0 allows
909 Run before updating the working directory. Exit status 0 allows
910 the update to proceed. Non-zero status will prevent the update.
910 the update to proceed. Non-zero status will prevent the update.
911 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
911 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
912 of second new parent is in ``$HG_PARENT2``.
912 of second new parent is in ``$HG_PARENT2``.
913
913
914 ``listkeys``
914 ``listkeys``
915 Run after listing pushkeys (like bookmarks) in the repository. The
915 Run after listing pushkeys (like bookmarks) in the repository. The
916 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
916 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
917 dictionary containing the keys and values.
917 dictionary containing the keys and values.
918
918
919 ``pushkey``
919 ``pushkey``
920 Run after a pushkey (like a bookmark) is added to the
920 Run after a pushkey (like a bookmark) is added to the
921 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
921 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
922 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
922 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
923 value is in ``$HG_NEW``.
923 value is in ``$HG_NEW``.
924
924
925 ``tag``
925 ``tag``
926 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
926 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
927 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
927 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
928 repository if ``$HG_LOCAL=0``.
928 repository if ``$HG_LOCAL=0``.
929
929
930 ``update``
930 ``update``
931 Run after updating the working directory. Changeset ID of first
931 Run after updating the working directory. Changeset ID of first
932 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
932 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
933 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
933 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
934 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
934 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
935
935
936 .. note::
936 .. note::
937
937
938 It is generally better to use standard hooks rather than the
938 It is generally better to use standard hooks rather than the
939 generic pre- and post- command hooks as they are guaranteed to be
939 generic pre- and post- command hooks as they are guaranteed to be
940 called in the appropriate contexts for influencing transactions.
940 called in the appropriate contexts for influencing transactions.
941 Also, hooks like "commit" will be called in all contexts that
941 Also, hooks like "commit" will be called in all contexts that
942 generate a commit (e.g. tag) and not just the commit command.
942 generate a commit (e.g. tag) and not just the commit command.
943
943
944 .. note::
944 .. note::
945
945
946 Environment variables with empty values may not be passed to
946 Environment variables with empty values may not be passed to
947 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
947 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
948 will have an empty value under Unix-like platforms for non-merge
948 will have an empty value under Unix-like platforms for non-merge
949 changesets, while it will not be available at all under Windows.
949 changesets, while it will not be available at all under Windows.
950
950
951 The syntax for Python hooks is as follows::
951 The syntax for Python hooks is as follows::
952
952
953 hookname = python:modulename.submodule.callable
953 hookname = python:modulename.submodule.callable
954 hookname = python:/path/to/python/module.py:callable
954 hookname = python:/path/to/python/module.py:callable
955
955
956 Python hooks are run within the Mercurial process. Each hook is
956 Python hooks are run within the Mercurial process. Each hook is
957 called with at least three keyword arguments: a ui object (keyword
957 called with at least three keyword arguments: a ui object (keyword
958 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
958 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
959 keyword that tells what kind of hook is used. Arguments listed as
959 keyword that tells what kind of hook is used. Arguments listed as
960 environment variables above are passed as keyword arguments, with no
960 environment variables above are passed as keyword arguments, with no
961 ``HG_`` prefix, and names in lower case.
961 ``HG_`` prefix, and names in lower case.
962
962
963 If a Python hook returns a "true" value or raises an exception, this
963 If a Python hook returns a "true" value or raises an exception, this
964 is treated as a failure.
964 is treated as a failure.
965
965
966
966
967 ``hostfingerprints``
967 ``hostfingerprints``
968 --------------------
968 --------------------
969
969
970 Fingerprints of the certificates of known HTTPS servers.
970 Fingerprints of the certificates of known HTTPS servers.
971
971
972 A HTTPS connection to a server with a fingerprint configured here will
972 A HTTPS connection to a server with a fingerprint configured here will
973 only succeed if the servers certificate matches the fingerprint.
973 only succeed if the servers certificate matches the fingerprint.
974 This is very similar to how ssh known hosts works.
974 This is very similar to how ssh known hosts works.
975
975
976 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
976 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
977 Multiple values can be specified (separated by spaces or commas). This can
977 Multiple values can be specified (separated by spaces or commas). This can
978 be used to define both old and new fingerprints while a host transitions
978 be used to define both old and new fingerprints while a host transitions
979 to a new certificate.
979 to a new certificate.
980
980
981 The CA chain and web.cacerts is not used for servers with a fingerprint.
981 The CA chain and web.cacerts is not used for servers with a fingerprint.
982
982
983 For example::
983 For example::
984
984
985 [hostfingerprints]
985 [hostfingerprints]
986 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
986 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
987 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
987 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
988
988
989 This feature is only supported when using Python 2.6 or later.
989 This feature is only supported when using Python 2.6 or later.
990
990
991
991
992 ``http_proxy``
992 ``http_proxy``
993 --------------
993 --------------
994
994
995 Used to access web-based Mercurial repositories through a HTTP
995 Used to access web-based Mercurial repositories through a HTTP
996 proxy.
996 proxy.
997
997
998 ``host``
998 ``host``
999 Host name and (optional) port of the proxy server, for example
999 Host name and (optional) port of the proxy server, for example
1000 "myproxy:8000".
1000 "myproxy:8000".
1001
1001
1002 ``no``
1002 ``no``
1003 Optional. Comma-separated list of host names that should bypass
1003 Optional. Comma-separated list of host names that should bypass
1004 the proxy.
1004 the proxy.
1005
1005
1006 ``passwd``
1006 ``passwd``
1007 Optional. Password to authenticate with at the proxy server.
1007 Optional. Password to authenticate with at the proxy server.
1008
1008
1009 ``user``
1009 ``user``
1010 Optional. User name to authenticate with at the proxy server.
1010 Optional. User name to authenticate with at the proxy server.
1011
1011
1012 ``always``
1012 ``always``
1013 Optional. Always use the proxy, even for localhost and any entries
1013 Optional. Always use the proxy, even for localhost and any entries
1014 in ``http_proxy.no``. (default: False)
1014 in ``http_proxy.no``. (default: False)
1015
1015
1016 ``merge``
1016 ``merge``
1017 ---------
1017 ---------
1018
1018
1019 This section specifies behavior during merges and updates.
1019 This section specifies behavior during merges and updates.
1020
1020
1021 ``checkignored``
1021 ``checkignored``
1022 Controls behavior when an ignored file on disk has the same name as a tracked
1022 Controls behavior when an ignored file on disk has the same name as a tracked
1023 file in the changeset being merged or updated to, and has different
1023 file in the changeset being merged or updated to, and has different
1024 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1024 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1025 abort on such files. With ``warn``, warn on such files and back them up as
1025 abort on such files. With ``warn``, warn on such files and back them up as
1026 .orig. With ``ignore``, don't print a warning and back them up as
1026 .orig. With ``ignore``, don't print a warning and back them up as
1027 .orig. (default: ``abort``)
1027 .orig. (default: ``abort``)
1028
1028
1029 ``checkunknown``
1029 ``checkunknown``
1030 Controls behavior when an unknown file that isn't ignored has the same name
1030 Controls behavior when an unknown file that isn't ignored has the same name
1031 as a tracked file in the changeset being merged or updated to, and has
1031 as a tracked file in the changeset being merged or updated to, and has
1032 different contents. Similar to ``merge.checkignored``, except for files that
1032 different contents. Similar to ``merge.checkignored``, except for files that
1033 are not ignored. (default: ``abort``)
1033 are not ignored. (default: ``abort``)
1034
1034
1035 ``merge-patterns``
1035 ``merge-patterns``
1036 ------------------
1036 ------------------
1037
1037
1038 This section specifies merge tools to associate with particular file
1038 This section specifies merge tools to associate with particular file
1039 patterns. Tools matched here will take precedence over the default
1039 patterns. Tools matched here will take precedence over the default
1040 merge tool. Patterns are globs by default, rooted at the repository
1040 merge tool. Patterns are globs by default, rooted at the repository
1041 root.
1041 root.
1042
1042
1043 Example::
1043 Example::
1044
1044
1045 [merge-patterns]
1045 [merge-patterns]
1046 **.c = kdiff3
1046 **.c = kdiff3
1047 **.jpg = myimgmerge
1047 **.jpg = myimgmerge
1048
1048
1049 ``merge-tools``
1049 ``merge-tools``
1050 ---------------
1050 ---------------
1051
1051
1052 This section configures external merge tools to use for file-level
1052 This section configures external merge tools to use for file-level
1053 merges. This section has likely been preconfigured at install time.
1053 merges. This section has likely been preconfigured at install time.
1054 Use :hg:`config merge-tools` to check the existing configuration.
1054 Use :hg:`config merge-tools` to check the existing configuration.
1055 Also see :hg:`help merge-tools` for more details.
1055 Also see :hg:`help merge-tools` for more details.
1056
1056
1057 Example ``~/.hgrc``::
1057 Example ``~/.hgrc``::
1058
1058
1059 [merge-tools]
1059 [merge-tools]
1060 # Override stock tool location
1060 # Override stock tool location
1061 kdiff3.executable = ~/bin/kdiff3
1061 kdiff3.executable = ~/bin/kdiff3
1062 # Specify command line
1062 # Specify command line
1063 kdiff3.args = $base $local $other -o $output
1063 kdiff3.args = $base $local $other -o $output
1064 # Give higher priority
1064 # Give higher priority
1065 kdiff3.priority = 1
1065 kdiff3.priority = 1
1066
1066
1067 # Changing the priority of preconfigured tool
1067 # Changing the priority of preconfigured tool
1068 meld.priority = 0
1068 meld.priority = 0
1069
1069
1070 # Disable a preconfigured tool
1070 # Disable a preconfigured tool
1071 vimdiff.disabled = yes
1071 vimdiff.disabled = yes
1072
1072
1073 # Define new tool
1073 # Define new tool
1074 myHtmlTool.args = -m $local $other $base $output
1074 myHtmlTool.args = -m $local $other $base $output
1075 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1075 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1076 myHtmlTool.priority = 1
1076 myHtmlTool.priority = 1
1077
1077
1078 Supported arguments:
1078 Supported arguments:
1079
1079
1080 ``priority``
1080 ``priority``
1081 The priority in which to evaluate this tool.
1081 The priority in which to evaluate this tool.
1082 (default: 0)
1082 (default: 0)
1083
1083
1084 ``executable``
1084 ``executable``
1085 Either just the name of the executable or its pathname.
1085 Either just the name of the executable or its pathname.
1086
1086
1087 .. container:: windows
1087 .. container:: windows
1088
1088
1089 On Windows, the path can use environment variables with ${ProgramFiles}
1089 On Windows, the path can use environment variables with ${ProgramFiles}
1090 syntax.
1090 syntax.
1091
1091
1092 (default: the tool name)
1092 (default: the tool name)
1093
1093
1094 ``args``
1094 ``args``
1095 The arguments to pass to the tool executable. You can refer to the
1095 The arguments to pass to the tool executable. You can refer to the
1096 files being merged as well as the output file through these
1096 files being merged as well as the output file through these
1097 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1097 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1098 of ``$local`` and ``$other`` can vary depending on which action is being
1098 of ``$local`` and ``$other`` can vary depending on which action is being
1099 performed. During and update or merge, ``$local`` represents the original
1099 performed. During and update or merge, ``$local`` represents the original
1100 state of the file, while ``$other`` represents the commit you are updating
1100 state of the file, while ``$other`` represents the commit you are updating
1101 to or the commit you are merging with. During a rebase ``$local``
1101 to or the commit you are merging with. During a rebase ``$local``
1102 represents the destination of the rebase, and ``$other`` represents the
1102 represents the destination of the rebase, and ``$other`` represents the
1103 commit being rebased.
1103 commit being rebased.
1104 (default: ``$local $base $other``)
1104 (default: ``$local $base $other``)
1105
1105
1106 ``premerge``
1106 ``premerge``
1107 Attempt to run internal non-interactive 3-way merge tool before
1107 Attempt to run internal non-interactive 3-way merge tool before
1108 launching external tool. Options are ``true``, ``false``, ``keep`` or
1108 launching external tool. Options are ``true``, ``false``, ``keep`` or
1109 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1109 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1110 premerge fails. The ``keep-merge3`` will do the same but include information
1110 premerge fails. The ``keep-merge3`` will do the same but include information
1111 about the base of the merge in the marker (see internal :merge3 in
1111 about the base of the merge in the marker (see internal :merge3 in
1112 :hg:`help merge-tools`).
1112 :hg:`help merge-tools`).
1113 (default: True)
1113 (default: True)
1114
1114
1115 ``binary``
1115 ``binary``
1116 This tool can merge binary files. (default: False, unless tool
1116 This tool can merge binary files. (default: False, unless tool
1117 was selected by file pattern match)
1117 was selected by file pattern match)
1118
1118
1119 ``symlink``
1119 ``symlink``
1120 This tool can merge symlinks. (default: False)
1120 This tool can merge symlinks. (default: False)
1121
1121
1122 ``check``
1122 ``check``
1123 A list of merge success-checking options:
1123 A list of merge success-checking options:
1124
1124
1125 ``changed``
1125 ``changed``
1126 Ask whether merge was successful when the merged file shows no changes.
1126 Ask whether merge was successful when the merged file shows no changes.
1127 ``conflicts``
1127 ``conflicts``
1128 Check whether there are conflicts even though the tool reported success.
1128 Check whether there are conflicts even though the tool reported success.
1129 ``prompt``
1129 ``prompt``
1130 Always prompt for merge success, regardless of success reported by tool.
1130 Always prompt for merge success, regardless of success reported by tool.
1131
1131
1132 ``fixeol``
1132 ``fixeol``
1133 Attempt to fix up EOL changes caused by the merge tool.
1133 Attempt to fix up EOL changes caused by the merge tool.
1134 (default: False)
1134 (default: False)
1135
1135
1136 ``gui``
1136 ``gui``
1137 This tool requires a graphical interface to run. (default: False)
1137 This tool requires a graphical interface to run. (default: False)
1138
1138
1139 .. container:: windows
1139 .. container:: windows
1140
1140
1141 ``regkey``
1141 ``regkey``
1142 Windows registry key which describes install location of this
1142 Windows registry key which describes install location of this
1143 tool. Mercurial will search for this key first under
1143 tool. Mercurial will search for this key first under
1144 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1144 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1145 (default: None)
1145 (default: None)
1146
1146
1147 ``regkeyalt``
1147 ``regkeyalt``
1148 An alternate Windows registry key to try if the first key is not
1148 An alternate Windows registry key to try if the first key is not
1149 found. The alternate key uses the same ``regname`` and ``regappend``
1149 found. The alternate key uses the same ``regname`` and ``regappend``
1150 semantics of the primary key. The most common use for this key
1150 semantics of the primary key. The most common use for this key
1151 is to search for 32bit applications on 64bit operating systems.
1151 is to search for 32bit applications on 64bit operating systems.
1152 (default: None)
1152 (default: None)
1153
1153
1154 ``regname``
1154 ``regname``
1155 Name of value to read from specified registry key.
1155 Name of value to read from specified registry key.
1156 (default: the unnamed (default) value)
1156 (default: the unnamed (default) value)
1157
1157
1158 ``regappend``
1158 ``regappend``
1159 String to append to the value read from the registry, typically
1159 String to append to the value read from the registry, typically
1160 the executable name of the tool.
1160 the executable name of the tool.
1161 (default: None)
1161 (default: None)
1162
1162
1163
1163
1164 ``patch``
1164 ``patch``
1165 ---------
1165 ---------
1166
1166
1167 Settings used when applying patches, for instance through the 'import'
1167 Settings used when applying patches, for instance through the 'import'
1168 command or with Mercurial Queues extension.
1168 command or with Mercurial Queues extension.
1169
1169
1170 ``eol``
1170 ``eol``
1171 When set to 'strict' patch content and patched files end of lines
1171 When set to 'strict' patch content and patched files end of lines
1172 are preserved. When set to ``lf`` or ``crlf``, both files end of
1172 are preserved. When set to ``lf`` or ``crlf``, both files end of
1173 lines are ignored when patching and the result line endings are
1173 lines are ignored when patching and the result line endings are
1174 normalized to either LF (Unix) or CRLF (Windows). When set to
1174 normalized to either LF (Unix) or CRLF (Windows). When set to
1175 ``auto``, end of lines are again ignored while patching but line
1175 ``auto``, end of lines are again ignored while patching but line
1176 endings in patched files are normalized to their original setting
1176 endings in patched files are normalized to their original setting
1177 on a per-file basis. If target file does not exist or has no end
1177 on a per-file basis. If target file does not exist or has no end
1178 of line, patch line endings are preserved.
1178 of line, patch line endings are preserved.
1179 (default: strict)
1179 (default: strict)
1180
1180
1181 ``fuzz``
1181 ``fuzz``
1182 The number of lines of 'fuzz' to allow when applying patches. This
1182 The number of lines of 'fuzz' to allow when applying patches. This
1183 controls how much context the patcher is allowed to ignore when
1183 controls how much context the patcher is allowed to ignore when
1184 trying to apply a patch.
1184 trying to apply a patch.
1185 (default: 2)
1185 (default: 2)
1186
1186
1187 ``paths``
1187 ``paths``
1188 ---------
1188 ---------
1189
1189
1190 Assigns symbolic names and behavior to repositories.
1190 Assigns symbolic names and behavior to repositories.
1191
1191
1192 Options are symbolic names defining the URL or directory that is the
1192 Options are symbolic names defining the URL or directory that is the
1193 location of the repository. Example::
1193 location of the repository. Example::
1194
1194
1195 [paths]
1195 [paths]
1196 my_server = https://example.com/my_repo
1196 my_server = https://example.com/my_repo
1197 local_path = /home/me/repo
1197 local_path = /home/me/repo
1198
1198
1199 These symbolic names can be used from the command line. To pull
1199 These symbolic names can be used from the command line. To pull
1200 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1200 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1201 :hg:`push local_path`.
1201 :hg:`push local_path`.
1202
1202
1203 Options containing colons (``:``) denote sub-options that can influence
1203 Options containing colons (``:``) denote sub-options that can influence
1204 behavior for that specific path. Example::
1204 behavior for that specific path. Example::
1205
1205
1206 [paths]
1206 [paths]
1207 my_server = https://example.com/my_path
1207 my_server = https://example.com/my_path
1208 my_server:pushurl = ssh://example.com/my_path
1208 my_server:pushurl = ssh://example.com/my_path
1209
1209
1210 The following sub-options can be defined:
1210 The following sub-options can be defined:
1211
1211
1212 ``pushurl``
1212 ``pushurl``
1213 The URL to use for push operations. If not defined, the location
1213 The URL to use for push operations. If not defined, the location
1214 defined by the path's main entry is used.
1214 defined by the path's main entry is used.
1215
1215
1216 The following special named paths exist:
1216 The following special named paths exist:
1217
1217
1218 ``default``
1218 ``default``
1219 The URL or directory to use when no source or remote is specified.
1219 The URL or directory to use when no source or remote is specified.
1220
1220
1221 :hg:`clone` will automatically define this path to the location the
1221 :hg:`clone` will automatically define this path to the location the
1222 repository was cloned from.
1222 repository was cloned from.
1223
1223
1224 ``default-push``
1224 ``default-push``
1225 (deprecated) The URL or directory for the default :hg:`push` location.
1225 (deprecated) The URL or directory for the default :hg:`push` location.
1226 ``default:pushurl`` should be used instead.
1226 ``default:pushurl`` should be used instead.
1227
1227
1228 ``phases``
1228 ``phases``
1229 ----------
1229 ----------
1230
1230
1231 Specifies default handling of phases. See :hg:`help phases` for more
1231 Specifies default handling of phases. See :hg:`help phases` for more
1232 information about working with phases.
1232 information about working with phases.
1233
1233
1234 ``publish``
1234 ``publish``
1235 Controls draft phase behavior when working as a server. When true,
1235 Controls draft phase behavior when working as a server. When true,
1236 pushed changesets are set to public in both client and server and
1236 pushed changesets are set to public in both client and server and
1237 pulled or cloned changesets are set to public in the client.
1237 pulled or cloned changesets are set to public in the client.
1238 (default: True)
1238 (default: True)
1239
1239
1240 ``new-commit``
1240 ``new-commit``
1241 Phase of newly-created commits.
1241 Phase of newly-created commits.
1242 (default: draft)
1242 (default: draft)
1243
1243
1244 ``checksubrepos``
1244 ``checksubrepos``
1245 Check the phase of the current revision of each subrepository. Allowed
1245 Check the phase of the current revision of each subrepository. Allowed
1246 values are "ignore", "follow" and "abort". For settings other than
1246 values are "ignore", "follow" and "abort". For settings other than
1247 "ignore", the phase of the current revision of each subrepository is
1247 "ignore", the phase of the current revision of each subrepository is
1248 checked before committing the parent repository. If any of those phases is
1248 checked before committing the parent repository. If any of those phases is
1249 greater than the phase of the parent repository (e.g. if a subrepo is in a
1249 greater than the phase of the parent repository (e.g. if a subrepo is in a
1250 "secret" phase while the parent repo is in "draft" phase), the commit is
1250 "secret" phase while the parent repo is in "draft" phase), the commit is
1251 either aborted (if checksubrepos is set to "abort") or the higher phase is
1251 either aborted (if checksubrepos is set to "abort") or the higher phase is
1252 used for the parent repository commit (if set to "follow").
1252 used for the parent repository commit (if set to "follow").
1253 (default: follow)
1253 (default: follow)
1254
1254
1255
1255
1256 ``profiling``
1256 ``profiling``
1257 -------------
1257 -------------
1258
1258
1259 Specifies profiling type, format, and file output. Two profilers are
1259 Specifies profiling type, format, and file output. Two profilers are
1260 supported: an instrumenting profiler (named ``ls``), and a sampling
1260 supported: an instrumenting profiler (named ``ls``), and a sampling
1261 profiler (named ``stat``).
1261 profiler (named ``stat``).
1262
1262
1263 In this section description, 'profiling data' stands for the raw data
1263 In this section description, 'profiling data' stands for the raw data
1264 collected during profiling, while 'profiling report' stands for a
1264 collected during profiling, while 'profiling report' stands for a
1265 statistical text report generated from the profiling data. The
1265 statistical text report generated from the profiling data. The
1266 profiling is done using lsprof.
1266 profiling is done using lsprof.
1267
1267
1268 ``type``
1268 ``type``
1269 The type of profiler to use.
1269 The type of profiler to use.
1270 (default: ls)
1270 (default: ls)
1271
1271
1272 ``ls``
1272 ``ls``
1273 Use Python's built-in instrumenting profiler. This profiler
1273 Use Python's built-in instrumenting profiler. This profiler
1274 works on all platforms, but each line number it reports is the
1274 works on all platforms, but each line number it reports is the
1275 first line of a function. This restriction makes it difficult to
1275 first line of a function. This restriction makes it difficult to
1276 identify the expensive parts of a non-trivial function.
1276 identify the expensive parts of a non-trivial function.
1277 ``stat``
1277 ``stat``
1278 Use a third-party statistical profiler, statprof. This profiler
1278 Use a third-party statistical profiler, statprof. This profiler
1279 currently runs only on Unix systems, and is most useful for
1279 currently runs only on Unix systems, and is most useful for
1280 profiling commands that run for longer than about 0.1 seconds.
1280 profiling commands that run for longer than about 0.1 seconds.
1281
1281
1282 ``format``
1282 ``format``
1283 Profiling format. Specific to the ``ls`` instrumenting profiler.
1283 Profiling format. Specific to the ``ls`` instrumenting profiler.
1284 (default: text)
1284 (default: text)
1285
1285
1286 ``text``
1286 ``text``
1287 Generate a profiling report. When saving to a file, it should be
1287 Generate a profiling report. When saving to a file, it should be
1288 noted that only the report is saved, and the profiling data is
1288 noted that only the report is saved, and the profiling data is
1289 not kept.
1289 not kept.
1290 ``kcachegrind``
1290 ``kcachegrind``
1291 Format profiling data for kcachegrind use: when saving to a
1291 Format profiling data for kcachegrind use: when saving to a
1292 file, the generated file can directly be loaded into
1292 file, the generated file can directly be loaded into
1293 kcachegrind.
1293 kcachegrind.
1294
1294
1295 ``frequency``
1295 ``frequency``
1296 Sampling frequency. Specific to the ``stat`` sampling profiler.
1296 Sampling frequency. Specific to the ``stat`` sampling profiler.
1297 (default: 1000)
1297 (default: 1000)
1298
1298
1299 ``output``
1299 ``output``
1300 File path where profiling data or report should be saved. If the
1300 File path where profiling data or report should be saved. If the
1301 file exists, it is replaced. (default: None, data is printed on
1301 file exists, it is replaced. (default: None, data is printed on
1302 stderr)
1302 stderr)
1303
1303
1304 ``sort``
1304 ``sort``
1305 Sort field. Specific to the ``ls`` instrumenting profiler.
1305 Sort field. Specific to the ``ls`` instrumenting profiler.
1306 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1306 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1307 ``inlinetime``.
1307 ``inlinetime``.
1308 (default: inlinetime)
1308 (default: inlinetime)
1309
1309
1310 ``limit``
1310 ``limit``
1311 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1311 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1312 (default: 30)
1312 (default: 30)
1313
1313
1314 ``nested``
1314 ``nested``
1315 Show at most this number of lines of drill-down info after each main entry.
1315 Show at most this number of lines of drill-down info after each main entry.
1316 This can help explain the difference between Total and Inline.
1316 This can help explain the difference between Total and Inline.
1317 Specific to the ``ls`` instrumenting profiler.
1317 Specific to the ``ls`` instrumenting profiler.
1318 (default: 5)
1318 (default: 5)
1319
1319
1320 ``progress``
1320 ``progress``
1321 ------------
1321 ------------
1322
1322
1323 Mercurial commands can draw progress bars that are as informative as
1323 Mercurial commands can draw progress bars that are as informative as
1324 possible. Some progress bars only offer indeterminate information, while others
1324 possible. Some progress bars only offer indeterminate information, while others
1325 have a definite end point.
1325 have a definite end point.
1326
1326
1327 ``delay``
1327 ``delay``
1328 Number of seconds (float) before showing the progress bar. (default: 3)
1328 Number of seconds (float) before showing the progress bar. (default: 3)
1329
1329
1330 ``changedelay``
1330 ``changedelay``
1331 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1331 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1332 that value will be used instead. (default: 1)
1332 that value will be used instead. (default: 1)
1333
1333
1334 ``refresh``
1334 ``refresh``
1335 Time in seconds between refreshes of the progress bar. (default: 0.1)
1335 Time in seconds between refreshes of the progress bar. (default: 0.1)
1336
1336
1337 ``format``
1337 ``format``
1338 Format of the progress bar.
1338 Format of the progress bar.
1339
1339
1340 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1340 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1341 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1341 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1342 last 20 characters of the item, but this can be changed by adding either
1342 last 20 characters of the item, but this can be changed by adding either
1343 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1343 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1344 first num characters.
1344 first num characters.
1345
1345
1346 (default: topic bar number estimate)
1346 (default: topic bar number estimate)
1347
1347
1348 ``width``
1348 ``width``
1349 If set, the maximum width of the progress information (that is, min(width,
1349 If set, the maximum width of the progress information (that is, min(width,
1350 term width) will be used).
1350 term width) will be used).
1351
1351
1352 ``clear-complete``
1352 ``clear-complete``
1353 Clear the progress bar after it's done. (default: True)
1353 Clear the progress bar after it's done. (default: True)
1354
1354
1355 ``disable``
1355 ``disable``
1356 If true, don't show a progress bar.
1356 If true, don't show a progress bar.
1357
1357
1358 ``assume-tty``
1358 ``assume-tty``
1359 If true, ALWAYS show a progress bar, unless disable is given.
1359 If true, ALWAYS show a progress bar, unless disable is given.
1360
1360
1361 ``rebase``
1361 ``rebase``
1362 ----------
1362 ----------
1363
1363
1364 ``allowdivergence``
1364 ``allowdivergence``
1365 Default to False, when True allow creating divergence when performing
1365 Default to False, when True allow creating divergence when performing
1366 rebase of obsolete changesets.
1366 rebase of obsolete changesets.
1367
1367
1368 ``revsetalias``
1368 ``revsetalias``
1369 ---------------
1369 ---------------
1370
1370
1371 Alias definitions for revsets. See :hg:`help revsets` for details.
1371 Alias definitions for revsets. See :hg:`help revsets` for details.
1372
1372
1373 ``server``
1373 ``server``
1374 ----------
1374 ----------
1375
1375
1376 Controls generic server settings.
1376 Controls generic server settings.
1377
1377
1378 ``uncompressed``
1378 ``uncompressed``
1379 Whether to allow clients to clone a repository using the
1379 Whether to allow clients to clone a repository using the
1380 uncompressed streaming protocol. This transfers about 40% more
1380 uncompressed streaming protocol. This transfers about 40% more
1381 data than a regular clone, but uses less memory and CPU on both
1381 data than a regular clone, but uses less memory and CPU on both
1382 server and client. Over a LAN (100 Mbps or better) or a very fast
1382 server and client. Over a LAN (100 Mbps or better) or a very fast
1383 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1383 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1384 regular clone. Over most WAN connections (anything slower than
1384 regular clone. Over most WAN connections (anything slower than
1385 about 6 Mbps), uncompressed streaming is slower, because of the
1385 about 6 Mbps), uncompressed streaming is slower, because of the
1386 extra data transfer overhead. This mode will also temporarily hold
1386 extra data transfer overhead. This mode will also temporarily hold
1387 the write lock while determining what data to transfer.
1387 the write lock while determining what data to transfer.
1388 (default: True)
1388 (default: True)
1389
1389
1390 ``preferuncompressed``
1390 ``preferuncompressed``
1391 When set, clients will try to use the uncompressed streaming
1391 When set, clients will try to use the uncompressed streaming
1392 protocol. (default: False)
1392 protocol. (default: False)
1393
1393
1394 ``validate``
1394 ``validate``
1395 Whether to validate the completeness of pushed changesets by
1395 Whether to validate the completeness of pushed changesets by
1396 checking that all new file revisions specified in manifests are
1396 checking that all new file revisions specified in manifests are
1397 present. (default: False)
1397 present. (default: False)
1398
1398
1399 ``maxhttpheaderlen``
1399 ``maxhttpheaderlen``
1400 Instruct HTTP clients not to send request headers longer than this
1400 Instruct HTTP clients not to send request headers longer than this
1401 many bytes. (default: 1024)
1401 many bytes. (default: 1024)
1402
1402
1403 ``bundle1``
1403 ``bundle1``
1404 Whether to allow clients to push and pull using the legacy bundle1
1404 Whether to allow clients to push and pull using the legacy bundle1
1405 exchange format. (default: True)
1405 exchange format. (default: True)
1406
1406
1407 ``bundle1gd``
1407 ``bundle1gd``
1408 Like ``bundle1`` but only used if the repository is using the
1408 Like ``bundle1`` but only used if the repository is using the
1409 *generaldelta* storage format. (default: True)
1409 *generaldelta* storage format. (default: True)
1410
1410
1411 ``bundle1.push``
1411 ``bundle1.push``
1412 Whether to allow clients to push using the legacy bundle1 exchange
1412 Whether to allow clients to push using the legacy bundle1 exchange
1413 format. (default: True)
1413 format. (default: True)
1414
1414
1415 ``bundle1gd.push``
1415 ``bundle1gd.push``
1416 Like ``bundle1.push`` but only used if the repository is using the
1416 Like ``bundle1.push`` but only used if the repository is using the
1417 *generaldelta* storage format. (default: True)
1417 *generaldelta* storage format. (default: True)
1418
1418
1419 ``bundle1.pull``
1419 ``bundle1.pull``
1420 Whether to allow clients to pull using the legacy bundle1 exchange
1420 Whether to allow clients to pull using the legacy bundle1 exchange
1421 format. (default: True)
1421 format. (default: True)
1422
1422
1423 ``bundle1gd.pull``
1423 ``bundle1gd.pull``
1424 Like ``bundle1.pull`` but only used if the repository is using the
1424 Like ``bundle1.pull`` but only used if the repository is using the
1425 *generaldelta* storage format. (default: True)
1425 *generaldelta* storage format. (default: True)
1426
1426
1427 Large repositories using the *generaldelta* storage format should
1427 Large repositories using the *generaldelta* storage format should
1428 consider setting this option because converting *generaldelta*
1428 consider setting this option because converting *generaldelta*
1429 repositories to the exchange format required by the bundle1 data
1429 repositories to the exchange format required by the bundle1 data
1430 format can consume a lot of CPU.
1430 format can consume a lot of CPU.
1431
1431
1432 ``smtp``
1432 ``smtp``
1433 --------
1433 --------
1434
1434
1435 Configuration for extensions that need to send email messages.
1435 Configuration for extensions that need to send email messages.
1436
1436
1437 ``host``
1437 ``host``
1438 Host name of mail server, e.g. "mail.example.com".
1438 Host name of mail server, e.g. "mail.example.com".
1439
1439
1440 ``port``
1440 ``port``
1441 Optional. Port to connect to on mail server. (default: 465 if
1441 Optional. Port to connect to on mail server. (default: 465 if
1442 ``tls`` is smtps; 25 otherwise)
1442 ``tls`` is smtps; 25 otherwise)
1443
1443
1444 ``tls``
1444 ``tls``
1445 Optional. Method to enable TLS when connecting to mail server: starttls,
1445 Optional. Method to enable TLS when connecting to mail server: starttls,
1446 smtps or none. (default: none)
1446 smtps or none. (default: none)
1447
1447
1448 ``verifycert``
1448 ``verifycert``
1449 Optional. Verification for the certificate of mail server, when
1449 Optional. Verification for the certificate of mail server, when
1450 ``tls`` is starttls or smtps. "strict", "loose" or False. For
1450 ``tls`` is starttls or smtps. "strict", "loose" or False. For
1451 "strict" or "loose", the certificate is verified as same as the
1451 "strict" or "loose", the certificate is verified as same as the
1452 verification for HTTPS connections (see ``[hostfingerprints]`` and
1452 verification for HTTPS connections (see ``[hostfingerprints]`` and
1453 ``[web] cacerts`` also). For "strict", sending email is also
1453 ``[web] cacerts`` also). For "strict", sending email is also
1454 aborted, if there is no configuration for mail server in
1454 aborted, if there is no configuration for mail server in
1455 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
1455 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
1456 :hg:`email` overwrites this as "loose". (default: strict)
1456 :hg:`email` overwrites this as "loose". (default: strict)
1457
1457
1458 ``username``
1458 ``username``
1459 Optional. User name for authenticating with the SMTP server.
1459 Optional. User name for authenticating with the SMTP server.
1460 (default: None)
1460 (default: None)
1461
1461
1462 ``password``
1462 ``password``
1463 Optional. Password for authenticating with the SMTP server. If not
1463 Optional. Password for authenticating with the SMTP server. If not
1464 specified, interactive sessions will prompt the user for a
1464 specified, interactive sessions will prompt the user for a
1465 password; non-interactive sessions will fail. (default: None)
1465 password; non-interactive sessions will fail. (default: None)
1466
1466
1467 ``local_hostname``
1467 ``local_hostname``
1468 Optional. The hostname that the sender can use to identify
1468 Optional. The hostname that the sender can use to identify
1469 itself to the MTA.
1469 itself to the MTA.
1470
1470
1471
1471
1472 ``subpaths``
1472 ``subpaths``
1473 ------------
1473 ------------
1474
1474
1475 Subrepository source URLs can go stale if a remote server changes name
1475 Subrepository source URLs can go stale if a remote server changes name
1476 or becomes temporarily unavailable. This section lets you define
1476 or becomes temporarily unavailable. This section lets you define
1477 rewrite rules of the form::
1477 rewrite rules of the form::
1478
1478
1479 <pattern> = <replacement>
1479 <pattern> = <replacement>
1480
1480
1481 where ``pattern`` is a regular expression matching a subrepository
1481 where ``pattern`` is a regular expression matching a subrepository
1482 source URL and ``replacement`` is the replacement string used to
1482 source URL and ``replacement`` is the replacement string used to
1483 rewrite it. Groups can be matched in ``pattern`` and referenced in
1483 rewrite it. Groups can be matched in ``pattern`` and referenced in
1484 ``replacements``. For instance::
1484 ``replacements``. For instance::
1485
1485
1486 http://server/(.*)-hg/ = http://hg.server/\1/
1486 http://server/(.*)-hg/ = http://hg.server/\1/
1487
1487
1488 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1488 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1489
1489
1490 Relative subrepository paths are first made absolute, and the
1490 Relative subrepository paths are first made absolute, and the
1491 rewrite rules are then applied on the full (absolute) path. The rules
1491 rewrite rules are then applied on the full (absolute) path. The rules
1492 are applied in definition order.
1492 are applied in definition order.
1493
1493
1494 ``trusted``
1494 ``trusted``
1495 -----------
1495 -----------
1496
1496
1497 Mercurial will not use the settings in the
1497 Mercurial will not use the settings in the
1498 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1498 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1499 user or to a trusted group, as various hgrc features allow arbitrary
1499 user or to a trusted group, as various hgrc features allow arbitrary
1500 commands to be run. This issue is often encountered when configuring
1500 commands to be run. This issue is often encountered when configuring
1501 hooks or extensions for shared repositories or servers. However,
1501 hooks or extensions for shared repositories or servers. However,
1502 the web interface will use some safe settings from the ``[web]``
1502 the web interface will use some safe settings from the ``[web]``
1503 section.
1503 section.
1504
1504
1505 This section specifies what users and groups are trusted. The
1505 This section specifies what users and groups are trusted. The
1506 current user is always trusted. To trust everybody, list a user or a
1506 current user is always trusted. To trust everybody, list a user or a
1507 group with name ``*``. These settings must be placed in an
1507 group with name ``*``. These settings must be placed in an
1508 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1508 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1509 user or service running Mercurial.
1509 user or service running Mercurial.
1510
1510
1511 ``users``
1511 ``users``
1512 Comma-separated list of trusted users.
1512 Comma-separated list of trusted users.
1513
1513
1514 ``groups``
1514 ``groups``
1515 Comma-separated list of trusted groups.
1515 Comma-separated list of trusted groups.
1516
1516
1517
1517
1518 ``ui``
1518 ``ui``
1519 ------
1519 ------
1520
1520
1521 User interface controls.
1521 User interface controls.
1522
1522
1523 ``archivemeta``
1523 ``archivemeta``
1524 Whether to include the .hg_archival.txt file containing meta data
1524 Whether to include the .hg_archival.txt file containing meta data
1525 (hashes for the repository base and for tip) in archives created
1525 (hashes for the repository base and for tip) in archives created
1526 by the :hg:`archive` command or downloaded via hgweb.
1526 by the :hg:`archive` command or downloaded via hgweb.
1527 (default: True)
1527 (default: True)
1528
1528
1529 ``askusername``
1529 ``askusername``
1530 Whether to prompt for a username when committing. If True, and
1530 Whether to prompt for a username when committing. If True, and
1531 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1531 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1532 be prompted to enter a username. If no username is entered, the
1532 be prompted to enter a username. If no username is entered, the
1533 default ``USER@HOST`` is used instead.
1533 default ``USER@HOST`` is used instead.
1534 (default: False)
1534 (default: False)
1535
1535
1536 ``clonebundles``
1536 ``clonebundles``
1537 Whether the "clone bundles" feature is enabled.
1537 Whether the "clone bundles" feature is enabled.
1538
1538
1539 When enabled, :hg:`clone` may download and apply a server-advertised
1539 When enabled, :hg:`clone` may download and apply a server-advertised
1540 bundle file from a URL instead of using the normal exchange mechanism.
1540 bundle file from a URL instead of using the normal exchange mechanism.
1541
1541
1542 This can likely result in faster and more reliable clones.
1542 This can likely result in faster and more reliable clones.
1543
1543
1544 (default: True)
1544 (default: True)
1545
1545
1546 ``clonebundlefallback``
1546 ``clonebundlefallback``
1547 Whether failure to apply an advertised "clone bundle" from a server
1547 Whether failure to apply an advertised "clone bundle" from a server
1548 should result in fallback to a regular clone.
1548 should result in fallback to a regular clone.
1549
1549
1550 This is disabled by default because servers advertising "clone
1550 This is disabled by default because servers advertising "clone
1551 bundles" often do so to reduce server load. If advertised bundles
1551 bundles" often do so to reduce server load. If advertised bundles
1552 start mass failing and clients automatically fall back to a regular
1552 start mass failing and clients automatically fall back to a regular
1553 clone, this would add significant and unexpected load to the server
1553 clone, this would add significant and unexpected load to the server
1554 since the server is expecting clone operations to be offloaded to
1554 since the server is expecting clone operations to be offloaded to
1555 pre-generated bundles. Failing fast (the default behavior) ensures
1555 pre-generated bundles. Failing fast (the default behavior) ensures
1556 clients don't overwhelm the server when "clone bundle" application
1556 clients don't overwhelm the server when "clone bundle" application
1557 fails.
1557 fails.
1558
1558
1559 (default: False)
1559 (default: False)
1560
1560
1561 ``clonebundleprefers``
1561 ``clonebundleprefers``
1562 Defines preferences for which "clone bundles" to use.
1562 Defines preferences for which "clone bundles" to use.
1563
1563
1564 Servers advertising "clone bundles" may advertise multiple available
1564 Servers advertising "clone bundles" may advertise multiple available
1565 bundles. Each bundle may have different attributes, such as the bundle
1565 bundles. Each bundle may have different attributes, such as the bundle
1566 type and compression format. This option is used to prefer a particular
1566 type and compression format. This option is used to prefer a particular
1567 bundle over another.
1567 bundle over another.
1568
1568
1569 The following keys are defined by Mercurial:
1569 The following keys are defined by Mercurial:
1570
1570
1571 BUNDLESPEC
1571 BUNDLESPEC
1572 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1572 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1573 e.g. ``gzip-v2`` or ``bzip2-v1``.
1573 e.g. ``gzip-v2`` or ``bzip2-v1``.
1574
1574
1575 COMPRESSION
1575 COMPRESSION
1576 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1576 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1577
1577
1578 Server operators may define custom keys.
1578 Server operators may define custom keys.
1579
1579
1580 Example values: ``COMPRESSION=bzip2``,
1580 Example values: ``COMPRESSION=bzip2``,
1581 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1581 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1582
1582
1583 By default, the first bundle advertised by the server is used.
1583 By default, the first bundle advertised by the server is used.
1584
1584
1585 ``commitsubrepos``
1585 ``commitsubrepos``
1586 Whether to commit modified subrepositories when committing the
1586 Whether to commit modified subrepositories when committing the
1587 parent repository. If False and one subrepository has uncommitted
1587 parent repository. If False and one subrepository has uncommitted
1588 changes, abort the commit.
1588 changes, abort the commit.
1589 (default: False)
1589 (default: False)
1590
1590
1591 ``debug``
1591 ``debug``
1592 Print debugging information. (default: False)
1592 Print debugging information. (default: False)
1593
1593
1594 ``editor``
1594 ``editor``
1595 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1595 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1596
1596
1597 ``fallbackencoding``
1597 ``fallbackencoding``
1598 Encoding to try if it's not possible to decode the changelog using
1598 Encoding to try if it's not possible to decode the changelog using
1599 UTF-8. (default: ISO-8859-1)
1599 UTF-8. (default: ISO-8859-1)
1600
1600
1601 ``graphnodetemplate``
1601 ``graphnodetemplate``
1602 The template used to print changeset nodes in an ASCII revision graph.
1602 The template used to print changeset nodes in an ASCII revision graph.
1603 (default: ``{graphnode}``)
1603 (default: ``{graphnode}``)
1604
1604
1605 ``ignore``
1605 ``ignore``
1606 A file to read per-user ignore patterns from. This file should be
1606 A file to read per-user ignore patterns from. This file should be
1607 in the same format as a repository-wide .hgignore file. Filenames
1607 in the same format as a repository-wide .hgignore file. Filenames
1608 are relative to the repository root. This option supports hook syntax,
1608 are relative to the repository root. This option supports hook syntax,
1609 so if you want to specify multiple ignore files, you can do so by
1609 so if you want to specify multiple ignore files, you can do so by
1610 setting something like ``ignore.other = ~/.hgignore2``. For details
1610 setting something like ``ignore.other = ~/.hgignore2``. For details
1611 of the ignore file format, see the ``hgignore(5)`` man page.
1611 of the ignore file format, see the ``hgignore(5)`` man page.
1612
1612
1613 ``interactive``
1613 ``interactive``
1614 Allow to prompt the user. (default: True)
1614 Allow to prompt the user. (default: True)
1615
1615
1616 ``interface``
1617 Select the default interface for interactive features (default: text).
1618 Possible values are 'text' and 'curses'.
1619
1620 ``interface.chunkselector``
1621 Select the interface for change recording (e.g. :hg:`commit` -i).
1622 Possible values are 'text' and 'curses'.
1623 This config overrides the interface specified by ui.interface.
1624
1616 ``logtemplate``
1625 ``logtemplate``
1617 Template string for commands that print changesets.
1626 Template string for commands that print changesets.
1618
1627
1619 ``merge``
1628 ``merge``
1620 The conflict resolution program to use during a manual merge.
1629 The conflict resolution program to use during a manual merge.
1621 For more information on merge tools see :hg:`help merge-tools`.
1630 For more information on merge tools see :hg:`help merge-tools`.
1622 For configuring merge tools see the ``[merge-tools]`` section.
1631 For configuring merge tools see the ``[merge-tools]`` section.
1623
1632
1624 ``mergemarkers``
1633 ``mergemarkers``
1625 Sets the merge conflict marker label styling. The ``detailed``
1634 Sets the merge conflict marker label styling. The ``detailed``
1626 style uses the ``mergemarkertemplate`` setting to style the labels.
1635 style uses the ``mergemarkertemplate`` setting to style the labels.
1627 The ``basic`` style just uses 'local' and 'other' as the marker label.
1636 The ``basic`` style just uses 'local' and 'other' as the marker label.
1628 One of ``basic`` or ``detailed``.
1637 One of ``basic`` or ``detailed``.
1629 (default: ``basic``)
1638 (default: ``basic``)
1630
1639
1631 ``mergemarkertemplate``
1640 ``mergemarkertemplate``
1632 The template used to print the commit description next to each conflict
1641 The template used to print the commit description next to each conflict
1633 marker during merge conflicts. See :hg:`help templates` for the template
1642 marker during merge conflicts. See :hg:`help templates` for the template
1634 format.
1643 format.
1635
1644
1636 Defaults to showing the hash, tags, branches, bookmarks, author, and
1645 Defaults to showing the hash, tags, branches, bookmarks, author, and
1637 the first line of the commit description.
1646 the first line of the commit description.
1638
1647
1639 If you use non-ASCII characters in names for tags, branches, bookmarks,
1648 If you use non-ASCII characters in names for tags, branches, bookmarks,
1640 authors, and/or commit descriptions, you must pay attention to encodings of
1649 authors, and/or commit descriptions, you must pay attention to encodings of
1641 managed files. At template expansion, non-ASCII characters use the encoding
1650 managed files. At template expansion, non-ASCII characters use the encoding
1642 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1651 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1643 environment variables that govern your locale. If the encoding of the merge
1652 environment variables that govern your locale. If the encoding of the merge
1644 markers is different from the encoding of the merged files,
1653 markers is different from the encoding of the merged files,
1645 serious problems may occur.
1654 serious problems may occur.
1646
1655
1647 ``origbackuppath``
1656 ``origbackuppath``
1648 The path to a directory used to store generated .orig files. If the path is
1657 The path to a directory used to store generated .orig files. If the path is
1649 not a directory, one will be created.
1658 not a directory, one will be created.
1650
1659
1651 ``patch``
1660 ``patch``
1652 An optional external tool that ``hg import`` and some extensions
1661 An optional external tool that ``hg import`` and some extensions
1653 will use for applying patches. By default Mercurial uses an
1662 will use for applying patches. By default Mercurial uses an
1654 internal patch utility. The external tool must work as the common
1663 internal patch utility. The external tool must work as the common
1655 Unix ``patch`` program. In particular, it must accept a ``-p``
1664 Unix ``patch`` program. In particular, it must accept a ``-p``
1656 argument to strip patch headers, a ``-d`` argument to specify the
1665 argument to strip patch headers, a ``-d`` argument to specify the
1657 current directory, a file name to patch, and a patch file to take
1666 current directory, a file name to patch, and a patch file to take
1658 from stdin.
1667 from stdin.
1659
1668
1660 It is possible to specify a patch tool together with extra
1669 It is possible to specify a patch tool together with extra
1661 arguments. For example, setting this option to ``patch --merge``
1670 arguments. For example, setting this option to ``patch --merge``
1662 will use the ``patch`` program with its 2-way merge option.
1671 will use the ``patch`` program with its 2-way merge option.
1663
1672
1664 ``portablefilenames``
1673 ``portablefilenames``
1665 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1674 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1666 (default: ``warn``)
1675 (default: ``warn``)
1667
1676
1668 ``warn``
1677 ``warn``
1669 Print a warning message on POSIX platforms, if a file with a non-portable
1678 Print a warning message on POSIX platforms, if a file with a non-portable
1670 filename is added (e.g. a file with a name that can't be created on
1679 filename is added (e.g. a file with a name that can't be created on
1671 Windows because it contains reserved parts like ``AUX``, reserved
1680 Windows because it contains reserved parts like ``AUX``, reserved
1672 characters like ``:``, or would cause a case collision with an existing
1681 characters like ``:``, or would cause a case collision with an existing
1673 file).
1682 file).
1674
1683
1675 ``ignore``
1684 ``ignore``
1676 Don't print a warning.
1685 Don't print a warning.
1677
1686
1678 ``abort``
1687 ``abort``
1679 The command is aborted.
1688 The command is aborted.
1680
1689
1681 ``true``
1690 ``true``
1682 Alias for ``warn``.
1691 Alias for ``warn``.
1683
1692
1684 ``false``
1693 ``false``
1685 Alias for ``ignore``.
1694 Alias for ``ignore``.
1686
1695
1687 .. container:: windows
1696 .. container:: windows
1688
1697
1689 On Windows, this configuration option is ignored and the command aborted.
1698 On Windows, this configuration option is ignored and the command aborted.
1690
1699
1691 ``quiet``
1700 ``quiet``
1692 Reduce the amount of output printed.
1701 Reduce the amount of output printed.
1693 (default: False)
1702 (default: False)
1694
1703
1695 ``remotecmd``
1704 ``remotecmd``
1696 Remote command to use for clone/push/pull operations.
1705 Remote command to use for clone/push/pull operations.
1697 (default: ``hg``)
1706 (default: ``hg``)
1698
1707
1699 ``report_untrusted``
1708 ``report_untrusted``
1700 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1709 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1701 trusted user or group.
1710 trusted user or group.
1702 (default: True)
1711 (default: True)
1703
1712
1704 ``slash``
1713 ``slash``
1705 Display paths using a slash (``/``) as the path separator. This
1714 Display paths using a slash (``/``) as the path separator. This
1706 only makes a difference on systems where the default path
1715 only makes a difference on systems where the default path
1707 separator is not the slash character (e.g. Windows uses the
1716 separator is not the slash character (e.g. Windows uses the
1708 backslash character (``\``)).
1717 backslash character (``\``)).
1709 (default: False)
1718 (default: False)
1710
1719
1711 ``statuscopies``
1720 ``statuscopies``
1712 Display copies in the status command.
1721 Display copies in the status command.
1713
1722
1714 ``ssh``
1723 ``ssh``
1715 Command to use for SSH connections. (default: ``ssh``)
1724 Command to use for SSH connections. (default: ``ssh``)
1716
1725
1717 ``strict``
1726 ``strict``
1718 Require exact command names, instead of allowing unambiguous
1727 Require exact command names, instead of allowing unambiguous
1719 abbreviations. (default: False)
1728 abbreviations. (default: False)
1720
1729
1721 ``style``
1730 ``style``
1722 Name of style to use for command output.
1731 Name of style to use for command output.
1723
1732
1724 ``supportcontact``
1733 ``supportcontact``
1725 A URL where users should report a Mercurial traceback. Use this if you are a
1734 A URL where users should report a Mercurial traceback. Use this if you are a
1726 large organisation with its own Mercurial deployment process and crash
1735 large organisation with its own Mercurial deployment process and crash
1727 reports should be addressed to your internal support.
1736 reports should be addressed to your internal support.
1728
1737
1729 ``timeout``
1738 ``timeout``
1730 The timeout used when a lock is held (in seconds), a negative value
1739 The timeout used when a lock is held (in seconds), a negative value
1731 means no timeout. (default: 600)
1740 means no timeout. (default: 600)
1732
1741
1733 ``traceback``
1742 ``traceback``
1734 Mercurial always prints a traceback when an unknown exception
1743 Mercurial always prints a traceback when an unknown exception
1735 occurs. Setting this to True will make Mercurial print a traceback
1744 occurs. Setting this to True will make Mercurial print a traceback
1736 on all exceptions, even those recognized by Mercurial (such as
1745 on all exceptions, even those recognized by Mercurial (such as
1737 IOError or MemoryError). (default: False)
1746 IOError or MemoryError). (default: False)
1738
1747
1739 ``username``
1748 ``username``
1740 The committer of a changeset created when running "commit".
1749 The committer of a changeset created when running "commit".
1741 Typically a person's name and email address, e.g. ``Fred Widget
1750 Typically a person's name and email address, e.g. ``Fred Widget
1742 <fred@example.com>``. Environment variables in the
1751 <fred@example.com>``. Environment variables in the
1743 username are expanded.
1752 username are expanded.
1744
1753
1745 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1754 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1746 hgrc is empty, e.g. if the system admin set ``username =`` in the
1755 hgrc is empty, e.g. if the system admin set ``username =`` in the
1747 system hgrc, it has to be specified manually or in a different
1756 system hgrc, it has to be specified manually or in a different
1748 hgrc file)
1757 hgrc file)
1749
1758
1750 ``verbose``
1759 ``verbose``
1751 Increase the amount of output printed. (default: False)
1760 Increase the amount of output printed. (default: False)
1752
1761
1753
1762
1754 ``web``
1763 ``web``
1755 -------
1764 -------
1756
1765
1757 Web interface configuration. The settings in this section apply to
1766 Web interface configuration. The settings in this section apply to
1758 both the builtin webserver (started by :hg:`serve`) and the script you
1767 both the builtin webserver (started by :hg:`serve`) and the script you
1759 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1768 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1760 and WSGI).
1769 and WSGI).
1761
1770
1762 The Mercurial webserver does no authentication (it does not prompt for
1771 The Mercurial webserver does no authentication (it does not prompt for
1763 usernames and passwords to validate *who* users are), but it does do
1772 usernames and passwords to validate *who* users are), but it does do
1764 authorization (it grants or denies access for *authenticated users*
1773 authorization (it grants or denies access for *authenticated users*
1765 based on settings in this section). You must either configure your
1774 based on settings in this section). You must either configure your
1766 webserver to do authentication for you, or disable the authorization
1775 webserver to do authentication for you, or disable the authorization
1767 checks.
1776 checks.
1768
1777
1769 For a quick setup in a trusted environment, e.g., a private LAN, where
1778 For a quick setup in a trusted environment, e.g., a private LAN, where
1770 you want it to accept pushes from anybody, you can use the following
1779 you want it to accept pushes from anybody, you can use the following
1771 command line::
1780 command line::
1772
1781
1773 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1782 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1774
1783
1775 Note that this will allow anybody to push anything to the server and
1784 Note that this will allow anybody to push anything to the server and
1776 that this should not be used for public servers.
1785 that this should not be used for public servers.
1777
1786
1778 The full set of options is:
1787 The full set of options is:
1779
1788
1780 ``accesslog``
1789 ``accesslog``
1781 Where to output the access log. (default: stdout)
1790 Where to output the access log. (default: stdout)
1782
1791
1783 ``address``
1792 ``address``
1784 Interface address to bind to. (default: all)
1793 Interface address to bind to. (default: all)
1785
1794
1786 ``allow_archive``
1795 ``allow_archive``
1787 List of archive format (bz2, gz, zip) allowed for downloading.
1796 List of archive format (bz2, gz, zip) allowed for downloading.
1788 (default: empty)
1797 (default: empty)
1789
1798
1790 ``allowbz2``
1799 ``allowbz2``
1791 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1800 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1792 revisions.
1801 revisions.
1793 (default: False)
1802 (default: False)
1794
1803
1795 ``allowgz``
1804 ``allowgz``
1796 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1805 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1797 revisions.
1806 revisions.
1798 (default: False)
1807 (default: False)
1799
1808
1800 ``allowpull``
1809 ``allowpull``
1801 Whether to allow pulling from the repository. (default: True)
1810 Whether to allow pulling from the repository. (default: True)
1802
1811
1803 ``allow_push``
1812 ``allow_push``
1804 Whether to allow pushing to the repository. If empty or not set,
1813 Whether to allow pushing to the repository. If empty or not set,
1805 pushing is not allowed. If the special value ``*``, any remote
1814 pushing is not allowed. If the special value ``*``, any remote
1806 user can push, including unauthenticated users. Otherwise, the
1815 user can push, including unauthenticated users. Otherwise, the
1807 remote user must have been authenticated, and the authenticated
1816 remote user must have been authenticated, and the authenticated
1808 user name must be present in this list. The contents of the
1817 user name must be present in this list. The contents of the
1809 allow_push list are examined after the deny_push list.
1818 allow_push list are examined after the deny_push list.
1810
1819
1811 ``allow_read``
1820 ``allow_read``
1812 If the user has not already been denied repository access due to
1821 If the user has not already been denied repository access due to
1813 the contents of deny_read, this list determines whether to grant
1822 the contents of deny_read, this list determines whether to grant
1814 repository access to the user. If this list is not empty, and the
1823 repository access to the user. If this list is not empty, and the
1815 user is unauthenticated or not present in the list, then access is
1824 user is unauthenticated or not present in the list, then access is
1816 denied for the user. If the list is empty or not set, then access
1825 denied for the user. If the list is empty or not set, then access
1817 is permitted to all users by default. Setting allow_read to the
1826 is permitted to all users by default. Setting allow_read to the
1818 special value ``*`` is equivalent to it not being set (i.e. access
1827 special value ``*`` is equivalent to it not being set (i.e. access
1819 is permitted to all users). The contents of the allow_read list are
1828 is permitted to all users). The contents of the allow_read list are
1820 examined after the deny_read list.
1829 examined after the deny_read list.
1821
1830
1822 ``allowzip``
1831 ``allowzip``
1823 (DEPRECATED) Whether to allow .zip downloading of repository
1832 (DEPRECATED) Whether to allow .zip downloading of repository
1824 revisions. This feature creates temporary files.
1833 revisions. This feature creates temporary files.
1825 (default: False)
1834 (default: False)
1826
1835
1827 ``archivesubrepos``
1836 ``archivesubrepos``
1828 Whether to recurse into subrepositories when archiving.
1837 Whether to recurse into subrepositories when archiving.
1829 (default: False)
1838 (default: False)
1830
1839
1831 ``baseurl``
1840 ``baseurl``
1832 Base URL to use when publishing URLs in other locations, so
1841 Base URL to use when publishing URLs in other locations, so
1833 third-party tools like email notification hooks can construct
1842 third-party tools like email notification hooks can construct
1834 URLs. Example: ``http://hgserver/repos/``.
1843 URLs. Example: ``http://hgserver/repos/``.
1835
1844
1836 ``cacerts``
1845 ``cacerts``
1837 Path to file containing a list of PEM encoded certificate
1846 Path to file containing a list of PEM encoded certificate
1838 authority certificates. Environment variables and ``~user``
1847 authority certificates. Environment variables and ``~user``
1839 constructs are expanded in the filename. If specified on the
1848 constructs are expanded in the filename. If specified on the
1840 client, then it will verify the identity of remote HTTPS servers
1849 client, then it will verify the identity of remote HTTPS servers
1841 with these certificates.
1850 with these certificates.
1842
1851
1843 This feature is only supported when using Python 2.6 or later. If you wish
1852 This feature is only supported when using Python 2.6 or later. If you wish
1844 to use it with earlier versions of Python, install the backported
1853 to use it with earlier versions of Python, install the backported
1845 version of the ssl library that is available from
1854 version of the ssl library that is available from
1846 ``http://pypi.python.org``.
1855 ``http://pypi.python.org``.
1847
1856
1848 To disable SSL verification temporarily, specify ``--insecure`` from
1857 To disable SSL verification temporarily, specify ``--insecure`` from
1849 command line.
1858 command line.
1850
1859
1851 You can use OpenSSL's CA certificate file if your platform has
1860 You can use OpenSSL's CA certificate file if your platform has
1852 one. On most Linux systems this will be
1861 one. On most Linux systems this will be
1853 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1862 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1854 generate this file manually. The form must be as follows::
1863 generate this file manually. The form must be as follows::
1855
1864
1856 -----BEGIN CERTIFICATE-----
1865 -----BEGIN CERTIFICATE-----
1857 ... (certificate in base64 PEM encoding) ...
1866 ... (certificate in base64 PEM encoding) ...
1858 -----END CERTIFICATE-----
1867 -----END CERTIFICATE-----
1859 -----BEGIN CERTIFICATE-----
1868 -----BEGIN CERTIFICATE-----
1860 ... (certificate in base64 PEM encoding) ...
1869 ... (certificate in base64 PEM encoding) ...
1861 -----END CERTIFICATE-----
1870 -----END CERTIFICATE-----
1862
1871
1863 ``cache``
1872 ``cache``
1864 Whether to support caching in hgweb. (default: True)
1873 Whether to support caching in hgweb. (default: True)
1865
1874
1866 ``certificate``
1875 ``certificate``
1867 Certificate to use when running :hg:`serve`.
1876 Certificate to use when running :hg:`serve`.
1868
1877
1869 ``collapse``
1878 ``collapse``
1870 With ``descend`` enabled, repositories in subdirectories are shown at
1879 With ``descend`` enabled, repositories in subdirectories are shown at
1871 a single level alongside repositories in the current path. With
1880 a single level alongside repositories in the current path. With
1872 ``collapse`` also enabled, repositories residing at a deeper level than
1881 ``collapse`` also enabled, repositories residing at a deeper level than
1873 the current path are grouped behind navigable directory entries that
1882 the current path are grouped behind navigable directory entries that
1874 lead to the locations of these repositories. In effect, this setting
1883 lead to the locations of these repositories. In effect, this setting
1875 collapses each collection of repositories found within a subdirectory
1884 collapses each collection of repositories found within a subdirectory
1876 into a single entry for that subdirectory. (default: False)
1885 into a single entry for that subdirectory. (default: False)
1877
1886
1878 ``comparisoncontext``
1887 ``comparisoncontext``
1879 Number of lines of context to show in side-by-side file comparison. If
1888 Number of lines of context to show in side-by-side file comparison. If
1880 negative or the value ``full``, whole files are shown. (default: 5)
1889 negative or the value ``full``, whole files are shown. (default: 5)
1881
1890
1882 This setting can be overridden by a ``context`` request parameter to the
1891 This setting can be overridden by a ``context`` request parameter to the
1883 ``comparison`` command, taking the same values.
1892 ``comparison`` command, taking the same values.
1884
1893
1885 ``contact``
1894 ``contact``
1886 Name or email address of the person in charge of the repository.
1895 Name or email address of the person in charge of the repository.
1887 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
1896 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
1888
1897
1889 ``deny_push``
1898 ``deny_push``
1890 Whether to deny pushing to the repository. If empty or not set,
1899 Whether to deny pushing to the repository. If empty or not set,
1891 push is not denied. If the special value ``*``, all remote users are
1900 push is not denied. If the special value ``*``, all remote users are
1892 denied push. Otherwise, unauthenticated users are all denied, and
1901 denied push. Otherwise, unauthenticated users are all denied, and
1893 any authenticated user name present in this list is also denied. The
1902 any authenticated user name present in this list is also denied. The
1894 contents of the deny_push list are examined before the allow_push list.
1903 contents of the deny_push list are examined before the allow_push list.
1895
1904
1896 ``deny_read``
1905 ``deny_read``
1897 Whether to deny reading/viewing of the repository. If this list is
1906 Whether to deny reading/viewing of the repository. If this list is
1898 not empty, unauthenticated users are all denied, and any
1907 not empty, unauthenticated users are all denied, and any
1899 authenticated user name present in this list is also denied access to
1908 authenticated user name present in this list is also denied access to
1900 the repository. If set to the special value ``*``, all remote users
1909 the repository. If set to the special value ``*``, all remote users
1901 are denied access (rarely needed ;). If deny_read is empty or not set,
1910 are denied access (rarely needed ;). If deny_read is empty or not set,
1902 the determination of repository access depends on the presence and
1911 the determination of repository access depends on the presence and
1903 content of the allow_read list (see description). If both
1912 content of the allow_read list (see description). If both
1904 deny_read and allow_read are empty or not set, then access is
1913 deny_read and allow_read are empty or not set, then access is
1905 permitted to all users by default. If the repository is being
1914 permitted to all users by default. If the repository is being
1906 served via hgwebdir, denied users will not be able to see it in
1915 served via hgwebdir, denied users will not be able to see it in
1907 the list of repositories. The contents of the deny_read list have
1916 the list of repositories. The contents of the deny_read list have
1908 priority over (are examined before) the contents of the allow_read
1917 priority over (are examined before) the contents of the allow_read
1909 list.
1918 list.
1910
1919
1911 ``descend``
1920 ``descend``
1912 hgwebdir indexes will not descend into subdirectories. Only repositories
1921 hgwebdir indexes will not descend into subdirectories. Only repositories
1913 directly in the current path will be shown (other repositories are still
1922 directly in the current path will be shown (other repositories are still
1914 available from the index corresponding to their containing path).
1923 available from the index corresponding to their containing path).
1915
1924
1916 ``description``
1925 ``description``
1917 Textual description of the repository's purpose or contents.
1926 Textual description of the repository's purpose or contents.
1918 (default: "unknown")
1927 (default: "unknown")
1919
1928
1920 ``encoding``
1929 ``encoding``
1921 Character encoding name. (default: the current locale charset)
1930 Character encoding name. (default: the current locale charset)
1922 Example: "UTF-8".
1931 Example: "UTF-8".
1923
1932
1924 ``errorlog``
1933 ``errorlog``
1925 Where to output the error log. (default: stderr)
1934 Where to output the error log. (default: stderr)
1926
1935
1927 ``guessmime``
1936 ``guessmime``
1928 Control MIME types for raw download of file content.
1937 Control MIME types for raw download of file content.
1929 Set to True to let hgweb guess the content type from the file
1938 Set to True to let hgweb guess the content type from the file
1930 extension. This will serve HTML files as ``text/html`` and might
1939 extension. This will serve HTML files as ``text/html`` and might
1931 allow cross-site scripting attacks when serving untrusted
1940 allow cross-site scripting attacks when serving untrusted
1932 repositories. (default: False)
1941 repositories. (default: False)
1933
1942
1934 ``hidden``
1943 ``hidden``
1935 Whether to hide the repository in the hgwebdir index.
1944 Whether to hide the repository in the hgwebdir index.
1936 (default: False)
1945 (default: False)
1937
1946
1938 ``ipv6``
1947 ``ipv6``
1939 Whether to use IPv6. (default: False)
1948 Whether to use IPv6. (default: False)
1940
1949
1941 ``logoimg``
1950 ``logoimg``
1942 File name of the logo image that some templates display on each page.
1951 File name of the logo image that some templates display on each page.
1943 The file name is relative to ``staticurl``. That is, the full path to
1952 The file name is relative to ``staticurl``. That is, the full path to
1944 the logo image is "staticurl/logoimg".
1953 the logo image is "staticurl/logoimg".
1945 If unset, ``hglogo.png`` will be used.
1954 If unset, ``hglogo.png`` will be used.
1946
1955
1947 ``logourl``
1956 ``logourl``
1948 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
1957 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
1949 will be used.
1958 will be used.
1950
1959
1951 ``maxchanges``
1960 ``maxchanges``
1952 Maximum number of changes to list on the changelog. (default: 10)
1961 Maximum number of changes to list on the changelog. (default: 10)
1953
1962
1954 ``maxfiles``
1963 ``maxfiles``
1955 Maximum number of files to list per changeset. (default: 10)
1964 Maximum number of files to list per changeset. (default: 10)
1956
1965
1957 ``maxshortchanges``
1966 ``maxshortchanges``
1958 Maximum number of changes to list on the shortlog, graph or filelog
1967 Maximum number of changes to list on the shortlog, graph or filelog
1959 pages. (default: 60)
1968 pages. (default: 60)
1960
1969
1961 ``name``
1970 ``name``
1962 Repository name to use in the web interface.
1971 Repository name to use in the web interface.
1963 (default: current working directory)
1972 (default: current working directory)
1964
1973
1965 ``port``
1974 ``port``
1966 Port to listen on. (default: 8000)
1975 Port to listen on. (default: 8000)
1967
1976
1968 ``prefix``
1977 ``prefix``
1969 Prefix path to serve from. (default: '' (server root))
1978 Prefix path to serve from. (default: '' (server root))
1970
1979
1971 ``push_ssl``
1980 ``push_ssl``
1972 Whether to require that inbound pushes be transported over SSL to
1981 Whether to require that inbound pushes be transported over SSL to
1973 prevent password sniffing. (default: True)
1982 prevent password sniffing. (default: True)
1974
1983
1975 ``refreshinterval``
1984 ``refreshinterval``
1976 How frequently directory listings re-scan the filesystem for new
1985 How frequently directory listings re-scan the filesystem for new
1977 repositories, in seconds. This is relevant when wildcards are used
1986 repositories, in seconds. This is relevant when wildcards are used
1978 to define paths. Depending on how much filesystem traversal is
1987 to define paths. Depending on how much filesystem traversal is
1979 required, refreshing may negatively impact performance.
1988 required, refreshing may negatively impact performance.
1980
1989
1981 Values less than or equal to 0 always refresh.
1990 Values less than or equal to 0 always refresh.
1982 (default: 20)
1991 (default: 20)
1983
1992
1984 ``staticurl``
1993 ``staticurl``
1985 Base URL to use for static files. If unset, static files (e.g. the
1994 Base URL to use for static files. If unset, static files (e.g. the
1986 hgicon.png favicon) will be served by the CGI script itself. Use
1995 hgicon.png favicon) will be served by the CGI script itself. Use
1987 this setting to serve them directly with the HTTP server.
1996 this setting to serve them directly with the HTTP server.
1988 Example: ``http://hgserver/static/``.
1997 Example: ``http://hgserver/static/``.
1989
1998
1990 ``stripes``
1999 ``stripes``
1991 How many lines a "zebra stripe" should span in multi-line output.
2000 How many lines a "zebra stripe" should span in multi-line output.
1992 Set to 0 to disable. (default: 1)
2001 Set to 0 to disable. (default: 1)
1993
2002
1994 ``style``
2003 ``style``
1995 Which template map style to use. The available options are the names of
2004 Which template map style to use. The available options are the names of
1996 subdirectories in the HTML templates path. (default: ``paper``)
2005 subdirectories in the HTML templates path. (default: ``paper``)
1997 Example: ``monoblue``.
2006 Example: ``monoblue``.
1998
2007
1999 ``templates``
2008 ``templates``
2000 Where to find the HTML templates. The default path to the HTML templates
2009 Where to find the HTML templates. The default path to the HTML templates
2001 can be obtained from ``hg debuginstall``.
2010 can be obtained from ``hg debuginstall``.
2002
2011
2003 ``websub``
2012 ``websub``
2004 ----------
2013 ----------
2005
2014
2006 Web substitution filter definition. You can use this section to
2015 Web substitution filter definition. You can use this section to
2007 define a set of regular expression substitution patterns which
2016 define a set of regular expression substitution patterns which
2008 let you automatically modify the hgweb server output.
2017 let you automatically modify the hgweb server output.
2009
2018
2010 The default hgweb templates only apply these substitution patterns
2019 The default hgweb templates only apply these substitution patterns
2011 on the revision description fields. You can apply them anywhere
2020 on the revision description fields. You can apply them anywhere
2012 you want when you create your own templates by adding calls to the
2021 you want when you create your own templates by adding calls to the
2013 "websub" filter (usually after calling the "escape" filter).
2022 "websub" filter (usually after calling the "escape" filter).
2014
2023
2015 This can be used, for example, to convert issue references to links
2024 This can be used, for example, to convert issue references to links
2016 to your issue tracker, or to convert "markdown-like" syntax into
2025 to your issue tracker, or to convert "markdown-like" syntax into
2017 HTML (see the examples below).
2026 HTML (see the examples below).
2018
2027
2019 Each entry in this section names a substitution filter.
2028 Each entry in this section names a substitution filter.
2020 The value of each entry defines the substitution expression itself.
2029 The value of each entry defines the substitution expression itself.
2021 The websub expressions follow the old interhg extension syntax,
2030 The websub expressions follow the old interhg extension syntax,
2022 which in turn imitates the Unix sed replacement syntax::
2031 which in turn imitates the Unix sed replacement syntax::
2023
2032
2024 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2033 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2025
2034
2026 You can use any separator other than "/". The final "i" is optional
2035 You can use any separator other than "/". The final "i" is optional
2027 and indicates that the search must be case insensitive.
2036 and indicates that the search must be case insensitive.
2028
2037
2029 Examples::
2038 Examples::
2030
2039
2031 [websub]
2040 [websub]
2032 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2041 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2033 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2042 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2034 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2043 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2035
2044
2036 ``worker``
2045 ``worker``
2037 ----------
2046 ----------
2038
2047
2039 Parallel master/worker configuration. We currently perform working
2048 Parallel master/worker configuration. We currently perform working
2040 directory updates in parallel on Unix-like systems, which greatly
2049 directory updates in parallel on Unix-like systems, which greatly
2041 helps performance.
2050 helps performance.
2042
2051
2043 ``numcpus``
2052 ``numcpus``
2044 Number of CPUs to use for parallel operations. A zero or
2053 Number of CPUs to use for parallel operations. A zero or
2045 negative value is treated as ``use the default``.
2054 negative value is treated as ``use the default``.
2046 (default: 4 or the number of CPUs on the system, whichever is larger)
2055 (default: 4 or the number of CPUs on the system, whichever is larger)
2047
2056
2048 ``backgroundclose``
2057 ``backgroundclose``
2049 Whether to enable closing file handles on background threads during certain
2058 Whether to enable closing file handles on background threads during certain
2050 operations. Some platforms aren't very efficient at closing file
2059 operations. Some platforms aren't very efficient at closing file
2051 handles that have been written or appended to. By performing file closing
2060 handles that have been written or appended to. By performing file closing
2052 on background threads, file write rate can increase substantially.
2061 on background threads, file write rate can increase substantially.
2053 (default: true on Windows, false elsewhere)
2062 (default: true on Windows, false elsewhere)
2054
2063
2055 ``backgroundcloseminfilecount``
2064 ``backgroundcloseminfilecount``
2056 Minimum number of files required to trigger background file closing.
2065 Minimum number of files required to trigger background file closing.
2057 Operations not writing this many files won't start background close
2066 Operations not writing this many files won't start background close
2058 threads.
2067 threads.
2059 (default: 2048)
2068 (default: 2048)
2060
2069
2061 ``backgroundclosemaxqueue``
2070 ``backgroundclosemaxqueue``
2062 The maximum number of opened file handles waiting to be closed in the
2071 The maximum number of opened file handles waiting to be closed in the
2063 background. This option only has an effect if ``backgroundclose`` is
2072 background. This option only has an effect if ``backgroundclose`` is
2064 enabled.
2073 enabled.
2065 (default: 384)
2074 (default: 384)
2066
2075
2067 ``backgroundclosethreadcount``
2076 ``backgroundclosethreadcount``
2068 Number of threads to process background file closes. Only relevant if
2077 Number of threads to process background file closes. Only relevant if
2069 ``backgroundclose`` is enabled.
2078 ``backgroundclose`` is enabled.
2070 (default: 4)
2079 (default: 4)
@@ -1,1265 +1,1336 b''
1 # ui.py - user interface bits for mercurial
1 # ui.py - user interface bits for mercurial
2 #
2 #
3 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
3 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7
7
8 from __future__ import absolute_import
8 from __future__ import absolute_import
9
9
10 import errno
10 import errno
11 import getpass
11 import getpass
12 import inspect
12 import inspect
13 import os
13 import os
14 import re
14 import re
15 import socket
15 import socket
16 import sys
16 import sys
17 import tempfile
17 import tempfile
18 import traceback
18 import traceback
19
19
20 from .i18n import _
20 from .i18n import _
21 from .node import hex
21 from .node import hex
22
22
23 from . import (
23 from . import (
24 config,
24 config,
25 error,
25 error,
26 formatter,
26 formatter,
27 progress,
27 progress,
28 scmutil,
28 scmutil,
29 util,
29 util,
30 )
30 )
31
31
32 samplehgrcs = {
32 samplehgrcs = {
33 'user':
33 'user':
34 """# example user config (see "hg help config" for more info)
34 """# example user config (see "hg help config" for more info)
35 [ui]
35 [ui]
36 # name and email, e.g.
36 # name and email, e.g.
37 # username = Jane Doe <jdoe@example.com>
37 # username = Jane Doe <jdoe@example.com>
38 username =
38 username =
39
39
40 [extensions]
40 [extensions]
41 # uncomment these lines to enable some popular extensions
41 # uncomment these lines to enable some popular extensions
42 # (see "hg help extensions" for more info)
42 # (see "hg help extensions" for more info)
43 #
43 #
44 # pager =
44 # pager =
45 # color =""",
45 # color =""",
46
46
47 'cloned':
47 'cloned':
48 """# example repository config (see "hg help config" for more info)
48 """# example repository config (see "hg help config" for more info)
49 [paths]
49 [paths]
50 default = %s
50 default = %s
51
51
52 # path aliases to other clones of this repo in URLs or filesystem paths
52 # path aliases to other clones of this repo in URLs or filesystem paths
53 # (see "hg help config.paths" for more info)
53 # (see "hg help config.paths" for more info)
54 #
54 #
55 # default-push = ssh://jdoe@example.net/hg/jdoes-fork
55 # default-push = ssh://jdoe@example.net/hg/jdoes-fork
56 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
56 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
57 # my-clone = /home/jdoe/jdoes-clone
57 # my-clone = /home/jdoe/jdoes-clone
58
58
59 [ui]
59 [ui]
60 # name and email (local to this repository, optional), e.g.
60 # name and email (local to this repository, optional), e.g.
61 # username = Jane Doe <jdoe@example.com>
61 # username = Jane Doe <jdoe@example.com>
62 """,
62 """,
63
63
64 'local':
64 'local':
65 """# example repository config (see "hg help config" for more info)
65 """# example repository config (see "hg help config" for more info)
66 [paths]
66 [paths]
67 # path aliases to other clones of this repo in URLs or filesystem paths
67 # path aliases to other clones of this repo in URLs or filesystem paths
68 # (see "hg help config.paths" for more info)
68 # (see "hg help config.paths" for more info)
69 #
69 #
70 # default = http://example.com/hg/example-repo
70 # default = http://example.com/hg/example-repo
71 # default-push = ssh://jdoe@example.net/hg/jdoes-fork
71 # default-push = ssh://jdoe@example.net/hg/jdoes-fork
72 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
72 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
73 # my-clone = /home/jdoe/jdoes-clone
73 # my-clone = /home/jdoe/jdoes-clone
74
74
75 [ui]
75 [ui]
76 # name and email (local to this repository, optional), e.g.
76 # name and email (local to this repository, optional), e.g.
77 # username = Jane Doe <jdoe@example.com>
77 # username = Jane Doe <jdoe@example.com>
78 """,
78 """,
79
79
80 'global':
80 'global':
81 """# example system-wide hg config (see "hg help config" for more info)
81 """# example system-wide hg config (see "hg help config" for more info)
82
82
83 [extensions]
83 [extensions]
84 # uncomment these lines to enable some popular extensions
84 # uncomment these lines to enable some popular extensions
85 # (see "hg help extensions" for more info)
85 # (see "hg help extensions" for more info)
86 #
86 #
87 # blackbox =
87 # blackbox =
88 # color =
88 # color =
89 # pager =""",
89 # pager =""",
90 }
90 }
91
91
92 class ui(object):
92 class ui(object):
93 def __init__(self, src=None):
93 def __init__(self, src=None):
94 # _buffers: used for temporary capture of output
94 # _buffers: used for temporary capture of output
95 self._buffers = []
95 self._buffers = []
96 # 3-tuple describing how each buffer in the stack behaves.
96 # 3-tuple describing how each buffer in the stack behaves.
97 # Values are (capture stderr, capture subprocesses, apply labels).
97 # Values are (capture stderr, capture subprocesses, apply labels).
98 self._bufferstates = []
98 self._bufferstates = []
99 # When a buffer is active, defines whether we are expanding labels.
99 # When a buffer is active, defines whether we are expanding labels.
100 # This exists to prevent an extra list lookup.
100 # This exists to prevent an extra list lookup.
101 self._bufferapplylabels = None
101 self._bufferapplylabels = None
102 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
102 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
103 self._reportuntrusted = True
103 self._reportuntrusted = True
104 self._ocfg = config.config() # overlay
104 self._ocfg = config.config() # overlay
105 self._tcfg = config.config() # trusted
105 self._tcfg = config.config() # trusted
106 self._ucfg = config.config() # untrusted
106 self._ucfg = config.config() # untrusted
107 self._trustusers = set()
107 self._trustusers = set()
108 self._trustgroups = set()
108 self._trustgroups = set()
109 self.callhooks = True
109 self.callhooks = True
110
110
111 if src:
111 if src:
112 self.fout = src.fout
112 self.fout = src.fout
113 self.ferr = src.ferr
113 self.ferr = src.ferr
114 self.fin = src.fin
114 self.fin = src.fin
115
115
116 self._tcfg = src._tcfg.copy()
116 self._tcfg = src._tcfg.copy()
117 self._ucfg = src._ucfg.copy()
117 self._ucfg = src._ucfg.copy()
118 self._ocfg = src._ocfg.copy()
118 self._ocfg = src._ocfg.copy()
119 self._trustusers = src._trustusers.copy()
119 self._trustusers = src._trustusers.copy()
120 self._trustgroups = src._trustgroups.copy()
120 self._trustgroups = src._trustgroups.copy()
121 self.environ = src.environ
121 self.environ = src.environ
122 self.callhooks = src.callhooks
122 self.callhooks = src.callhooks
123 self.fixconfig()
123 self.fixconfig()
124 else:
124 else:
125 self.fout = sys.stdout
125 self.fout = sys.stdout
126 self.ferr = sys.stderr
126 self.ferr = sys.stderr
127 self.fin = sys.stdin
127 self.fin = sys.stdin
128
128
129 # shared read-only environment
129 # shared read-only environment
130 self.environ = os.environ
130 self.environ = os.environ
131 # we always trust global config files
131 # we always trust global config files
132 for f in scmutil.rcpath():
132 for f in scmutil.rcpath():
133 self.readconfig(f, trust=True)
133 self.readconfig(f, trust=True)
134
134
135 def copy(self):
135 def copy(self):
136 return self.__class__(self)
136 return self.__class__(self)
137
137
138 def formatter(self, topic, opts):
138 def formatter(self, topic, opts):
139 return formatter.formatter(self, topic, opts)
139 return formatter.formatter(self, topic, opts)
140
140
141 def _trusted(self, fp, f):
141 def _trusted(self, fp, f):
142 st = util.fstat(fp)
142 st = util.fstat(fp)
143 if util.isowner(st):
143 if util.isowner(st):
144 return True
144 return True
145
145
146 tusers, tgroups = self._trustusers, self._trustgroups
146 tusers, tgroups = self._trustusers, self._trustgroups
147 if '*' in tusers or '*' in tgroups:
147 if '*' in tusers or '*' in tgroups:
148 return True
148 return True
149
149
150 user = util.username(st.st_uid)
150 user = util.username(st.st_uid)
151 group = util.groupname(st.st_gid)
151 group = util.groupname(st.st_gid)
152 if user in tusers or group in tgroups or user == util.username():
152 if user in tusers or group in tgroups or user == util.username():
153 return True
153 return True
154
154
155 if self._reportuntrusted:
155 if self._reportuntrusted:
156 self.warn(_('not trusting file %s from untrusted '
156 self.warn(_('not trusting file %s from untrusted '
157 'user %s, group %s\n') % (f, user, group))
157 'user %s, group %s\n') % (f, user, group))
158 return False
158 return False
159
159
160 def readconfig(self, filename, root=None, trust=False,
160 def readconfig(self, filename, root=None, trust=False,
161 sections=None, remap=None):
161 sections=None, remap=None):
162 try:
162 try:
163 fp = open(filename)
163 fp = open(filename)
164 except IOError:
164 except IOError:
165 if not sections: # ignore unless we were looking for something
165 if not sections: # ignore unless we were looking for something
166 return
166 return
167 raise
167 raise
168
168
169 cfg = config.config()
169 cfg = config.config()
170 trusted = sections or trust or self._trusted(fp, filename)
170 trusted = sections or trust or self._trusted(fp, filename)
171
171
172 try:
172 try:
173 cfg.read(filename, fp, sections=sections, remap=remap)
173 cfg.read(filename, fp, sections=sections, remap=remap)
174 fp.close()
174 fp.close()
175 except error.ConfigError as inst:
175 except error.ConfigError as inst:
176 if trusted:
176 if trusted:
177 raise
177 raise
178 self.warn(_("ignored: %s\n") % str(inst))
178 self.warn(_("ignored: %s\n") % str(inst))
179
179
180 if self.plain():
180 if self.plain():
181 for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
181 for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
182 'logtemplate', 'statuscopies', 'style',
182 'logtemplate', 'statuscopies', 'style',
183 'traceback', 'verbose'):
183 'traceback', 'verbose'):
184 if k in cfg['ui']:
184 if k in cfg['ui']:
185 del cfg['ui'][k]
185 del cfg['ui'][k]
186 for k, v in cfg.items('defaults'):
186 for k, v in cfg.items('defaults'):
187 del cfg['defaults'][k]
187 del cfg['defaults'][k]
188 # Don't remove aliases from the configuration if in the exceptionlist
188 # Don't remove aliases from the configuration if in the exceptionlist
189 if self.plain('alias'):
189 if self.plain('alias'):
190 for k, v in cfg.items('alias'):
190 for k, v in cfg.items('alias'):
191 del cfg['alias'][k]
191 del cfg['alias'][k]
192 if self.plain('revsetalias'):
192 if self.plain('revsetalias'):
193 for k, v in cfg.items('revsetalias'):
193 for k, v in cfg.items('revsetalias'):
194 del cfg['revsetalias'][k]
194 del cfg['revsetalias'][k]
195
195
196 if trusted:
196 if trusted:
197 self._tcfg.update(cfg)
197 self._tcfg.update(cfg)
198 self._tcfg.update(self._ocfg)
198 self._tcfg.update(self._ocfg)
199 self._ucfg.update(cfg)
199 self._ucfg.update(cfg)
200 self._ucfg.update(self._ocfg)
200 self._ucfg.update(self._ocfg)
201
201
202 if root is None:
202 if root is None:
203 root = os.path.expanduser('~')
203 root = os.path.expanduser('~')
204 self.fixconfig(root=root)
204 self.fixconfig(root=root)
205
205
206 def fixconfig(self, root=None, section=None):
206 def fixconfig(self, root=None, section=None):
207 if section in (None, 'paths'):
207 if section in (None, 'paths'):
208 # expand vars and ~
208 # expand vars and ~
209 # translate paths relative to root (or home) into absolute paths
209 # translate paths relative to root (or home) into absolute paths
210 root = root or os.getcwd()
210 root = root or os.getcwd()
211 for c in self._tcfg, self._ucfg, self._ocfg:
211 for c in self._tcfg, self._ucfg, self._ocfg:
212 for n, p in c.items('paths'):
212 for n, p in c.items('paths'):
213 if not p:
213 if not p:
214 continue
214 continue
215 if '%%' in p:
215 if '%%' in p:
216 self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
216 self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
217 % (n, p, self.configsource('paths', n)))
217 % (n, p, self.configsource('paths', n)))
218 p = p.replace('%%', '%')
218 p = p.replace('%%', '%')
219 p = util.expandpath(p)
219 p = util.expandpath(p)
220 if not util.hasscheme(p) and not os.path.isabs(p):
220 if not util.hasscheme(p) and not os.path.isabs(p):
221 p = os.path.normpath(os.path.join(root, p))
221 p = os.path.normpath(os.path.join(root, p))
222 c.set("paths", n, p)
222 c.set("paths", n, p)
223
223
224 if section in (None, 'ui'):
224 if section in (None, 'ui'):
225 # update ui options
225 # update ui options
226 self.debugflag = self.configbool('ui', 'debug')
226 self.debugflag = self.configbool('ui', 'debug')
227 self.verbose = self.debugflag or self.configbool('ui', 'verbose')
227 self.verbose = self.debugflag or self.configbool('ui', 'verbose')
228 self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
228 self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
229 if self.verbose and self.quiet:
229 if self.verbose and self.quiet:
230 self.quiet = self.verbose = False
230 self.quiet = self.verbose = False
231 self._reportuntrusted = self.debugflag or self.configbool("ui",
231 self._reportuntrusted = self.debugflag or self.configbool("ui",
232 "report_untrusted", True)
232 "report_untrusted", True)
233 self.tracebackflag = self.configbool('ui', 'traceback', False)
233 self.tracebackflag = self.configbool('ui', 'traceback', False)
234
234
235 if section in (None, 'trusted'):
235 if section in (None, 'trusted'):
236 # update trust information
236 # update trust information
237 self._trustusers.update(self.configlist('trusted', 'users'))
237 self._trustusers.update(self.configlist('trusted', 'users'))
238 self._trustgroups.update(self.configlist('trusted', 'groups'))
238 self._trustgroups.update(self.configlist('trusted', 'groups'))
239
239
240 def backupconfig(self, section, item):
240 def backupconfig(self, section, item):
241 return (self._ocfg.backup(section, item),
241 return (self._ocfg.backup(section, item),
242 self._tcfg.backup(section, item),
242 self._tcfg.backup(section, item),
243 self._ucfg.backup(section, item),)
243 self._ucfg.backup(section, item),)
244 def restoreconfig(self, data):
244 def restoreconfig(self, data):
245 self._ocfg.restore(data[0])
245 self._ocfg.restore(data[0])
246 self._tcfg.restore(data[1])
246 self._tcfg.restore(data[1])
247 self._ucfg.restore(data[2])
247 self._ucfg.restore(data[2])
248
248
249 def setconfig(self, section, name, value, source=''):
249 def setconfig(self, section, name, value, source=''):
250 for cfg in (self._ocfg, self._tcfg, self._ucfg):
250 for cfg in (self._ocfg, self._tcfg, self._ucfg):
251 cfg.set(section, name, value, source)
251 cfg.set(section, name, value, source)
252 self.fixconfig(section=section)
252 self.fixconfig(section=section)
253
253
254 def _data(self, untrusted):
254 def _data(self, untrusted):
255 return untrusted and self._ucfg or self._tcfg
255 return untrusted and self._ucfg or self._tcfg
256
256
257 def configsource(self, section, name, untrusted=False):
257 def configsource(self, section, name, untrusted=False):
258 return self._data(untrusted).source(section, name) or 'none'
258 return self._data(untrusted).source(section, name) or 'none'
259
259
260 def config(self, section, name, default=None, untrusted=False):
260 def config(self, section, name, default=None, untrusted=False):
261 if isinstance(name, list):
261 if isinstance(name, list):
262 alternates = name
262 alternates = name
263 else:
263 else:
264 alternates = [name]
264 alternates = [name]
265
265
266 for n in alternates:
266 for n in alternates:
267 value = self._data(untrusted).get(section, n, None)
267 value = self._data(untrusted).get(section, n, None)
268 if value is not None:
268 if value is not None:
269 name = n
269 name = n
270 break
270 break
271 else:
271 else:
272 value = default
272 value = default
273
273
274 if self.debugflag and not untrusted and self._reportuntrusted:
274 if self.debugflag and not untrusted and self._reportuntrusted:
275 for n in alternates:
275 for n in alternates:
276 uvalue = self._ucfg.get(section, n)
276 uvalue = self._ucfg.get(section, n)
277 if uvalue is not None and uvalue != value:
277 if uvalue is not None and uvalue != value:
278 self.debug("ignoring untrusted configuration option "
278 self.debug("ignoring untrusted configuration option "
279 "%s.%s = %s\n" % (section, n, uvalue))
279 "%s.%s = %s\n" % (section, n, uvalue))
280 return value
280 return value
281
281
282 def configsuboptions(self, section, name, default=None, untrusted=False):
282 def configsuboptions(self, section, name, default=None, untrusted=False):
283 """Get a config option and all sub-options.
283 """Get a config option and all sub-options.
284
284
285 Some config options have sub-options that are declared with the
285 Some config options have sub-options that are declared with the
286 format "key:opt = value". This method is used to return the main
286 format "key:opt = value". This method is used to return the main
287 option and all its declared sub-options.
287 option and all its declared sub-options.
288
288
289 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
289 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
290 is a dict of defined sub-options where keys and values are strings.
290 is a dict of defined sub-options where keys and values are strings.
291 """
291 """
292 data = self._data(untrusted)
292 data = self._data(untrusted)
293 main = data.get(section, name, default)
293 main = data.get(section, name, default)
294 if self.debugflag and not untrusted and self._reportuntrusted:
294 if self.debugflag and not untrusted and self._reportuntrusted:
295 uvalue = self._ucfg.get(section, name)
295 uvalue = self._ucfg.get(section, name)
296 if uvalue is not None and uvalue != main:
296 if uvalue is not None and uvalue != main:
297 self.debug('ignoring untrusted configuration option '
297 self.debug('ignoring untrusted configuration option '
298 '%s.%s = %s\n' % (section, name, uvalue))
298 '%s.%s = %s\n' % (section, name, uvalue))
299
299
300 sub = {}
300 sub = {}
301 prefix = '%s:' % name
301 prefix = '%s:' % name
302 for k, v in data.items(section):
302 for k, v in data.items(section):
303 if k.startswith(prefix):
303 if k.startswith(prefix):
304 sub[k[len(prefix):]] = v
304 sub[k[len(prefix):]] = v
305
305
306 if self.debugflag and not untrusted and self._reportuntrusted:
306 if self.debugflag and not untrusted and self._reportuntrusted:
307 for k, v in sub.items():
307 for k, v in sub.items():
308 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
308 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
309 if uvalue is not None and uvalue != v:
309 if uvalue is not None and uvalue != v:
310 self.debug('ignoring untrusted configuration option '
310 self.debug('ignoring untrusted configuration option '
311 '%s:%s.%s = %s\n' % (section, name, k, uvalue))
311 '%s:%s.%s = %s\n' % (section, name, k, uvalue))
312
312
313 return main, sub
313 return main, sub
314
314
315 def configpath(self, section, name, default=None, untrusted=False):
315 def configpath(self, section, name, default=None, untrusted=False):
316 'get a path config item, expanded relative to repo root or config file'
316 'get a path config item, expanded relative to repo root or config file'
317 v = self.config(section, name, default, untrusted)
317 v = self.config(section, name, default, untrusted)
318 if v is None:
318 if v is None:
319 return None
319 return None
320 if not os.path.isabs(v) or "://" not in v:
320 if not os.path.isabs(v) or "://" not in v:
321 src = self.configsource(section, name, untrusted)
321 src = self.configsource(section, name, untrusted)
322 if ':' in src:
322 if ':' in src:
323 base = os.path.dirname(src.rsplit(':')[0])
323 base = os.path.dirname(src.rsplit(':')[0])
324 v = os.path.join(base, os.path.expanduser(v))
324 v = os.path.join(base, os.path.expanduser(v))
325 return v
325 return v
326
326
327 def configbool(self, section, name, default=False, untrusted=False):
327 def configbool(self, section, name, default=False, untrusted=False):
328 """parse a configuration element as a boolean
328 """parse a configuration element as a boolean
329
329
330 >>> u = ui(); s = 'foo'
330 >>> u = ui(); s = 'foo'
331 >>> u.setconfig(s, 'true', 'yes')
331 >>> u.setconfig(s, 'true', 'yes')
332 >>> u.configbool(s, 'true')
332 >>> u.configbool(s, 'true')
333 True
333 True
334 >>> u.setconfig(s, 'false', 'no')
334 >>> u.setconfig(s, 'false', 'no')
335 >>> u.configbool(s, 'false')
335 >>> u.configbool(s, 'false')
336 False
336 False
337 >>> u.configbool(s, 'unknown')
337 >>> u.configbool(s, 'unknown')
338 False
338 False
339 >>> u.configbool(s, 'unknown', True)
339 >>> u.configbool(s, 'unknown', True)
340 True
340 True
341 >>> u.setconfig(s, 'invalid', 'somevalue')
341 >>> u.setconfig(s, 'invalid', 'somevalue')
342 >>> u.configbool(s, 'invalid')
342 >>> u.configbool(s, 'invalid')
343 Traceback (most recent call last):
343 Traceback (most recent call last):
344 ...
344 ...
345 ConfigError: foo.invalid is not a boolean ('somevalue')
345 ConfigError: foo.invalid is not a boolean ('somevalue')
346 """
346 """
347
347
348 v = self.config(section, name, None, untrusted)
348 v = self.config(section, name, None, untrusted)
349 if v is None:
349 if v is None:
350 return default
350 return default
351 if isinstance(v, bool):
351 if isinstance(v, bool):
352 return v
352 return v
353 b = util.parsebool(v)
353 b = util.parsebool(v)
354 if b is None:
354 if b is None:
355 raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
355 raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
356 % (section, name, v))
356 % (section, name, v))
357 return b
357 return b
358
358
359 def configint(self, section, name, default=None, untrusted=False):
359 def configint(self, section, name, default=None, untrusted=False):
360 """parse a configuration element as an integer
360 """parse a configuration element as an integer
361
361
362 >>> u = ui(); s = 'foo'
362 >>> u = ui(); s = 'foo'
363 >>> u.setconfig(s, 'int1', '42')
363 >>> u.setconfig(s, 'int1', '42')
364 >>> u.configint(s, 'int1')
364 >>> u.configint(s, 'int1')
365 42
365 42
366 >>> u.setconfig(s, 'int2', '-42')
366 >>> u.setconfig(s, 'int2', '-42')
367 >>> u.configint(s, 'int2')
367 >>> u.configint(s, 'int2')
368 -42
368 -42
369 >>> u.configint(s, 'unknown', 7)
369 >>> u.configint(s, 'unknown', 7)
370 7
370 7
371 >>> u.setconfig(s, 'invalid', 'somevalue')
371 >>> u.setconfig(s, 'invalid', 'somevalue')
372 >>> u.configint(s, 'invalid')
372 >>> u.configint(s, 'invalid')
373 Traceback (most recent call last):
373 Traceback (most recent call last):
374 ...
374 ...
375 ConfigError: foo.invalid is not an integer ('somevalue')
375 ConfigError: foo.invalid is not an integer ('somevalue')
376 """
376 """
377
377
378 v = self.config(section, name, None, untrusted)
378 v = self.config(section, name, None, untrusted)
379 if v is None:
379 if v is None:
380 return default
380 return default
381 try:
381 try:
382 return int(v)
382 return int(v)
383 except ValueError:
383 except ValueError:
384 raise error.ConfigError(_("%s.%s is not an integer ('%s')")
384 raise error.ConfigError(_("%s.%s is not an integer ('%s')")
385 % (section, name, v))
385 % (section, name, v))
386
386
387 def configbytes(self, section, name, default=0, untrusted=False):
387 def configbytes(self, section, name, default=0, untrusted=False):
388 """parse a configuration element as a quantity in bytes
388 """parse a configuration element as a quantity in bytes
389
389
390 Units can be specified as b (bytes), k or kb (kilobytes), m or
390 Units can be specified as b (bytes), k or kb (kilobytes), m or
391 mb (megabytes), g or gb (gigabytes).
391 mb (megabytes), g or gb (gigabytes).
392
392
393 >>> u = ui(); s = 'foo'
393 >>> u = ui(); s = 'foo'
394 >>> u.setconfig(s, 'val1', '42')
394 >>> u.setconfig(s, 'val1', '42')
395 >>> u.configbytes(s, 'val1')
395 >>> u.configbytes(s, 'val1')
396 42
396 42
397 >>> u.setconfig(s, 'val2', '42.5 kb')
397 >>> u.setconfig(s, 'val2', '42.5 kb')
398 >>> u.configbytes(s, 'val2')
398 >>> u.configbytes(s, 'val2')
399 43520
399 43520
400 >>> u.configbytes(s, 'unknown', '7 MB')
400 >>> u.configbytes(s, 'unknown', '7 MB')
401 7340032
401 7340032
402 >>> u.setconfig(s, 'invalid', 'somevalue')
402 >>> u.setconfig(s, 'invalid', 'somevalue')
403 >>> u.configbytes(s, 'invalid')
403 >>> u.configbytes(s, 'invalid')
404 Traceback (most recent call last):
404 Traceback (most recent call last):
405 ...
405 ...
406 ConfigError: foo.invalid is not a byte quantity ('somevalue')
406 ConfigError: foo.invalid is not a byte quantity ('somevalue')
407 """
407 """
408
408
409 value = self.config(section, name)
409 value = self.config(section, name)
410 if value is None:
410 if value is None:
411 if not isinstance(default, str):
411 if not isinstance(default, str):
412 return default
412 return default
413 value = default
413 value = default
414 try:
414 try:
415 return util.sizetoint(value)
415 return util.sizetoint(value)
416 except error.ParseError:
416 except error.ParseError:
417 raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
417 raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
418 % (section, name, value))
418 % (section, name, value))
419
419
420 def configlist(self, section, name, default=None, untrusted=False):
420 def configlist(self, section, name, default=None, untrusted=False):
421 """parse a configuration element as a list of comma/space separated
421 """parse a configuration element as a list of comma/space separated
422 strings
422 strings
423
423
424 >>> u = ui(); s = 'foo'
424 >>> u = ui(); s = 'foo'
425 >>> u.setconfig(s, 'list1', 'this,is "a small" ,test')
425 >>> u.setconfig(s, 'list1', 'this,is "a small" ,test')
426 >>> u.configlist(s, 'list1')
426 >>> u.configlist(s, 'list1')
427 ['this', 'is', 'a small', 'test']
427 ['this', 'is', 'a small', 'test']
428 """
428 """
429
429
430 def _parse_plain(parts, s, offset):
430 def _parse_plain(parts, s, offset):
431 whitespace = False
431 whitespace = False
432 while offset < len(s) and (s[offset].isspace() or s[offset] == ','):
432 while offset < len(s) and (s[offset].isspace() or s[offset] == ','):
433 whitespace = True
433 whitespace = True
434 offset += 1
434 offset += 1
435 if offset >= len(s):
435 if offset >= len(s):
436 return None, parts, offset
436 return None, parts, offset
437 if whitespace:
437 if whitespace:
438 parts.append('')
438 parts.append('')
439 if s[offset] == '"' and not parts[-1]:
439 if s[offset] == '"' and not parts[-1]:
440 return _parse_quote, parts, offset + 1
440 return _parse_quote, parts, offset + 1
441 elif s[offset] == '"' and parts[-1][-1] == '\\':
441 elif s[offset] == '"' and parts[-1][-1] == '\\':
442 parts[-1] = parts[-1][:-1] + s[offset]
442 parts[-1] = parts[-1][:-1] + s[offset]
443 return _parse_plain, parts, offset + 1
443 return _parse_plain, parts, offset + 1
444 parts[-1] += s[offset]
444 parts[-1] += s[offset]
445 return _parse_plain, parts, offset + 1
445 return _parse_plain, parts, offset + 1
446
446
447 def _parse_quote(parts, s, offset):
447 def _parse_quote(parts, s, offset):
448 if offset < len(s) and s[offset] == '"': # ""
448 if offset < len(s) and s[offset] == '"': # ""
449 parts.append('')
449 parts.append('')
450 offset += 1
450 offset += 1
451 while offset < len(s) and (s[offset].isspace() or
451 while offset < len(s) and (s[offset].isspace() or
452 s[offset] == ','):
452 s[offset] == ','):
453 offset += 1
453 offset += 1
454 return _parse_plain, parts, offset
454 return _parse_plain, parts, offset
455
455
456 while offset < len(s) and s[offset] != '"':
456 while offset < len(s) and s[offset] != '"':
457 if (s[offset] == '\\' and offset + 1 < len(s)
457 if (s[offset] == '\\' and offset + 1 < len(s)
458 and s[offset + 1] == '"'):
458 and s[offset + 1] == '"'):
459 offset += 1
459 offset += 1
460 parts[-1] += '"'
460 parts[-1] += '"'
461 else:
461 else:
462 parts[-1] += s[offset]
462 parts[-1] += s[offset]
463 offset += 1
463 offset += 1
464
464
465 if offset >= len(s):
465 if offset >= len(s):
466 real_parts = _configlist(parts[-1])
466 real_parts = _configlist(parts[-1])
467 if not real_parts:
467 if not real_parts:
468 parts[-1] = '"'
468 parts[-1] = '"'
469 else:
469 else:
470 real_parts[0] = '"' + real_parts[0]
470 real_parts[0] = '"' + real_parts[0]
471 parts = parts[:-1]
471 parts = parts[:-1]
472 parts.extend(real_parts)
472 parts.extend(real_parts)
473 return None, parts, offset
473 return None, parts, offset
474
474
475 offset += 1
475 offset += 1
476 while offset < len(s) and s[offset] in [' ', ',']:
476 while offset < len(s) and s[offset] in [' ', ',']:
477 offset += 1
477 offset += 1
478
478
479 if offset < len(s):
479 if offset < len(s):
480 if offset + 1 == len(s) and s[offset] == '"':
480 if offset + 1 == len(s) and s[offset] == '"':
481 parts[-1] += '"'
481 parts[-1] += '"'
482 offset += 1
482 offset += 1
483 else:
483 else:
484 parts.append('')
484 parts.append('')
485 else:
485 else:
486 return None, parts, offset
486 return None, parts, offset
487
487
488 return _parse_plain, parts, offset
488 return _parse_plain, parts, offset
489
489
490 def _configlist(s):
490 def _configlist(s):
491 s = s.rstrip(' ,')
491 s = s.rstrip(' ,')
492 if not s:
492 if not s:
493 return []
493 return []
494 parser, parts, offset = _parse_plain, [''], 0
494 parser, parts, offset = _parse_plain, [''], 0
495 while parser:
495 while parser:
496 parser, parts, offset = parser(parts, s, offset)
496 parser, parts, offset = parser(parts, s, offset)
497 return parts
497 return parts
498
498
499 result = self.config(section, name, untrusted=untrusted)
499 result = self.config(section, name, untrusted=untrusted)
500 if result is None:
500 if result is None:
501 result = default or []
501 result = default or []
502 if isinstance(result, basestring):
502 if isinstance(result, basestring):
503 result = _configlist(result.lstrip(' ,\n'))
503 result = _configlist(result.lstrip(' ,\n'))
504 if result is None:
504 if result is None:
505 result = default or []
505 result = default or []
506 return result
506 return result
507
507
508 def hasconfig(self, section, name, untrusted=False):
508 def hasconfig(self, section, name, untrusted=False):
509 return self._data(untrusted).hasitem(section, name)
509 return self._data(untrusted).hasitem(section, name)
510
510
511 def has_section(self, section, untrusted=False):
511 def has_section(self, section, untrusted=False):
512 '''tell whether section exists in config.'''
512 '''tell whether section exists in config.'''
513 return section in self._data(untrusted)
513 return section in self._data(untrusted)
514
514
515 def configitems(self, section, untrusted=False, ignoresub=False):
515 def configitems(self, section, untrusted=False, ignoresub=False):
516 items = self._data(untrusted).items(section)
516 items = self._data(untrusted).items(section)
517 if ignoresub:
517 if ignoresub:
518 newitems = {}
518 newitems = {}
519 for k, v in items:
519 for k, v in items:
520 if ':' not in k:
520 if ':' not in k:
521 newitems[k] = v
521 newitems[k] = v
522 items = newitems.items()
522 items = newitems.items()
523 if self.debugflag and not untrusted and self._reportuntrusted:
523 if self.debugflag and not untrusted and self._reportuntrusted:
524 for k, v in self._ucfg.items(section):
524 for k, v in self._ucfg.items(section):
525 if self._tcfg.get(section, k) != v:
525 if self._tcfg.get(section, k) != v:
526 self.debug("ignoring untrusted configuration option "
526 self.debug("ignoring untrusted configuration option "
527 "%s.%s = %s\n" % (section, k, v))
527 "%s.%s = %s\n" % (section, k, v))
528 return items
528 return items
529
529
530 def walkconfig(self, untrusted=False):
530 def walkconfig(self, untrusted=False):
531 cfg = self._data(untrusted)
531 cfg = self._data(untrusted)
532 for section in cfg.sections():
532 for section in cfg.sections():
533 for name, value in self.configitems(section, untrusted):
533 for name, value in self.configitems(section, untrusted):
534 yield section, name, value
534 yield section, name, value
535
535
536 def plain(self, feature=None):
536 def plain(self, feature=None):
537 '''is plain mode active?
537 '''is plain mode active?
538
538
539 Plain mode means that all configuration variables which affect
539 Plain mode means that all configuration variables which affect
540 the behavior and output of Mercurial should be
540 the behavior and output of Mercurial should be
541 ignored. Additionally, the output should be stable,
541 ignored. Additionally, the output should be stable,
542 reproducible and suitable for use in scripts or applications.
542 reproducible and suitable for use in scripts or applications.
543
543
544 The only way to trigger plain mode is by setting either the
544 The only way to trigger plain mode is by setting either the
545 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
545 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
546
546
547 The return value can either be
547 The return value can either be
548 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
548 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
549 - True otherwise
549 - True otherwise
550 '''
550 '''
551 if 'HGPLAIN' not in os.environ and 'HGPLAINEXCEPT' not in os.environ:
551 if 'HGPLAIN' not in os.environ and 'HGPLAINEXCEPT' not in os.environ:
552 return False
552 return False
553 exceptions = os.environ.get('HGPLAINEXCEPT', '').strip().split(',')
553 exceptions = os.environ.get('HGPLAINEXCEPT', '').strip().split(',')
554 if feature and exceptions:
554 if feature and exceptions:
555 return feature not in exceptions
555 return feature not in exceptions
556 return True
556 return True
557
557
558 def username(self):
558 def username(self):
559 """Return default username to be used in commits.
559 """Return default username to be used in commits.
560
560
561 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
561 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
562 and stop searching if one of these is set.
562 and stop searching if one of these is set.
563 If not found and ui.askusername is True, ask the user, else use
563 If not found and ui.askusername is True, ask the user, else use
564 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
564 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
565 """
565 """
566 user = os.environ.get("HGUSER")
566 user = os.environ.get("HGUSER")
567 if user is None:
567 if user is None:
568 user = self.config("ui", ["username", "user"])
568 user = self.config("ui", ["username", "user"])
569 if user is not None:
569 if user is not None:
570 user = os.path.expandvars(user)
570 user = os.path.expandvars(user)
571 if user is None:
571 if user is None:
572 user = os.environ.get("EMAIL")
572 user = os.environ.get("EMAIL")
573 if user is None and self.configbool("ui", "askusername"):
573 if user is None and self.configbool("ui", "askusername"):
574 user = self.prompt(_("enter a commit username:"), default=None)
574 user = self.prompt(_("enter a commit username:"), default=None)
575 if user is None and not self.interactive():
575 if user is None and not self.interactive():
576 try:
576 try:
577 user = '%s@%s' % (util.getuser(), socket.getfqdn())
577 user = '%s@%s' % (util.getuser(), socket.getfqdn())
578 self.warn(_("no username found, using '%s' instead\n") % user)
578 self.warn(_("no username found, using '%s' instead\n") % user)
579 except KeyError:
579 except KeyError:
580 pass
580 pass
581 if not user:
581 if not user:
582 raise error.Abort(_('no username supplied'),
582 raise error.Abort(_('no username supplied'),
583 hint=_('use "hg config --edit" '
583 hint=_('use "hg config --edit" '
584 'to set your username'))
584 'to set your username'))
585 if "\n" in user:
585 if "\n" in user:
586 raise error.Abort(_("username %s contains a newline\n")
586 raise error.Abort(_("username %s contains a newline\n")
587 % repr(user))
587 % repr(user))
588 return user
588 return user
589
589
590 def shortuser(self, user):
590 def shortuser(self, user):
591 """Return a short representation of a user name or email address."""
591 """Return a short representation of a user name or email address."""
592 if not self.verbose:
592 if not self.verbose:
593 user = util.shortuser(user)
593 user = util.shortuser(user)
594 return user
594 return user
595
595
596 def expandpath(self, loc, default=None):
596 def expandpath(self, loc, default=None):
597 """Return repository location relative to cwd or from [paths]"""
597 """Return repository location relative to cwd or from [paths]"""
598 try:
598 try:
599 p = self.paths.getpath(loc)
599 p = self.paths.getpath(loc)
600 if p:
600 if p:
601 return p.rawloc
601 return p.rawloc
602 except error.RepoError:
602 except error.RepoError:
603 pass
603 pass
604
604
605 if default:
605 if default:
606 try:
606 try:
607 p = self.paths.getpath(default)
607 p = self.paths.getpath(default)
608 if p:
608 if p:
609 return p.rawloc
609 return p.rawloc
610 except error.RepoError:
610 except error.RepoError:
611 pass
611 pass
612
612
613 return loc
613 return loc
614
614
615 @util.propertycache
615 @util.propertycache
616 def paths(self):
616 def paths(self):
617 return paths(self)
617 return paths(self)
618
618
619 def pushbuffer(self, error=False, subproc=False, labeled=False):
619 def pushbuffer(self, error=False, subproc=False, labeled=False):
620 """install a buffer to capture standard output of the ui object
620 """install a buffer to capture standard output of the ui object
621
621
622 If error is True, the error output will be captured too.
622 If error is True, the error output will be captured too.
623
623
624 If subproc is True, output from subprocesses (typically hooks) will be
624 If subproc is True, output from subprocesses (typically hooks) will be
625 captured too.
625 captured too.
626
626
627 If labeled is True, any labels associated with buffered
627 If labeled is True, any labels associated with buffered
628 output will be handled. By default, this has no effect
628 output will be handled. By default, this has no effect
629 on the output returned, but extensions and GUI tools may
629 on the output returned, but extensions and GUI tools may
630 handle this argument and returned styled output. If output
630 handle this argument and returned styled output. If output
631 is being buffered so it can be captured and parsed or
631 is being buffered so it can be captured and parsed or
632 processed, labeled should not be set to True.
632 processed, labeled should not be set to True.
633 """
633 """
634 self._buffers.append([])
634 self._buffers.append([])
635 self._bufferstates.append((error, subproc, labeled))
635 self._bufferstates.append((error, subproc, labeled))
636 self._bufferapplylabels = labeled
636 self._bufferapplylabels = labeled
637
637
638 def popbuffer(self):
638 def popbuffer(self):
639 '''pop the last buffer and return the buffered output'''
639 '''pop the last buffer and return the buffered output'''
640 self._bufferstates.pop()
640 self._bufferstates.pop()
641 if self._bufferstates:
641 if self._bufferstates:
642 self._bufferapplylabels = self._bufferstates[-1][2]
642 self._bufferapplylabels = self._bufferstates[-1][2]
643 else:
643 else:
644 self._bufferapplylabels = None
644 self._bufferapplylabels = None
645
645
646 return "".join(self._buffers.pop())
646 return "".join(self._buffers.pop())
647
647
648 def write(self, *args, **opts):
648 def write(self, *args, **opts):
649 '''write args to output
649 '''write args to output
650
650
651 By default, this method simply writes to the buffer or stdout,
651 By default, this method simply writes to the buffer or stdout,
652 but extensions or GUI tools may override this method,
652 but extensions or GUI tools may override this method,
653 write_err(), popbuffer(), and label() to style output from
653 write_err(), popbuffer(), and label() to style output from
654 various parts of hg.
654 various parts of hg.
655
655
656 An optional keyword argument, "label", can be passed in.
656 An optional keyword argument, "label", can be passed in.
657 This should be a string containing label names separated by
657 This should be a string containing label names separated by
658 space. Label names take the form of "topic.type". For example,
658 space. Label names take the form of "topic.type". For example,
659 ui.debug() issues a label of "ui.debug".
659 ui.debug() issues a label of "ui.debug".
660
660
661 When labeling output for a specific command, a label of
661 When labeling output for a specific command, a label of
662 "cmdname.type" is recommended. For example, status issues
662 "cmdname.type" is recommended. For example, status issues
663 a label of "status.modified" for modified files.
663 a label of "status.modified" for modified files.
664 '''
664 '''
665 if self._buffers:
665 if self._buffers:
666 self._buffers[-1].extend(a for a in args)
666 self._buffers[-1].extend(a for a in args)
667 else:
667 else:
668 self._progclear()
668 self._progclear()
669 for a in args:
669 for a in args:
670 self.fout.write(a)
670 self.fout.write(a)
671
671
672 def write_err(self, *args, **opts):
672 def write_err(self, *args, **opts):
673 self._progclear()
673 self._progclear()
674 try:
674 try:
675 if self._bufferstates and self._bufferstates[-1][0]:
675 if self._bufferstates and self._bufferstates[-1][0]:
676 return self.write(*args, **opts)
676 return self.write(*args, **opts)
677 if not getattr(self.fout, 'closed', False):
677 if not getattr(self.fout, 'closed', False):
678 self.fout.flush()
678 self.fout.flush()
679 for a in args:
679 for a in args:
680 self.ferr.write(a)
680 self.ferr.write(a)
681 # stderr may be buffered under win32 when redirected to files,
681 # stderr may be buffered under win32 when redirected to files,
682 # including stdout.
682 # including stdout.
683 if not getattr(self.ferr, 'closed', False):
683 if not getattr(self.ferr, 'closed', False):
684 self.ferr.flush()
684 self.ferr.flush()
685 except IOError as inst:
685 except IOError as inst:
686 if inst.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
686 if inst.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
687 raise
687 raise
688
688
689 def flush(self):
689 def flush(self):
690 try: self.fout.flush()
690 try: self.fout.flush()
691 except (IOError, ValueError): pass
691 except (IOError, ValueError): pass
692 try: self.ferr.flush()
692 try: self.ferr.flush()
693 except (IOError, ValueError): pass
693 except (IOError, ValueError): pass
694
694
695 def _isatty(self, fh):
695 def _isatty(self, fh):
696 if self.configbool('ui', 'nontty', False):
696 if self.configbool('ui', 'nontty', False):
697 return False
697 return False
698 return util.isatty(fh)
698 return util.isatty(fh)
699
699
700 def interface(self, feature):
701 """what interface to use for interactive console features?
702
703 The interface is controlled by the value of `ui.interface` but also by
704 the value of feature-specific configuration. For example:
705
706 ui.interface.histedit = text
707 ui.interface.chunkselector = curses
708
709 Here the features are "histedit" and "chunkselector".
710
711 The configuration above means that the default interfaces for commands
712 is curses, the interface for histedit is text and the interface for
713 selecting chunk is crecord (the best curses interface available).
714
715 Consider the following exemple:
716 ui.interface = curses
717 ui.interface.histedit = text
718
719 Then histedit will use the text interface and chunkselector will use
720 the default curses interface (crecord at the moment).
721 """
722 alldefaults = frozenset(["text", "curses"])
723
724 featureinterfaces = {
725 "chunkselector": [
726 "text",
727 "curses",
728 ]
729 }
730
731 # Feature-specific interface
732 if feature not in featureinterfaces.keys():
733 # Programming error, not user error
734 raise ValueError("Unknown feature requested %s" % feature)
735
736 availableinterfaces = frozenset(featureinterfaces[feature])
737 if alldefaults > availableinterfaces:
738 # Programming error, not user error. We need a use case to
739 # define the right thing to do here.
740 raise ValueError(
741 "Feature %s does not handle all default interfaces" %
742 feature)
743
744 if self.plain():
745 return "text"
746
747 # Default interface for all the features
748 defaultinterface = "text"
749 i = self.config("ui", "interface", None)
750 if i in alldefaults:
751 defaultinterface = i
752
753 choseninterface = defaultinterface
754 f = self.config("ui", "interface.%s" % feature, None)
755 if f in availableinterfaces:
756 choseninterface = f
757
758 if i is not None and defaultinterface != i:
759 if f is not None:
760 self.warn(_("invalid value for ui.interface: %s\n") %
761 (i,))
762 else:
763 self.warn(_("invalid value for ui.interface: %s (using %s)\n") %
764 (i, choseninterface))
765 if f is not None and choseninterface != f:
766 self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") %
767 (feature, f, choseninterface))
768
769 return choseninterface
770
700 def interactive(self):
771 def interactive(self):
701 '''is interactive input allowed?
772 '''is interactive input allowed?
702
773
703 An interactive session is a session where input can be reasonably read
774 An interactive session is a session where input can be reasonably read
704 from `sys.stdin'. If this function returns false, any attempt to read
775 from `sys.stdin'. If this function returns false, any attempt to read
705 from stdin should fail with an error, unless a sensible default has been
776 from stdin should fail with an error, unless a sensible default has been
706 specified.
777 specified.
707
778
708 Interactiveness is triggered by the value of the `ui.interactive'
779 Interactiveness is triggered by the value of the `ui.interactive'
709 configuration variable or - if it is unset - when `sys.stdin' points
780 configuration variable or - if it is unset - when `sys.stdin' points
710 to a terminal device.
781 to a terminal device.
711
782
712 This function refers to input only; for output, see `ui.formatted()'.
783 This function refers to input only; for output, see `ui.formatted()'.
713 '''
784 '''
714 i = self.configbool("ui", "interactive", None)
785 i = self.configbool("ui", "interactive", None)
715 if i is None:
786 if i is None:
716 # some environments replace stdin without implementing isatty
787 # some environments replace stdin without implementing isatty
717 # usually those are non-interactive
788 # usually those are non-interactive
718 return self._isatty(self.fin)
789 return self._isatty(self.fin)
719
790
720 return i
791 return i
721
792
722 def termwidth(self):
793 def termwidth(self):
723 '''how wide is the terminal in columns?
794 '''how wide is the terminal in columns?
724 '''
795 '''
725 if 'COLUMNS' in os.environ:
796 if 'COLUMNS' in os.environ:
726 try:
797 try:
727 return int(os.environ['COLUMNS'])
798 return int(os.environ['COLUMNS'])
728 except ValueError:
799 except ValueError:
729 pass
800 pass
730 return util.termwidth()
801 return util.termwidth()
731
802
732 def formatted(self):
803 def formatted(self):
733 '''should formatted output be used?
804 '''should formatted output be used?
734
805
735 It is often desirable to format the output to suite the output medium.
806 It is often desirable to format the output to suite the output medium.
736 Examples of this are truncating long lines or colorizing messages.
807 Examples of this are truncating long lines or colorizing messages.
737 However, this is not often not desirable when piping output into other
808 However, this is not often not desirable when piping output into other
738 utilities, e.g. `grep'.
809 utilities, e.g. `grep'.
739
810
740 Formatted output is triggered by the value of the `ui.formatted'
811 Formatted output is triggered by the value of the `ui.formatted'
741 configuration variable or - if it is unset - when `sys.stdout' points
812 configuration variable or - if it is unset - when `sys.stdout' points
742 to a terminal device. Please note that `ui.formatted' should be
813 to a terminal device. Please note that `ui.formatted' should be
743 considered an implementation detail; it is not intended for use outside
814 considered an implementation detail; it is not intended for use outside
744 Mercurial or its extensions.
815 Mercurial or its extensions.
745
816
746 This function refers to output only; for input, see `ui.interactive()'.
817 This function refers to output only; for input, see `ui.interactive()'.
747 This function always returns false when in plain mode, see `ui.plain()'.
818 This function always returns false when in plain mode, see `ui.plain()'.
748 '''
819 '''
749 if self.plain():
820 if self.plain():
750 return False
821 return False
751
822
752 i = self.configbool("ui", "formatted", None)
823 i = self.configbool("ui", "formatted", None)
753 if i is None:
824 if i is None:
754 # some environments replace stdout without implementing isatty
825 # some environments replace stdout without implementing isatty
755 # usually those are non-interactive
826 # usually those are non-interactive
756 return self._isatty(self.fout)
827 return self._isatty(self.fout)
757
828
758 return i
829 return i
759
830
760 def _readline(self, prompt=''):
831 def _readline(self, prompt=''):
761 if self._isatty(self.fin):
832 if self._isatty(self.fin):
762 try:
833 try:
763 # magically add command line editing support, where
834 # magically add command line editing support, where
764 # available
835 # available
765 import readline
836 import readline
766 # force demandimport to really load the module
837 # force demandimport to really load the module
767 readline.read_history_file
838 readline.read_history_file
768 # windows sometimes raises something other than ImportError
839 # windows sometimes raises something other than ImportError
769 except Exception:
840 except Exception:
770 pass
841 pass
771
842
772 # call write() so output goes through subclassed implementation
843 # call write() so output goes through subclassed implementation
773 # e.g. color extension on Windows
844 # e.g. color extension on Windows
774 self.write(prompt)
845 self.write(prompt)
775
846
776 # instead of trying to emulate raw_input, swap (self.fin,
847 # instead of trying to emulate raw_input, swap (self.fin,
777 # self.fout) with (sys.stdin, sys.stdout)
848 # self.fout) with (sys.stdin, sys.stdout)
778 oldin = sys.stdin
849 oldin = sys.stdin
779 oldout = sys.stdout
850 oldout = sys.stdout
780 sys.stdin = self.fin
851 sys.stdin = self.fin
781 sys.stdout = self.fout
852 sys.stdout = self.fout
782 # prompt ' ' must exist; otherwise readline may delete entire line
853 # prompt ' ' must exist; otherwise readline may delete entire line
783 # - http://bugs.python.org/issue12833
854 # - http://bugs.python.org/issue12833
784 line = raw_input(' ')
855 line = raw_input(' ')
785 sys.stdin = oldin
856 sys.stdin = oldin
786 sys.stdout = oldout
857 sys.stdout = oldout
787
858
788 # When stdin is in binary mode on Windows, it can cause
859 # When stdin is in binary mode on Windows, it can cause
789 # raw_input() to emit an extra trailing carriage return
860 # raw_input() to emit an extra trailing carriage return
790 if os.linesep == '\r\n' and line and line[-1] == '\r':
861 if os.linesep == '\r\n' and line and line[-1] == '\r':
791 line = line[:-1]
862 line = line[:-1]
792 return line
863 return line
793
864
794 def prompt(self, msg, default="y"):
865 def prompt(self, msg, default="y"):
795 """Prompt user with msg, read response.
866 """Prompt user with msg, read response.
796 If ui is not interactive, the default is returned.
867 If ui is not interactive, the default is returned.
797 """
868 """
798 if not self.interactive():
869 if not self.interactive():
799 self.write(msg, ' ', default or '', "\n")
870 self.write(msg, ' ', default or '', "\n")
800 return default
871 return default
801 try:
872 try:
802 r = self._readline(self.label(msg, 'ui.prompt'))
873 r = self._readline(self.label(msg, 'ui.prompt'))
803 if not r:
874 if not r:
804 r = default
875 r = default
805 if self.configbool('ui', 'promptecho'):
876 if self.configbool('ui', 'promptecho'):
806 self.write(r, "\n")
877 self.write(r, "\n")
807 return r
878 return r
808 except EOFError:
879 except EOFError:
809 raise error.ResponseExpected()
880 raise error.ResponseExpected()
810
881
811 @staticmethod
882 @staticmethod
812 def extractchoices(prompt):
883 def extractchoices(prompt):
813 """Extract prompt message and list of choices from specified prompt.
884 """Extract prompt message and list of choices from specified prompt.
814
885
815 This returns tuple "(message, choices)", and "choices" is the
886 This returns tuple "(message, choices)", and "choices" is the
816 list of tuple "(response character, text without &)".
887 list of tuple "(response character, text without &)".
817
888
818 >>> ui.extractchoices("awake? $$ &Yes $$ &No")
889 >>> ui.extractchoices("awake? $$ &Yes $$ &No")
819 ('awake? ', [('y', 'Yes'), ('n', 'No')])
890 ('awake? ', [('y', 'Yes'), ('n', 'No')])
820 >>> ui.extractchoices("line\\nbreak? $$ &Yes $$ &No")
891 >>> ui.extractchoices("line\\nbreak? $$ &Yes $$ &No")
821 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
892 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
822 >>> ui.extractchoices("want lots of $$money$$?$$Ye&s$$N&o")
893 >>> ui.extractchoices("want lots of $$money$$?$$Ye&s$$N&o")
823 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
894 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
824 """
895 """
825
896
826 # Sadly, the prompt string may have been built with a filename
897 # Sadly, the prompt string may have been built with a filename
827 # containing "$$" so let's try to find the first valid-looking
898 # containing "$$" so let's try to find the first valid-looking
828 # prompt to start parsing. Sadly, we also can't rely on
899 # prompt to start parsing. Sadly, we also can't rely on
829 # choices containing spaces, ASCII, or basically anything
900 # choices containing spaces, ASCII, or basically anything
830 # except an ampersand followed by a character.
901 # except an ampersand followed by a character.
831 m = re.match(r'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
902 m = re.match(r'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
832 msg = m.group(1)
903 msg = m.group(1)
833 choices = [p.strip(' ') for p in m.group(2).split('$$')]
904 choices = [p.strip(' ') for p in m.group(2).split('$$')]
834 return (msg,
905 return (msg,
835 [(s[s.index('&') + 1].lower(), s.replace('&', '', 1))
906 [(s[s.index('&') + 1].lower(), s.replace('&', '', 1))
836 for s in choices])
907 for s in choices])
837
908
838 def promptchoice(self, prompt, default=0):
909 def promptchoice(self, prompt, default=0):
839 """Prompt user with a message, read response, and ensure it matches
910 """Prompt user with a message, read response, and ensure it matches
840 one of the provided choices. The prompt is formatted as follows:
911 one of the provided choices. The prompt is formatted as follows:
841
912
842 "would you like fries with that (Yn)? $$ &Yes $$ &No"
913 "would you like fries with that (Yn)? $$ &Yes $$ &No"
843
914
844 The index of the choice is returned. Responses are case
915 The index of the choice is returned. Responses are case
845 insensitive. If ui is not interactive, the default is
916 insensitive. If ui is not interactive, the default is
846 returned.
917 returned.
847 """
918 """
848
919
849 msg, choices = self.extractchoices(prompt)
920 msg, choices = self.extractchoices(prompt)
850 resps = [r for r, t in choices]
921 resps = [r for r, t in choices]
851 while True:
922 while True:
852 r = self.prompt(msg, resps[default])
923 r = self.prompt(msg, resps[default])
853 if r.lower() in resps:
924 if r.lower() in resps:
854 return resps.index(r.lower())
925 return resps.index(r.lower())
855 self.write(_("unrecognized response\n"))
926 self.write(_("unrecognized response\n"))
856
927
857 def getpass(self, prompt=None, default=None):
928 def getpass(self, prompt=None, default=None):
858 if not self.interactive():
929 if not self.interactive():
859 return default
930 return default
860 try:
931 try:
861 self.write_err(self.label(prompt or _('password: '), 'ui.prompt'))
932 self.write_err(self.label(prompt or _('password: '), 'ui.prompt'))
862 # disable getpass() only if explicitly specified. it's still valid
933 # disable getpass() only if explicitly specified. it's still valid
863 # to interact with tty even if fin is not a tty.
934 # to interact with tty even if fin is not a tty.
864 if self.configbool('ui', 'nontty'):
935 if self.configbool('ui', 'nontty'):
865 return self.fin.readline().rstrip('\n')
936 return self.fin.readline().rstrip('\n')
866 else:
937 else:
867 return getpass.getpass('')
938 return getpass.getpass('')
868 except EOFError:
939 except EOFError:
869 raise error.ResponseExpected()
940 raise error.ResponseExpected()
870 def status(self, *msg, **opts):
941 def status(self, *msg, **opts):
871 '''write status message to output (if ui.quiet is False)
942 '''write status message to output (if ui.quiet is False)
872
943
873 This adds an output label of "ui.status".
944 This adds an output label of "ui.status".
874 '''
945 '''
875 if not self.quiet:
946 if not self.quiet:
876 opts['label'] = opts.get('label', '') + ' ui.status'
947 opts['label'] = opts.get('label', '') + ' ui.status'
877 self.write(*msg, **opts)
948 self.write(*msg, **opts)
878 def warn(self, *msg, **opts):
949 def warn(self, *msg, **opts):
879 '''write warning message to output (stderr)
950 '''write warning message to output (stderr)
880
951
881 This adds an output label of "ui.warning".
952 This adds an output label of "ui.warning".
882 '''
953 '''
883 opts['label'] = opts.get('label', '') + ' ui.warning'
954 opts['label'] = opts.get('label', '') + ' ui.warning'
884 self.write_err(*msg, **opts)
955 self.write_err(*msg, **opts)
885 def note(self, *msg, **opts):
956 def note(self, *msg, **opts):
886 '''write note to output (if ui.verbose is True)
957 '''write note to output (if ui.verbose is True)
887
958
888 This adds an output label of "ui.note".
959 This adds an output label of "ui.note".
889 '''
960 '''
890 if self.verbose:
961 if self.verbose:
891 opts['label'] = opts.get('label', '') + ' ui.note'
962 opts['label'] = opts.get('label', '') + ' ui.note'
892 self.write(*msg, **opts)
963 self.write(*msg, **opts)
893 def debug(self, *msg, **opts):
964 def debug(self, *msg, **opts):
894 '''write debug message to output (if ui.debugflag is True)
965 '''write debug message to output (if ui.debugflag is True)
895
966
896 This adds an output label of "ui.debug".
967 This adds an output label of "ui.debug".
897 '''
968 '''
898 if self.debugflag:
969 if self.debugflag:
899 opts['label'] = opts.get('label', '') + ' ui.debug'
970 opts['label'] = opts.get('label', '') + ' ui.debug'
900 self.write(*msg, **opts)
971 self.write(*msg, **opts)
901
972
902 def edit(self, text, user, extra=None, editform=None, pending=None):
973 def edit(self, text, user, extra=None, editform=None, pending=None):
903 extra_defaults = { 'prefix': 'editor' }
974 extra_defaults = { 'prefix': 'editor' }
904 if extra is not None:
975 if extra is not None:
905 extra_defaults.update(extra)
976 extra_defaults.update(extra)
906 extra = extra_defaults
977 extra = extra_defaults
907 (fd, name) = tempfile.mkstemp(prefix='hg-' + extra['prefix'] + '-',
978 (fd, name) = tempfile.mkstemp(prefix='hg-' + extra['prefix'] + '-',
908 suffix=".txt", text=True)
979 suffix=".txt", text=True)
909 try:
980 try:
910 f = os.fdopen(fd, "w")
981 f = os.fdopen(fd, "w")
911 f.write(text)
982 f.write(text)
912 f.close()
983 f.close()
913
984
914 environ = {'HGUSER': user}
985 environ = {'HGUSER': user}
915 if 'transplant_source' in extra:
986 if 'transplant_source' in extra:
916 environ.update({'HGREVISION': hex(extra['transplant_source'])})
987 environ.update({'HGREVISION': hex(extra['transplant_source'])})
917 for label in ('intermediate-source', 'source', 'rebase_source'):
988 for label in ('intermediate-source', 'source', 'rebase_source'):
918 if label in extra:
989 if label in extra:
919 environ.update({'HGREVISION': extra[label]})
990 environ.update({'HGREVISION': extra[label]})
920 break
991 break
921 if editform:
992 if editform:
922 environ.update({'HGEDITFORM': editform})
993 environ.update({'HGEDITFORM': editform})
923 if pending:
994 if pending:
924 environ.update({'HG_PENDING': pending})
995 environ.update({'HG_PENDING': pending})
925
996
926 editor = self.geteditor()
997 editor = self.geteditor()
927
998
928 self.system("%s \"%s\"" % (editor, name),
999 self.system("%s \"%s\"" % (editor, name),
929 environ=environ,
1000 environ=environ,
930 onerr=error.Abort, errprefix=_("edit failed"))
1001 onerr=error.Abort, errprefix=_("edit failed"))
931
1002
932 f = open(name)
1003 f = open(name)
933 t = f.read()
1004 t = f.read()
934 f.close()
1005 f.close()
935 finally:
1006 finally:
936 os.unlink(name)
1007 os.unlink(name)
937
1008
938 return t
1009 return t
939
1010
940 def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None):
1011 def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None):
941 '''execute shell command with appropriate output stream. command
1012 '''execute shell command with appropriate output stream. command
942 output will be redirected if fout is not stdout.
1013 output will be redirected if fout is not stdout.
943 '''
1014 '''
944 out = self.fout
1015 out = self.fout
945 if any(s[1] for s in self._bufferstates):
1016 if any(s[1] for s in self._bufferstates):
946 out = self
1017 out = self
947 return util.system(cmd, environ=environ, cwd=cwd, onerr=onerr,
1018 return util.system(cmd, environ=environ, cwd=cwd, onerr=onerr,
948 errprefix=errprefix, out=out)
1019 errprefix=errprefix, out=out)
949
1020
950 def traceback(self, exc=None, force=False):
1021 def traceback(self, exc=None, force=False):
951 '''print exception traceback if traceback printing enabled or forced.
1022 '''print exception traceback if traceback printing enabled or forced.
952 only to call in exception handler. returns true if traceback
1023 only to call in exception handler. returns true if traceback
953 printed.'''
1024 printed.'''
954 if self.tracebackflag or force:
1025 if self.tracebackflag or force:
955 if exc is None:
1026 if exc is None:
956 exc = sys.exc_info()
1027 exc = sys.exc_info()
957 cause = getattr(exc[1], 'cause', None)
1028 cause = getattr(exc[1], 'cause', None)
958
1029
959 if cause is not None:
1030 if cause is not None:
960 causetb = traceback.format_tb(cause[2])
1031 causetb = traceback.format_tb(cause[2])
961 exctb = traceback.format_tb(exc[2])
1032 exctb = traceback.format_tb(exc[2])
962 exconly = traceback.format_exception_only(cause[0], cause[1])
1033 exconly = traceback.format_exception_only(cause[0], cause[1])
963
1034
964 # exclude frame where 'exc' was chained and rethrown from exctb
1035 # exclude frame where 'exc' was chained and rethrown from exctb
965 self.write_err('Traceback (most recent call last):\n',
1036 self.write_err('Traceback (most recent call last):\n',
966 ''.join(exctb[:-1]),
1037 ''.join(exctb[:-1]),
967 ''.join(causetb),
1038 ''.join(causetb),
968 ''.join(exconly))
1039 ''.join(exconly))
969 else:
1040 else:
970 output = traceback.format_exception(exc[0], exc[1], exc[2])
1041 output = traceback.format_exception(exc[0], exc[1], exc[2])
971 self.write_err(''.join(output))
1042 self.write_err(''.join(output))
972 return self.tracebackflag or force
1043 return self.tracebackflag or force
973
1044
974 def geteditor(self):
1045 def geteditor(self):
975 '''return editor to use'''
1046 '''return editor to use'''
976 if sys.platform == 'plan9':
1047 if sys.platform == 'plan9':
977 # vi is the MIPS instruction simulator on Plan 9. We
1048 # vi is the MIPS instruction simulator on Plan 9. We
978 # instead default to E to plumb commit messages to
1049 # instead default to E to plumb commit messages to
979 # avoid confusion.
1050 # avoid confusion.
980 editor = 'E'
1051 editor = 'E'
981 else:
1052 else:
982 editor = 'vi'
1053 editor = 'vi'
983 return (os.environ.get("HGEDITOR") or
1054 return (os.environ.get("HGEDITOR") or
984 self.config("ui", "editor") or
1055 self.config("ui", "editor") or
985 os.environ.get("VISUAL") or
1056 os.environ.get("VISUAL") or
986 os.environ.get("EDITOR", editor))
1057 os.environ.get("EDITOR", editor))
987
1058
988 @util.propertycache
1059 @util.propertycache
989 def _progbar(self):
1060 def _progbar(self):
990 """setup the progbar singleton to the ui object"""
1061 """setup the progbar singleton to the ui object"""
991 if (self.quiet or self.debugflag
1062 if (self.quiet or self.debugflag
992 or self.configbool('progress', 'disable', False)
1063 or self.configbool('progress', 'disable', False)
993 or not progress.shouldprint(self)):
1064 or not progress.shouldprint(self)):
994 return None
1065 return None
995 return getprogbar(self)
1066 return getprogbar(self)
996
1067
997 def _progclear(self):
1068 def _progclear(self):
998 """clear progress bar output if any. use it before any output"""
1069 """clear progress bar output if any. use it before any output"""
999 if '_progbar' not in vars(self): # nothing loaded yet
1070 if '_progbar' not in vars(self): # nothing loaded yet
1000 return
1071 return
1001 if self._progbar is not None and self._progbar.printed:
1072 if self._progbar is not None and self._progbar.printed:
1002 self._progbar.clear()
1073 self._progbar.clear()
1003
1074
1004 def progress(self, topic, pos, item="", unit="", total=None):
1075 def progress(self, topic, pos, item="", unit="", total=None):
1005 '''show a progress message
1076 '''show a progress message
1006
1077
1007 With stock hg, this is simply a debug message that is hidden
1078 With stock hg, this is simply a debug message that is hidden
1008 by default, but with extensions or GUI tools it may be
1079 by default, but with extensions or GUI tools it may be
1009 visible. 'topic' is the current operation, 'item' is a
1080 visible. 'topic' is the current operation, 'item' is a
1010 non-numeric marker of the current position (i.e. the currently
1081 non-numeric marker of the current position (i.e. the currently
1011 in-process file), 'pos' is the current numeric position (i.e.
1082 in-process file), 'pos' is the current numeric position (i.e.
1012 revision, bytes, etc.), unit is a corresponding unit label,
1083 revision, bytes, etc.), unit is a corresponding unit label,
1013 and total is the highest expected pos.
1084 and total is the highest expected pos.
1014
1085
1015 Multiple nested topics may be active at a time.
1086 Multiple nested topics may be active at a time.
1016
1087
1017 All topics should be marked closed by setting pos to None at
1088 All topics should be marked closed by setting pos to None at
1018 termination.
1089 termination.
1019 '''
1090 '''
1020 if self._progbar is not None:
1091 if self._progbar is not None:
1021 self._progbar.progress(topic, pos, item=item, unit=unit,
1092 self._progbar.progress(topic, pos, item=item, unit=unit,
1022 total=total)
1093 total=total)
1023 if pos is None or not self.configbool('progress', 'debug'):
1094 if pos is None or not self.configbool('progress', 'debug'):
1024 return
1095 return
1025
1096
1026 if unit:
1097 if unit:
1027 unit = ' ' + unit
1098 unit = ' ' + unit
1028 if item:
1099 if item:
1029 item = ' ' + item
1100 item = ' ' + item
1030
1101
1031 if total:
1102 if total:
1032 pct = 100.0 * pos / total
1103 pct = 100.0 * pos / total
1033 self.debug('%s:%s %s/%s%s (%4.2f%%)\n'
1104 self.debug('%s:%s %s/%s%s (%4.2f%%)\n'
1034 % (topic, item, pos, total, unit, pct))
1105 % (topic, item, pos, total, unit, pct))
1035 else:
1106 else:
1036 self.debug('%s:%s %s%s\n' % (topic, item, pos, unit))
1107 self.debug('%s:%s %s%s\n' % (topic, item, pos, unit))
1037
1108
1038 def log(self, service, *msg, **opts):
1109 def log(self, service, *msg, **opts):
1039 '''hook for logging facility extensions
1110 '''hook for logging facility extensions
1040
1111
1041 service should be a readily-identifiable subsystem, which will
1112 service should be a readily-identifiable subsystem, which will
1042 allow filtering.
1113 allow filtering.
1043
1114
1044 *msg should be a newline-terminated format string to log, and
1115 *msg should be a newline-terminated format string to log, and
1045 then any values to %-format into that format string.
1116 then any values to %-format into that format string.
1046
1117
1047 **opts currently has no defined meanings.
1118 **opts currently has no defined meanings.
1048 '''
1119 '''
1049
1120
1050 def label(self, msg, label):
1121 def label(self, msg, label):
1051 '''style msg based on supplied label
1122 '''style msg based on supplied label
1052
1123
1053 Like ui.write(), this just returns msg unchanged, but extensions
1124 Like ui.write(), this just returns msg unchanged, but extensions
1054 and GUI tools can override it to allow styling output without
1125 and GUI tools can override it to allow styling output without
1055 writing it.
1126 writing it.
1056
1127
1057 ui.write(s, 'label') is equivalent to
1128 ui.write(s, 'label') is equivalent to
1058 ui.write(ui.label(s, 'label')).
1129 ui.write(ui.label(s, 'label')).
1059 '''
1130 '''
1060 return msg
1131 return msg
1061
1132
1062 def develwarn(self, msg, stacklevel=1):
1133 def develwarn(self, msg, stacklevel=1):
1063 """issue a developer warning message
1134 """issue a developer warning message
1064
1135
1065 Use 'stacklevel' to report the offender some layers further up in the
1136 Use 'stacklevel' to report the offender some layers further up in the
1066 stack.
1137 stack.
1067 """
1138 """
1068 msg = 'devel-warn: ' + msg
1139 msg = 'devel-warn: ' + msg
1069 stacklevel += 1 # get in develwarn
1140 stacklevel += 1 # get in develwarn
1070 if self.tracebackflag:
1141 if self.tracebackflag:
1071 util.debugstacktrace(msg, stacklevel, self.ferr, self.fout)
1142 util.debugstacktrace(msg, stacklevel, self.ferr, self.fout)
1072 self.log('develwarn', '%s at:\n%s' %
1143 self.log('develwarn', '%s at:\n%s' %
1073 (msg, ''.join(util.getstackframes(stacklevel))))
1144 (msg, ''.join(util.getstackframes(stacklevel))))
1074 else:
1145 else:
1075 curframe = inspect.currentframe()
1146 curframe = inspect.currentframe()
1076 calframe = inspect.getouterframes(curframe, 2)
1147 calframe = inspect.getouterframes(curframe, 2)
1077 self.write_err('%s at: %s:%s (%s)\n'
1148 self.write_err('%s at: %s:%s (%s)\n'
1078 % ((msg,) + calframe[stacklevel][1:4]))
1149 % ((msg,) + calframe[stacklevel][1:4]))
1079 self.log('develwarn', '%s at: %s:%s (%s)\n',
1150 self.log('develwarn', '%s at: %s:%s (%s)\n',
1080 msg, *calframe[stacklevel][1:4])
1151 msg, *calframe[stacklevel][1:4])
1081
1152
1082 def deprecwarn(self, msg, version):
1153 def deprecwarn(self, msg, version):
1083 """issue a deprecation warning
1154 """issue a deprecation warning
1084
1155
1085 - msg: message explaining what is deprecated and how to upgrade,
1156 - msg: message explaining what is deprecated and how to upgrade,
1086 - version: last version where the API will be supported,
1157 - version: last version where the API will be supported,
1087 """
1158 """
1088 msg += ("\n(compatibility will be dropped after Mercurial-%s,"
1159 msg += ("\n(compatibility will be dropped after Mercurial-%s,"
1089 " update your code.)") % version
1160 " update your code.)") % version
1090 self.develwarn(msg, stacklevel=2)
1161 self.develwarn(msg, stacklevel=2)
1091
1162
1092 class paths(dict):
1163 class paths(dict):
1093 """Represents a collection of paths and their configs.
1164 """Represents a collection of paths and their configs.
1094
1165
1095 Data is initially derived from ui instances and the config files they have
1166 Data is initially derived from ui instances and the config files they have
1096 loaded.
1167 loaded.
1097 """
1168 """
1098 def __init__(self, ui):
1169 def __init__(self, ui):
1099 dict.__init__(self)
1170 dict.__init__(self)
1100
1171
1101 for name, loc in ui.configitems('paths', ignoresub=True):
1172 for name, loc in ui.configitems('paths', ignoresub=True):
1102 # No location is the same as not existing.
1173 # No location is the same as not existing.
1103 if not loc:
1174 if not loc:
1104 continue
1175 continue
1105 loc, sub = ui.configsuboptions('paths', name)
1176 loc, sub = ui.configsuboptions('paths', name)
1106 self[name] = path(ui, name, rawloc=loc, suboptions=sub)
1177 self[name] = path(ui, name, rawloc=loc, suboptions=sub)
1107
1178
1108 def getpath(self, name, default=None):
1179 def getpath(self, name, default=None):
1109 """Return a ``path`` from a string, falling back to default.
1180 """Return a ``path`` from a string, falling back to default.
1110
1181
1111 ``name`` can be a named path or locations. Locations are filesystem
1182 ``name`` can be a named path or locations. Locations are filesystem
1112 paths or URIs.
1183 paths or URIs.
1113
1184
1114 Returns None if ``name`` is not a registered path, a URI, or a local
1185 Returns None if ``name`` is not a registered path, a URI, or a local
1115 path to a repo.
1186 path to a repo.
1116 """
1187 """
1117 # Only fall back to default if no path was requested.
1188 # Only fall back to default if no path was requested.
1118 if name is None:
1189 if name is None:
1119 if not default:
1190 if not default:
1120 default = ()
1191 default = ()
1121 elif not isinstance(default, (tuple, list)):
1192 elif not isinstance(default, (tuple, list)):
1122 default = (default,)
1193 default = (default,)
1123 for k in default:
1194 for k in default:
1124 try:
1195 try:
1125 return self[k]
1196 return self[k]
1126 except KeyError:
1197 except KeyError:
1127 continue
1198 continue
1128 return None
1199 return None
1129
1200
1130 # Most likely empty string.
1201 # Most likely empty string.
1131 # This may need to raise in the future.
1202 # This may need to raise in the future.
1132 if not name:
1203 if not name:
1133 return None
1204 return None
1134
1205
1135 try:
1206 try:
1136 return self[name]
1207 return self[name]
1137 except KeyError:
1208 except KeyError:
1138 # Try to resolve as a local path or URI.
1209 # Try to resolve as a local path or URI.
1139 try:
1210 try:
1140 # We don't pass sub-options in, so no need to pass ui instance.
1211 # We don't pass sub-options in, so no need to pass ui instance.
1141 return path(None, None, rawloc=name)
1212 return path(None, None, rawloc=name)
1142 except ValueError:
1213 except ValueError:
1143 raise error.RepoError(_('repository %s does not exist') %
1214 raise error.RepoError(_('repository %s does not exist') %
1144 name)
1215 name)
1145
1216
1146 _pathsuboptions = {}
1217 _pathsuboptions = {}
1147
1218
1148 def pathsuboption(option, attr):
1219 def pathsuboption(option, attr):
1149 """Decorator used to declare a path sub-option.
1220 """Decorator used to declare a path sub-option.
1150
1221
1151 Arguments are the sub-option name and the attribute it should set on
1222 Arguments are the sub-option name and the attribute it should set on
1152 ``path`` instances.
1223 ``path`` instances.
1153
1224
1154 The decorated function will receive as arguments a ``ui`` instance,
1225 The decorated function will receive as arguments a ``ui`` instance,
1155 ``path`` instance, and the string value of this option from the config.
1226 ``path`` instance, and the string value of this option from the config.
1156 The function should return the value that will be set on the ``path``
1227 The function should return the value that will be set on the ``path``
1157 instance.
1228 instance.
1158
1229
1159 This decorator can be used to perform additional verification of
1230 This decorator can be used to perform additional verification of
1160 sub-options and to change the type of sub-options.
1231 sub-options and to change the type of sub-options.
1161 """
1232 """
1162 def register(func):
1233 def register(func):
1163 _pathsuboptions[option] = (attr, func)
1234 _pathsuboptions[option] = (attr, func)
1164 return func
1235 return func
1165 return register
1236 return register
1166
1237
1167 @pathsuboption('pushurl', 'pushloc')
1238 @pathsuboption('pushurl', 'pushloc')
1168 def pushurlpathoption(ui, path, value):
1239 def pushurlpathoption(ui, path, value):
1169 u = util.url(value)
1240 u = util.url(value)
1170 # Actually require a URL.
1241 # Actually require a URL.
1171 if not u.scheme:
1242 if not u.scheme:
1172 ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
1243 ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
1173 return None
1244 return None
1174
1245
1175 # Don't support the #foo syntax in the push URL to declare branch to
1246 # Don't support the #foo syntax in the push URL to declare branch to
1176 # push.
1247 # push.
1177 if u.fragment:
1248 if u.fragment:
1178 ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
1249 ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
1179 'ignoring)\n') % path.name)
1250 'ignoring)\n') % path.name)
1180 u.fragment = None
1251 u.fragment = None
1181
1252
1182 return str(u)
1253 return str(u)
1183
1254
1184 class path(object):
1255 class path(object):
1185 """Represents an individual path and its configuration."""
1256 """Represents an individual path and its configuration."""
1186
1257
1187 def __init__(self, ui, name, rawloc=None, suboptions=None):
1258 def __init__(self, ui, name, rawloc=None, suboptions=None):
1188 """Construct a path from its config options.
1259 """Construct a path from its config options.
1189
1260
1190 ``ui`` is the ``ui`` instance the path is coming from.
1261 ``ui`` is the ``ui`` instance the path is coming from.
1191 ``name`` is the symbolic name of the path.
1262 ``name`` is the symbolic name of the path.
1192 ``rawloc`` is the raw location, as defined in the config.
1263 ``rawloc`` is the raw location, as defined in the config.
1193 ``pushloc`` is the raw locations pushes should be made to.
1264 ``pushloc`` is the raw locations pushes should be made to.
1194
1265
1195 If ``name`` is not defined, we require that the location be a) a local
1266 If ``name`` is not defined, we require that the location be a) a local
1196 filesystem path with a .hg directory or b) a URL. If not,
1267 filesystem path with a .hg directory or b) a URL. If not,
1197 ``ValueError`` is raised.
1268 ``ValueError`` is raised.
1198 """
1269 """
1199 if not rawloc:
1270 if not rawloc:
1200 raise ValueError('rawloc must be defined')
1271 raise ValueError('rawloc must be defined')
1201
1272
1202 # Locations may define branches via syntax <base>#<branch>.
1273 # Locations may define branches via syntax <base>#<branch>.
1203 u = util.url(rawloc)
1274 u = util.url(rawloc)
1204 branch = None
1275 branch = None
1205 if u.fragment:
1276 if u.fragment:
1206 branch = u.fragment
1277 branch = u.fragment
1207 u.fragment = None
1278 u.fragment = None
1208
1279
1209 self.url = u
1280 self.url = u
1210 self.branch = branch
1281 self.branch = branch
1211
1282
1212 self.name = name
1283 self.name = name
1213 self.rawloc = rawloc
1284 self.rawloc = rawloc
1214 self.loc = str(u)
1285 self.loc = str(u)
1215
1286
1216 # When given a raw location but not a symbolic name, validate the
1287 # When given a raw location but not a symbolic name, validate the
1217 # location is valid.
1288 # location is valid.
1218 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
1289 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
1219 raise ValueError('location is not a URL or path to a local '
1290 raise ValueError('location is not a URL or path to a local '
1220 'repo: %s' % rawloc)
1291 'repo: %s' % rawloc)
1221
1292
1222 suboptions = suboptions or {}
1293 suboptions = suboptions or {}
1223
1294
1224 # Now process the sub-options. If a sub-option is registered, its
1295 # Now process the sub-options. If a sub-option is registered, its
1225 # attribute will always be present. The value will be None if there
1296 # attribute will always be present. The value will be None if there
1226 # was no valid sub-option.
1297 # was no valid sub-option.
1227 for suboption, (attr, func) in _pathsuboptions.iteritems():
1298 for suboption, (attr, func) in _pathsuboptions.iteritems():
1228 if suboption not in suboptions:
1299 if suboption not in suboptions:
1229 setattr(self, attr, None)
1300 setattr(self, attr, None)
1230 continue
1301 continue
1231
1302
1232 value = func(ui, self, suboptions[suboption])
1303 value = func(ui, self, suboptions[suboption])
1233 setattr(self, attr, value)
1304 setattr(self, attr, value)
1234
1305
1235 def _isvalidlocalpath(self, path):
1306 def _isvalidlocalpath(self, path):
1236 """Returns True if the given path is a potentially valid repository.
1307 """Returns True if the given path is a potentially valid repository.
1237 This is its own function so that extensions can change the definition of
1308 This is its own function so that extensions can change the definition of
1238 'valid' in this case (like when pulling from a git repo into a hg
1309 'valid' in this case (like when pulling from a git repo into a hg
1239 one)."""
1310 one)."""
1240 return os.path.isdir(os.path.join(path, '.hg'))
1311 return os.path.isdir(os.path.join(path, '.hg'))
1241
1312
1242 @property
1313 @property
1243 def suboptions(self):
1314 def suboptions(self):
1244 """Return sub-options and their values for this path.
1315 """Return sub-options and their values for this path.
1245
1316
1246 This is intended to be used for presentation purposes.
1317 This is intended to be used for presentation purposes.
1247 """
1318 """
1248 d = {}
1319 d = {}
1249 for subopt, (attr, _func) in _pathsuboptions.iteritems():
1320 for subopt, (attr, _func) in _pathsuboptions.iteritems():
1250 value = getattr(self, attr)
1321 value = getattr(self, attr)
1251 if value is not None:
1322 if value is not None:
1252 d[subopt] = value
1323 d[subopt] = value
1253 return d
1324 return d
1254
1325
1255 # we instantiate one globally shared progress bar to avoid
1326 # we instantiate one globally shared progress bar to avoid
1256 # competing progress bars when multiple UI objects get created
1327 # competing progress bars when multiple UI objects get created
1257 _progresssingleton = None
1328 _progresssingleton = None
1258
1329
1259 def getprogbar(ui):
1330 def getprogbar(ui):
1260 global _progresssingleton
1331 global _progresssingleton
1261 if _progresssingleton is None:
1332 if _progresssingleton is None:
1262 # passing 'ui' object to the singleton is fishy,
1333 # passing 'ui' object to the singleton is fishy,
1263 # this is how the extension used to work but feel free to rework it.
1334 # this is how the extension used to work but feel free to rework it.
1264 _progresssingleton = progress.progbar(ui)
1335 _progresssingleton = progress.progbar(ui)
1265 return _progresssingleton
1336 return _progresssingleton
@@ -1,225 +1,313 b''
1 Set up a repo
1 Set up a repo
2
2
3 $ cp $HGRCPATH $HGRCPATH.pretest
3 $ cat <<EOF >> $HGRCPATH
4 $ cat <<EOF >> $HGRCPATH
4 > [ui]
5 > [ui]
5 > interactive = true
6 > interactive = true
6 > [experimental]
7 > [experimental]
7 > crecord = true
8 > crecord = true
8 > crecordtest = testModeCommands
9 > crecordtest = testModeCommands
9 > EOF
10 > EOF
10
11
11 $ hg init a
12 $ hg init a
12 $ cd a
13 $ cd a
13
14
14 Committing some changes but stopping on the way
15 Committing some changes but stopping on the way
15
16
16 $ echo "a" > a
17 $ echo "a" > a
17 $ hg add a
18 $ hg add a
18 $ cat <<EOF >testModeCommands
19 $ cat <<EOF >testModeCommands
19 > TOGGLE
20 > TOGGLE
20 > X
21 > X
21 > EOF
22 > EOF
22 $ hg commit -i -m "a" -d "0 0"
23 $ hg commit -i -m "a" -d "0 0"
23 no changes to record
24 no changes to record
24 $ hg tip
25 $ hg tip
25 changeset: -1:000000000000
26 changeset: -1:000000000000
26 tag: tip
27 tag: tip
27 user:
28 user:
28 date: Thu Jan 01 00:00:00 1970 +0000
29 date: Thu Jan 01 00:00:00 1970 +0000
29
30
30
31
31 Committing some changes
32 Committing some changes
32
33
33 $ cat <<EOF >testModeCommands
34 $ cat <<EOF >testModeCommands
34 > X
35 > X
35 > EOF
36 > EOF
36 $ hg commit -i -m "a" -d "0 0"
37 $ hg commit -i -m "a" -d "0 0"
37 $ hg tip
38 $ hg tip
38 changeset: 0:cb9a9f314b8b
39 changeset: 0:cb9a9f314b8b
39 tag: tip
40 tag: tip
40 user: test
41 user: test
41 date: Thu Jan 01 00:00:00 1970 +0000
42 date: Thu Jan 01 00:00:00 1970 +0000
42 summary: a
43 summary: a
43
44
44 Check that commit -i works with no changes
45 Check that commit -i works with no changes
45 $ hg commit -i
46 $ hg commit -i
46 no changes to record
47 no changes to record
47
48
48 Committing only one file
49 Committing only one file
49
50
50 $ echo "a" >> a
51 $ echo "a" >> a
51 >>> open('b', 'wb').write("1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n")
52 >>> open('b', 'wb').write("1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n")
52 $ hg add b
53 $ hg add b
53 $ cat <<EOF >testModeCommands
54 $ cat <<EOF >testModeCommands
54 > TOGGLE
55 > TOGGLE
55 > KEY_DOWN
56 > KEY_DOWN
56 > X
57 > X
57 > EOF
58 > EOF
58 $ hg commit -i -m "one file" -d "0 0"
59 $ hg commit -i -m "one file" -d "0 0"
59 $ hg tip
60 $ hg tip
60 changeset: 1:fb2705a663ea
61 changeset: 1:fb2705a663ea
61 tag: tip
62 tag: tip
62 user: test
63 user: test
63 date: Thu Jan 01 00:00:00 1970 +0000
64 date: Thu Jan 01 00:00:00 1970 +0000
64 summary: one file
65 summary: one file
65
66
66 $ hg cat -r tip a
67 $ hg cat -r tip a
67 a
68 a
68 $ cat a
69 $ cat a
69 a
70 a
70 a
71 a
71
72
72 Committing only one hunk while aborting edition of hunk
73 Committing only one hunk while aborting edition of hunk
73
74
74 - Untoggle all the hunks, go down to the second file
75 - Untoggle all the hunks, go down to the second file
75 - unfold it
76 - unfold it
76 - go down to second hunk (1 for the first hunk, 1 for the first hunkline, 1 for the second hunk, 1 for the second hunklike)
77 - go down to second hunk (1 for the first hunk, 1 for the first hunkline, 1 for the second hunk, 1 for the second hunklike)
77 - toggle the second hunk
78 - toggle the second hunk
78 - toggle on and off the amend mode (to check that it toggles off)
79 - toggle on and off the amend mode (to check that it toggles off)
79 - edit the hunk and quit the editor immediately with non-zero status
80 - edit the hunk and quit the editor immediately with non-zero status
80 - commit
81 - commit
81
82
82 $ printf "printf 'editor ran\n'; exit 1" > editor.sh
83 $ printf "printf 'editor ran\n'; exit 1" > editor.sh
83 $ echo "x" > c
84 $ echo "x" > c
84 $ cat b >> c
85 $ cat b >> c
85 $ echo "y" >> c
86 $ echo "y" >> c
86 $ mv c b
87 $ mv c b
87 $ cat <<EOF >testModeCommands
88 $ cat <<EOF >testModeCommands
88 > A
89 > A
89 > KEY_DOWN
90 > KEY_DOWN
90 > f
91 > f
91 > KEY_DOWN
92 > KEY_DOWN
92 > KEY_DOWN
93 > KEY_DOWN
93 > KEY_DOWN
94 > KEY_DOWN
94 > KEY_DOWN
95 > KEY_DOWN
95 > TOGGLE
96 > TOGGLE
96 > a
97 > a
97 > a
98 > a
98 > e
99 > e
99 > X
100 > X
100 > EOF
101 > EOF
101 $ HGEDITOR="\"sh\" \"`pwd`/editor.sh\"" hg commit -i -m "one hunk" -d "0 0"
102 $ HGEDITOR="\"sh\" \"`pwd`/editor.sh\"" hg commit -i -m "one hunk" -d "0 0"
102 editor ran
103 editor ran
103 $ rm editor.sh
104 $ rm editor.sh
104 $ hg tip
105 $ hg tip
105 changeset: 2:7d10dfe755a8
106 changeset: 2:7d10dfe755a8
106 tag: tip
107 tag: tip
107 user: test
108 user: test
108 date: Thu Jan 01 00:00:00 1970 +0000
109 date: Thu Jan 01 00:00:00 1970 +0000
109 summary: one hunk
110 summary: one hunk
110
111
111 $ hg cat -r tip b
112 $ hg cat -r tip b
112 1
113 1
113 2
114 2
114 3
115 3
115 4
116 4
116 5
117 5
117 6
118 6
118 7
119 7
119 8
120 8
120 9
121 9
121 10
122 10
122 y
123 y
123 $ cat b
124 $ cat b
124 x
125 x
125 1
126 1
126 2
127 2
127 3
128 3
128 4
129 4
129 5
130 5
130 6
131 6
131 7
132 7
132 8
133 8
133 9
134 9
134 10
135 10
135 y
136 y
136 $ hg commit -m "other hunks"
137 $ hg commit -m "other hunks"
137 $ hg tip
138 $ hg tip
138 changeset: 3:a6735021574d
139 changeset: 3:a6735021574d
139 tag: tip
140 tag: tip
140 user: test
141 user: test
141 date: Thu Jan 01 00:00:00 1970 +0000
142 date: Thu Jan 01 00:00:00 1970 +0000
142 summary: other hunks
143 summary: other hunks
143
144
144 $ hg cat -r tip b
145 $ hg cat -r tip b
145 x
146 x
146 1
147 1
147 2
148 2
148 3
149 3
149 4
150 4
150 5
151 5
151 6
152 6
152 7
153 7
153 8
154 8
154 9
155 9
155 10
156 10
156 y
157 y
157
158
158 Newly added files can be selected with the curses interface
159 Newly added files can be selected with the curses interface
159
160
160 $ hg update -C .
161 $ hg update -C .
161 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
162 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
162 $ echo "hello" > x
163 $ echo "hello" > x
163 $ hg add x
164 $ hg add x
164 $ cat <<EOF >testModeCommands
165 $ cat <<EOF >testModeCommands
165 > TOGGLE
166 > TOGGLE
166 > TOGGLE
167 > TOGGLE
167 > X
168 > X
168 > EOF
169 > EOF
169 $ hg st
170 $ hg st
170 A x
171 A x
171 ? testModeCommands
172 ? testModeCommands
172 $ hg commit -i -m "newly added file" -d "0 0"
173 $ hg commit -i -m "newly added file" -d "0 0"
173 $ hg st
174 $ hg st
174 ? testModeCommands
175 ? testModeCommands
175
176
176 Amend option works
177 Amend option works
177 $ echo "hello world" > x
178 $ echo "hello world" > x
178 $ hg diff -c .
179 $ hg diff -c .
179 diff -r a6735021574d -r 2b0e9be4d336 x
180 diff -r a6735021574d -r 2b0e9be4d336 x
180 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
181 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
181 +++ b/x Thu Jan 01 00:00:00 1970 +0000
182 +++ b/x Thu Jan 01 00:00:00 1970 +0000
182 @@ -0,0 +1,1 @@
183 @@ -0,0 +1,1 @@
183 +hello
184 +hello
184 $ cat <<EOF >testModeCommands
185 $ cat <<EOF >testModeCommands
185 > a
186 > a
186 > X
187 > X
187 > EOF
188 > EOF
188 $ hg commit -i -m "newly added file" -d "0 0"
189 $ hg commit -i -m "newly added file" -d "0 0"
189 saved backup bundle to $TESTTMP/a/.hg/strip-backup/2b0e9be4d336-28bbe4e2-amend-backup.hg (glob)
190 saved backup bundle to $TESTTMP/a/.hg/strip-backup/2b0e9be4d336-28bbe4e2-amend-backup.hg (glob)
190 $ hg diff -c .
191 $ hg diff -c .
191 diff -r a6735021574d -r c1d239d165ae x
192 diff -r a6735021574d -r c1d239d165ae x
192 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
193 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
193 +++ b/x Thu Jan 01 00:00:00 1970 +0000
194 +++ b/x Thu Jan 01 00:00:00 1970 +0000
194 @@ -0,0 +1,1 @@
195 @@ -0,0 +1,1 @@
195 +hello world
196 +hello world
196
197
197 Editing a hunk puts you back on that hunk when done editing (issue5041)
198 Editing a hunk puts you back on that hunk when done editing (issue5041)
198 To do that, we change two lines in a file, pretend to edit the second line,
199 To do that, we change two lines in a file, pretend to edit the second line,
199 exit, toggle the line selected at the end of the edit and commit.
200 exit, toggle the line selected at the end of the edit and commit.
200 The first line should be recorded if we were put on the second line at the end
201 The first line should be recorded if we were put on the second line at the end
201 of the edit.
202 of the edit.
202
203
203 $ hg update -C .
204 $ hg update -C .
204 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
205 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
205 $ echo "foo" > x
206 $ echo "foo" > x
206 $ echo "hello world" >> x
207 $ echo "hello world" >> x
207 $ echo "bar" >> x
208 $ echo "bar" >> x
208 $ cat <<EOF >testModeCommands
209 $ cat <<EOF >testModeCommands
209 > f
210 > f
210 > KEY_DOWN
211 > KEY_DOWN
211 > KEY_DOWN
212 > KEY_DOWN
212 > KEY_DOWN
213 > KEY_DOWN
213 > KEY_DOWN
214 > KEY_DOWN
214 > e
215 > e
215 > TOGGLE
216 > TOGGLE
216 > X
217 > X
217 > EOF
218 > EOF
218 $ printf "printf 'editor ran\n'; exit 0" > editor.sh
219 $ printf "printf 'editor ran\n'; exit 0" > editor.sh
219 $ HGEDITOR="\"sh\" \"`pwd`/editor.sh\"" hg commit -i -m "edit hunk" -d "0 0"
220 $ HGEDITOR="\"sh\" \"`pwd`/editor.sh\"" hg commit -i -m "edit hunk" -d "0 0"
220 editor ran
221 editor ran
221 $ hg cat -r . x
222 $ hg cat -r . x
222 foo
223 foo
223 hello world
224 hello world
224
225
225
226
227 Check ui.interface logic for the chunkselector
228
229 The default interface is text
230 $ cp $HGRCPATH.pretest $HGRCPATH
231 $ chunkselectorinterface() {
232 > python <<EOF
233 > from mercurial import hg, ui, parsers;\
234 > repo = hg.repository(ui.ui(), ".");\
235 > print repo.ui.interface("chunkselector")
236 > EOF
237 > }
238 $ chunkselectorinterface
239 text
240
241 If only the default is set, we'll use that for the feature, too
242 $ cp $HGRCPATH.pretest $HGRCPATH
243 $ cat <<EOF >> $HGRCPATH
244 > [ui]
245 > interface = curses
246 > EOF
247 $ chunkselectorinterface
248 curses
249
250 It is possible to override the default interface with a feature specific
251 interface
252 $ cp $HGRCPATH.pretest $HGRCPATH
253 $ cat <<EOF >> $HGRCPATH
254 > [ui]
255 > interface = text
256 > interface.chunkselector = curses
257 > EOF
258
259 $ chunkselectorinterface
260 curses
261
262 $ cp $HGRCPATH.pretest $HGRCPATH
263 $ cat <<EOF >> $HGRCPATH
264 > [ui]
265 > interface = curses
266 > interface.chunkselector = text
267 > EOF
268
269 $ chunkselectorinterface
270 text
271
272 If a bad interface name is given, we use the default value (with a nice
273 error message to suggest that the configuration needs to be fixed)
274
275 $ cp $HGRCPATH.pretest $HGRCPATH
276 $ cat <<EOF >> $HGRCPATH
277 > [ui]
278 > interface = blah
279 > EOF
280 $ chunkselectorinterface
281 invalid value for ui.interface: blah (using text)
282 text
283
284 $ cp $HGRCPATH.pretest $HGRCPATH
285 $ cat <<EOF >> $HGRCPATH
286 > [ui]
287 > interface = curses
288 > interface.chunkselector = blah
289 > EOF
290 $ chunkselectorinterface
291 invalid value for ui.interface.chunkselector: blah (using curses)
292 curses
293
294 $ cp $HGRCPATH.pretest $HGRCPATH
295 $ cat <<EOF >> $HGRCPATH
296 > [ui]
297 > interface = blah
298 > interface.chunkselector = curses
299 > EOF
300 $ chunkselectorinterface
301 invalid value for ui.interface: blah
302 curses
303
304 $ cp $HGRCPATH.pretest $HGRCPATH
305 $ cat <<EOF >> $HGRCPATH
306 > [ui]
307 > interface = blah
308 > interface.chunkselector = blah
309 > EOF
310 $ chunkselectorinterface
311 invalid value for ui.interface: blah
312 invalid value for ui.interface.chunkselector: blah (using text)
313 text
General Comments 0
You need to be logged in to leave comments. Login now