##// END OF EJS Templates
color: turn 'ui.color' into a boolean (auto or off)...
Pierre-Yves David -
r32103:9a85ea1d stable
parent child Browse files
Show More
@@ -1,505 +1,512 b''
1 1 # utility for color output for Mercurial commands
2 2 #
3 3 # Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com> and other
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 from __future__ import absolute_import
9 9
10 10 import re
11 11
12 12 from .i18n import _
13 13
14 14 from . import (
15 15 encoding,
16 16 pycompat,
17 17 util
18 18 )
19 19
20 20 try:
21 21 import curses
22 22 # Mapping from effect name to terminfo attribute name (or raw code) or
23 23 # color number. This will also force-load the curses module.
24 24 _baseterminfoparams = {
25 25 'none': (True, 'sgr0', ''),
26 26 'standout': (True, 'smso', ''),
27 27 'underline': (True, 'smul', ''),
28 28 'reverse': (True, 'rev', ''),
29 29 'inverse': (True, 'rev', ''),
30 30 'blink': (True, 'blink', ''),
31 31 'dim': (True, 'dim', ''),
32 32 'bold': (True, 'bold', ''),
33 33 'invisible': (True, 'invis', ''),
34 34 'italic': (True, 'sitm', ''),
35 35 'black': (False, curses.COLOR_BLACK, ''),
36 36 'red': (False, curses.COLOR_RED, ''),
37 37 'green': (False, curses.COLOR_GREEN, ''),
38 38 'yellow': (False, curses.COLOR_YELLOW, ''),
39 39 'blue': (False, curses.COLOR_BLUE, ''),
40 40 'magenta': (False, curses.COLOR_MAGENTA, ''),
41 41 'cyan': (False, curses.COLOR_CYAN, ''),
42 42 'white': (False, curses.COLOR_WHITE, ''),
43 43 }
44 44 except ImportError:
45 45 curses = None
46 46 _baseterminfoparams = {}
47 47
48 48 _enabledbydefault = True
49 49
50 50 # start and stop parameters for effects
51 51 _effects = {
52 52 'none': 0,
53 53 'black': 30,
54 54 'red': 31,
55 55 'green': 32,
56 56 'yellow': 33,
57 57 'blue': 34,
58 58 'magenta': 35,
59 59 'cyan': 36,
60 60 'white': 37,
61 61 'bold': 1,
62 62 'italic': 3,
63 63 'underline': 4,
64 64 'inverse': 7,
65 65 'dim': 2,
66 66 'black_background': 40,
67 67 'red_background': 41,
68 68 'green_background': 42,
69 69 'yellow_background': 43,
70 70 'blue_background': 44,
71 71 'purple_background': 45,
72 72 'cyan_background': 46,
73 73 'white_background': 47,
74 74 }
75 75
76 76 _defaultstyles = {
77 77 'grep.match': 'red bold',
78 78 'grep.linenumber': 'green',
79 79 'grep.rev': 'green',
80 80 'grep.change': 'green',
81 81 'grep.sep': 'cyan',
82 82 'grep.filename': 'magenta',
83 83 'grep.user': 'magenta',
84 84 'grep.date': 'magenta',
85 85 'bookmarks.active': 'green',
86 86 'branches.active': 'none',
87 87 'branches.closed': 'black bold',
88 88 'branches.current': 'green',
89 89 'branches.inactive': 'none',
90 90 'diff.changed': 'white',
91 91 'diff.deleted': 'red',
92 92 'diff.diffline': 'bold',
93 93 'diff.extended': 'cyan bold',
94 94 'diff.file_a': 'red bold',
95 95 'diff.file_b': 'green bold',
96 96 'diff.hunk': 'magenta',
97 97 'diff.inserted': 'green',
98 98 'diff.tab': '',
99 99 'diff.trailingwhitespace': 'bold red_background',
100 100 'changeset.public' : '',
101 101 'changeset.draft' : '',
102 102 'changeset.secret' : '',
103 103 'diffstat.deleted': 'red',
104 104 'diffstat.inserted': 'green',
105 105 'histedit.remaining': 'red bold',
106 106 'ui.prompt': 'yellow',
107 107 'log.changeset': 'yellow',
108 108 'patchbomb.finalsummary': '',
109 109 'patchbomb.from': 'magenta',
110 110 'patchbomb.to': 'cyan',
111 111 'patchbomb.subject': 'green',
112 112 'patchbomb.diffstats': '',
113 113 'rebase.rebased': 'blue',
114 114 'rebase.remaining': 'red bold',
115 115 'resolve.resolved': 'green bold',
116 116 'resolve.unresolved': 'red bold',
117 117 'shelve.age': 'cyan',
118 118 'shelve.newest': 'green bold',
119 119 'shelve.name': 'blue bold',
120 120 'status.added': 'green bold',
121 121 'status.clean': 'none',
122 122 'status.copied': 'none',
123 123 'status.deleted': 'cyan bold underline',
124 124 'status.ignored': 'black bold',
125 125 'status.modified': 'blue bold',
126 126 'status.removed': 'red bold',
127 127 'status.unknown': 'magenta bold underline',
128 128 'tags.normal': 'green',
129 129 'tags.local': 'black bold',
130 130 }
131 131
132 132 def loadcolortable(ui, extname, colortable):
133 133 _defaultstyles.update(colortable)
134 134
135 135 def _terminfosetup(ui, mode):
136 136 '''Initialize terminfo data and the terminal if we're in terminfo mode.'''
137 137
138 138 # If we failed to load curses, we go ahead and return.
139 139 if curses is None:
140 140 return
141 141 # Otherwise, see what the config file says.
142 142 if mode not in ('auto', 'terminfo'):
143 143 return
144 144 ui._terminfoparams.update(_baseterminfoparams)
145 145
146 146 for key, val in ui.configitems('color'):
147 147 if key.startswith('color.'):
148 148 newval = (False, int(val), '')
149 149 ui._terminfoparams[key[6:]] = newval
150 150 elif key.startswith('terminfo.'):
151 151 newval = (True, '', val.replace('\\E', '\x1b'))
152 152 ui._terminfoparams[key[9:]] = newval
153 153 try:
154 154 curses.setupterm()
155 155 except curses.error as e:
156 156 ui._terminfoparams.clear()
157 157 return
158 158
159 159 for key, (b, e, c) in ui._terminfoparams.items():
160 160 if not b:
161 161 continue
162 162 if not c and not curses.tigetstr(e):
163 163 # Most terminals don't support dim, invis, etc, so don't be
164 164 # noisy and use ui.debug().
165 165 ui.debug("no terminfo entry for %s\n" % e)
166 166 del ui._terminfoparams[key]
167 167 if not curses.tigetstr('setaf') or not curses.tigetstr('setab'):
168 168 # Only warn about missing terminfo entries if we explicitly asked for
169 169 # terminfo mode.
170 170 if mode == "terminfo":
171 171 ui.warn(_("no terminfo entry for setab/setaf: reverting to "
172 172 "ECMA-48 color\n"))
173 173 ui._terminfoparams.clear()
174 174
175 175 def setup(ui):
176 176 """configure color on a ui
177 177
178 178 That function both set the colormode for the ui object and read
179 179 the configuration looking for custom colors and effect definitions."""
180 180 mode = _modesetup(ui)
181 181 ui._colormode = mode
182 182 if mode and mode != 'debug':
183 183 configstyles(ui)
184 184
185 185 def _modesetup(ui):
186 186 if ui.plain():
187 187 return None
188 188 default = 'never'
189 189 if _enabledbydefault:
190 190 default = 'auto'
191 191 config = ui.config('ui', 'color', default)
192 192 if config == 'debug':
193 193 return 'debug'
194 194
195 195 auto = (config == 'auto')
196 always = not auto and util.parsebool(config)
196 always = False
197 if not auto and util.parsebool(config):
198 # we want the config to behave like a boolean, "on" is actually auto
199 if ui.configsource('ui', 'color') == '--color':
200 always = True
201 else:
202 auto = True
203
197 204 if not always and not auto:
198 205 return None
199 206
200 207 formatted = (always or (encoding.environ.get('TERM') != 'dumb'
201 208 and ui.formatted()))
202 209
203 210 mode = ui.config('color', 'mode', 'auto')
204 211
205 212 # If pager is active, color.pagermode overrides color.mode.
206 213 if getattr(ui, 'pageractive', False):
207 214 mode = ui.config('color', 'pagermode', mode)
208 215
209 216 realmode = mode
210 217 if mode == 'auto':
211 218 if pycompat.osname == 'nt':
212 219 term = encoding.environ.get('TERM')
213 220 # TERM won't be defined in a vanilla cmd.exe environment.
214 221
215 222 # UNIX-like environments on Windows such as Cygwin and MSYS will
216 223 # set TERM. They appear to make a best effort attempt at setting it
217 224 # to something appropriate. However, not all environments with TERM
218 225 # defined support ANSI. Since "ansi" could result in terminal
219 226 # gibberish, we error on the side of selecting "win32". However, if
220 227 # w32effects is not defined, we almost certainly don't support
221 228 # "win32", so don't even try.
222 229 if (term and 'xterm' in term) or not w32effects:
223 230 realmode = 'ansi'
224 231 else:
225 232 realmode = 'win32'
226 233 else:
227 234 realmode = 'ansi'
228 235
229 236 def modewarn():
230 237 # only warn if color.mode was explicitly set and we're in
231 238 # a formatted terminal
232 239 if mode == realmode and ui.formatted():
233 240 ui.warn(_('warning: failed to set color mode to %s\n') % mode)
234 241
235 242 if realmode == 'win32':
236 243 ui._terminfoparams.clear()
237 244 if not w32effects:
238 245 modewarn()
239 246 return None
240 247 elif realmode == 'ansi':
241 248 ui._terminfoparams.clear()
242 249 elif realmode == 'terminfo':
243 250 _terminfosetup(ui, mode)
244 251 if not ui._terminfoparams:
245 252 ## FIXME Shouldn't we return None in this case too?
246 253 modewarn()
247 254 realmode = 'ansi'
248 255 else:
249 256 return None
250 257
251 258 if always or (auto and formatted):
252 259 return realmode
253 260 return None
254 261
255 262 def configstyles(ui):
256 263 ui._styles.update(_defaultstyles)
257 264 for status, cfgeffects in ui.configitems('color'):
258 265 if '.' not in status or status.startswith(('color.', 'terminfo.')):
259 266 continue
260 267 cfgeffects = ui.configlist('color', status)
261 268 if cfgeffects:
262 269 good = []
263 270 for e in cfgeffects:
264 271 if valideffect(ui, e):
265 272 good.append(e)
266 273 else:
267 274 ui.warn(_("ignoring unknown color/effect %r "
268 275 "(configured in color.%s)\n")
269 276 % (e, status))
270 277 ui._styles[status] = ' '.join(good)
271 278
272 279 def _activeeffects(ui):
273 280 '''Return the effects map for the color mode set on the ui.'''
274 281 if ui._colormode == 'win32':
275 282 return w32effects
276 283 elif ui._colormode is not None:
277 284 return _effects
278 285 return {}
279 286
280 287 def valideffect(ui, effect):
281 288 'Determine if the effect is valid or not.'
282 289 return ((not ui._terminfoparams and effect in _activeeffects(ui))
283 290 or (effect in ui._terminfoparams
284 291 or effect[:-11] in ui._terminfoparams))
285 292
286 293 def _effect_str(ui, effect):
287 294 '''Helper function for render_effects().'''
288 295
289 296 bg = False
290 297 if effect.endswith('_background'):
291 298 bg = True
292 299 effect = effect[:-11]
293 300 try:
294 301 attr, val, termcode = ui._terminfoparams[effect]
295 302 except KeyError:
296 303 return ''
297 304 if attr:
298 305 if termcode:
299 306 return termcode
300 307 else:
301 308 return curses.tigetstr(val)
302 309 elif bg:
303 310 return curses.tparm(curses.tigetstr('setab'), val)
304 311 else:
305 312 return curses.tparm(curses.tigetstr('setaf'), val)
306 313
307 314 def _mergeeffects(text, start, stop):
308 315 """Insert start sequence at every occurrence of stop sequence
309 316
310 317 >>> s = _mergeeffects('cyan', '[C]', '|')
311 318 >>> s = _mergeeffects(s + 'yellow', '[Y]', '|')
312 319 >>> s = _mergeeffects('ma' + s + 'genta', '[M]', '|')
313 320 >>> s = _mergeeffects('red' + s, '[R]', '|')
314 321 >>> s
315 322 '[R]red[M]ma[Y][C]cyan|[R][M][Y]yellow|[R][M]genta|'
316 323 """
317 324 parts = []
318 325 for t in text.split(stop):
319 326 if not t:
320 327 continue
321 328 parts.extend([start, t, stop])
322 329 return ''.join(parts)
323 330
324 331 def _render_effects(ui, text, effects):
325 332 'Wrap text in commands to turn on each effect.'
326 333 if not text:
327 334 return text
328 335 if ui._terminfoparams:
329 336 start = ''.join(_effect_str(ui, effect)
330 337 for effect in ['none'] + effects.split())
331 338 stop = _effect_str(ui, 'none')
332 339 else:
333 340 activeeffects = _activeeffects(ui)
334 341 start = [pycompat.bytestr(activeeffects[e])
335 342 for e in ['none'] + effects.split()]
336 343 start = '\033[' + ';'.join(start) + 'm'
337 344 stop = '\033[' + pycompat.bytestr(activeeffects['none']) + 'm'
338 345 return _mergeeffects(text, start, stop)
339 346
340 347 _ansieffectre = re.compile(br'\x1b\[[0-9;]*m')
341 348
342 349 def stripeffects(text):
343 350 """Strip ANSI control codes which could be inserted by colorlabel()"""
344 351 return _ansieffectre.sub('', text)
345 352
346 353 def colorlabel(ui, msg, label):
347 354 """add color control code according to the mode"""
348 355 if ui._colormode == 'debug':
349 356 if label and msg:
350 357 if msg[-1] == '\n':
351 358 msg = "[%s|%s]\n" % (label, msg[:-1])
352 359 else:
353 360 msg = "[%s|%s]" % (label, msg)
354 361 elif ui._colormode is not None:
355 362 effects = []
356 363 for l in label.split():
357 364 s = ui._styles.get(l, '')
358 365 if s:
359 366 effects.append(s)
360 367 elif valideffect(ui, l):
361 368 effects.append(l)
362 369 effects = ' '.join(effects)
363 370 if effects:
364 371 msg = '\n'.join([_render_effects(ui, line, effects)
365 372 for line in msg.split('\n')])
366 373 return msg
367 374
368 375 w32effects = None
369 376 if pycompat.osname == 'nt':
370 377 import ctypes
371 378
372 379 _kernel32 = ctypes.windll.kernel32
373 380
374 381 _WORD = ctypes.c_ushort
375 382
376 383 _INVALID_HANDLE_VALUE = -1
377 384
378 385 class _COORD(ctypes.Structure):
379 386 _fields_ = [('X', ctypes.c_short),
380 387 ('Y', ctypes.c_short)]
381 388
382 389 class _SMALL_RECT(ctypes.Structure):
383 390 _fields_ = [('Left', ctypes.c_short),
384 391 ('Top', ctypes.c_short),
385 392 ('Right', ctypes.c_short),
386 393 ('Bottom', ctypes.c_short)]
387 394
388 395 class _CONSOLE_SCREEN_BUFFER_INFO(ctypes.Structure):
389 396 _fields_ = [('dwSize', _COORD),
390 397 ('dwCursorPosition', _COORD),
391 398 ('wAttributes', _WORD),
392 399 ('srWindow', _SMALL_RECT),
393 400 ('dwMaximumWindowSize', _COORD)]
394 401
395 402 _STD_OUTPUT_HANDLE = 0xfffffff5 # (DWORD)-11
396 403 _STD_ERROR_HANDLE = 0xfffffff4 # (DWORD)-12
397 404
398 405 _FOREGROUND_BLUE = 0x0001
399 406 _FOREGROUND_GREEN = 0x0002
400 407 _FOREGROUND_RED = 0x0004
401 408 _FOREGROUND_INTENSITY = 0x0008
402 409
403 410 _BACKGROUND_BLUE = 0x0010
404 411 _BACKGROUND_GREEN = 0x0020
405 412 _BACKGROUND_RED = 0x0040
406 413 _BACKGROUND_INTENSITY = 0x0080
407 414
408 415 _COMMON_LVB_REVERSE_VIDEO = 0x4000
409 416 _COMMON_LVB_UNDERSCORE = 0x8000
410 417
411 418 # http://msdn.microsoft.com/en-us/library/ms682088%28VS.85%29.aspx
412 419 w32effects = {
413 420 'none': -1,
414 421 'black': 0,
415 422 'red': _FOREGROUND_RED,
416 423 'green': _FOREGROUND_GREEN,
417 424 'yellow': _FOREGROUND_RED | _FOREGROUND_GREEN,
418 425 'blue': _FOREGROUND_BLUE,
419 426 'magenta': _FOREGROUND_BLUE | _FOREGROUND_RED,
420 427 'cyan': _FOREGROUND_BLUE | _FOREGROUND_GREEN,
421 428 'white': _FOREGROUND_RED | _FOREGROUND_GREEN | _FOREGROUND_BLUE,
422 429 'bold': _FOREGROUND_INTENSITY,
423 430 'black_background': 0x100, # unused value > 0x0f
424 431 'red_background': _BACKGROUND_RED,
425 432 'green_background': _BACKGROUND_GREEN,
426 433 'yellow_background': _BACKGROUND_RED | _BACKGROUND_GREEN,
427 434 'blue_background': _BACKGROUND_BLUE,
428 435 'purple_background': _BACKGROUND_BLUE | _BACKGROUND_RED,
429 436 'cyan_background': _BACKGROUND_BLUE | _BACKGROUND_GREEN,
430 437 'white_background': (_BACKGROUND_RED | _BACKGROUND_GREEN |
431 438 _BACKGROUND_BLUE),
432 439 'bold_background': _BACKGROUND_INTENSITY,
433 440 'underline': _COMMON_LVB_UNDERSCORE, # double-byte charsets only
434 441 'inverse': _COMMON_LVB_REVERSE_VIDEO, # double-byte charsets only
435 442 }
436 443
437 444 passthrough = set([_FOREGROUND_INTENSITY,
438 445 _BACKGROUND_INTENSITY,
439 446 _COMMON_LVB_UNDERSCORE,
440 447 _COMMON_LVB_REVERSE_VIDEO])
441 448
442 449 stdout = _kernel32.GetStdHandle(
443 450 _STD_OUTPUT_HANDLE) # don't close the handle returned
444 451 if stdout is None or stdout == _INVALID_HANDLE_VALUE:
445 452 w32effects = None
446 453 else:
447 454 csbi = _CONSOLE_SCREEN_BUFFER_INFO()
448 455 if not _kernel32.GetConsoleScreenBufferInfo(
449 456 stdout, ctypes.byref(csbi)):
450 457 # stdout may not support GetConsoleScreenBufferInfo()
451 458 # when called from subprocess or redirected
452 459 w32effects = None
453 460 else:
454 461 origattr = csbi.wAttributes
455 462 ansire = re.compile('\033\[([^m]*)m([^\033]*)(.*)',
456 463 re.MULTILINE | re.DOTALL)
457 464
458 465 def win32print(ui, writefunc, *msgs, **opts):
459 466 for text in msgs:
460 467 _win32print(ui, text, writefunc, **opts)
461 468
462 469 def _win32print(ui, text, writefunc, **opts):
463 470 label = opts.get('label', '')
464 471 attr = origattr
465 472
466 473 def mapcolor(val, attr):
467 474 if val == -1:
468 475 return origattr
469 476 elif val in passthrough:
470 477 return attr | val
471 478 elif val > 0x0f:
472 479 return (val & 0x70) | (attr & 0x8f)
473 480 else:
474 481 return (val & 0x07) | (attr & 0xf8)
475 482
476 483 # determine console attributes based on labels
477 484 for l in label.split():
478 485 style = ui._styles.get(l, '')
479 486 for effect in style.split():
480 487 try:
481 488 attr = mapcolor(w32effects[effect], attr)
482 489 except KeyError:
483 490 # w32effects could not have certain attributes so we skip
484 491 # them if not found
485 492 pass
486 493 # hack to ensure regexp finds data
487 494 if not text.startswith('\033['):
488 495 text = '\033[m' + text
489 496
490 497 # Look for ANSI-like codes embedded in text
491 498 m = re.match(ansire, text)
492 499
493 500 try:
494 501 while m:
495 502 for sattr in m.group(1).split(';'):
496 503 if sattr:
497 504 attr = mapcolor(int(sattr), attr)
498 505 ui.flush()
499 506 _kernel32.SetConsoleTextAttribute(stdout, attr)
500 507 writefunc(m.group(2), **opts)
501 508 m = re.match(ansire, m.group(3))
502 509 finally:
503 510 # Explicitly reset original attributes
504 511 ui.flush()
505 512 _kernel32.SetConsoleTextAttribute(stdout, origattr)
@@ -1,141 +1,141 b''
1 1 Mercurial colorizes output from several commands.
2 2
3 3 For example, the diff command shows additions in green and deletions
4 4 in red, while the status command shows modified files in magenta. Many
5 5 other commands have analogous colors. It is possible to customize
6 6 these colors.
7 7
8 To enable color (default) use::
8 To enable color (default) whenever possible use::
9 9
10 10 [ui]
11 color = auto
11 color = yes
12 12
13 13 To disable color use::
14 14
15 15 [ui]
16 color = never
16 color = no
17 17
18 18 See :hg:`help config.ui.color` for details.
19 19
20 20 Mode
21 21 ====
22 22
23 23 Mercurial can use various system to display color. The supported modes are
24 24 ``ansi``, ``win32``, and ``terminfo``. See :hg:`help config.color` for details
25 25 about how to control the mode
26 26
27 27 Effects
28 28 =======
29 29
30 30 Other effects in addition to color, like bold and underlined text, are
31 31 also available. By default, the terminfo database is used to find the
32 32 terminal codes used to change color and effect. If terminfo is not
33 33 available, then effects are rendered with the ECMA-48 SGR control
34 34 function (aka ANSI escape codes).
35 35
36 36 The available effects in terminfo mode are 'blink', 'bold', 'dim',
37 37 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in
38 38 ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and
39 39 'underline'. How each is rendered depends on the terminal emulator.
40 40 Some may not be available for a given terminal type, and will be
41 41 silently ignored.
42 42
43 43 If the terminfo entry for your terminal is missing codes for an effect
44 44 or has the wrong codes, you can add or override those codes in your
45 45 configuration::
46 46
47 47 [color]
48 48 terminfo.dim = \E[2m
49 49
50 50 where '\E' is substituted with an escape character.
51 51
52 52 Labels
53 53 ======
54 54
55 55 Text receives color effects depending on the labels that it has. Many
56 56 default Mercurial commands emit labelled text. You can also define
57 57 your own labels in templates using the label function, see :hg:`help
58 58 templates`. A single portion of text may have more than one label. In
59 59 that case, effects given to the last label will override any other
60 60 effects. This includes the special "none" effect, which nullifies
61 61 other effects.
62 62
63 63 Labels are normally invisible. In order to see these labels and their
64 64 position in the text, use the global --color=debug option. The same
65 65 anchor text may be associated to multiple labels, e.g.
66 66
67 67 [log.changeset changeset.secret|changeset: 22611:6f0a53c8f587]
68 68
69 69 The following are the default effects for some default labels. Default
70 70 effects may be overridden from your configuration file::
71 71
72 72 [color]
73 73 status.modified = blue bold underline red_background
74 74 status.added = green bold
75 75 status.removed = red bold blue_background
76 76 status.deleted = cyan bold underline
77 77 status.unknown = magenta bold underline
78 78 status.ignored = black bold
79 79
80 80 # 'none' turns off all effects
81 81 status.clean = none
82 82 status.copied = none
83 83
84 84 qseries.applied = blue bold underline
85 85 qseries.unapplied = black bold
86 86 qseries.missing = red bold
87 87
88 88 diff.diffline = bold
89 89 diff.extended = cyan bold
90 90 diff.file_a = red bold
91 91 diff.file_b = green bold
92 92 diff.hunk = magenta
93 93 diff.deleted = red
94 94 diff.inserted = green
95 95 diff.changed = white
96 96 diff.tab =
97 97 diff.trailingwhitespace = bold red_background
98 98
99 99 # Blank so it inherits the style of the surrounding label
100 100 changeset.public =
101 101 changeset.draft =
102 102 changeset.secret =
103 103
104 104 resolve.unresolved = red bold
105 105 resolve.resolved = green bold
106 106
107 107 bookmarks.active = green
108 108
109 109 branches.active = none
110 110 branches.closed = black bold
111 111 branches.current = green
112 112 branches.inactive = none
113 113
114 114 tags.normal = green
115 115 tags.local = black bold
116 116
117 117 rebase.rebased = blue
118 118 rebase.remaining = red bold
119 119
120 120 shelve.age = cyan
121 121 shelve.newest = green bold
122 122 shelve.name = blue bold
123 123
124 124 histedit.remaining = red bold
125 125
126 126 Custom colors
127 127 =============
128 128
129 129 Because there are only eight standard colors, Mercurial allows you
130 130 to define color names for other color slots which might be available
131 131 for your terminal type, assuming terminfo mode. For instance::
132 132
133 133 color.brightblue = 12
134 134 color.pink = 207
135 135 color.orange = 202
136 136
137 137 to set 'brightblue' to color slot 12 (useful for 16 color terminals
138 138 that have brighter colors defined in the upper eight) and, 'pink' and
139 139 'orange' to colors in 256-color xterm's default color cube. These
140 140 defined colors may then be used as any of the pre-defined eight,
141 141 including appending '_background' to set the background to that color.
@@ -1,2409 +1,2409 b''
1 1 The Mercurial system uses a set of configuration files to control
2 2 aspects of its behavior.
3 3
4 4 Troubleshooting
5 5 ===============
6 6
7 7 If you're having problems with your configuration,
8 8 :hg:`config --debug` can help you understand what is introducing
9 9 a setting into your environment.
10 10
11 11 See :hg:`help config.syntax` and :hg:`help config.files`
12 12 for information about how and where to override things.
13 13
14 14 Structure
15 15 =========
16 16
17 17 The configuration files use a simple ini-file format. A configuration
18 18 file consists of sections, led by a ``[section]`` header and followed
19 19 by ``name = value`` entries::
20 20
21 21 [ui]
22 22 username = Firstname Lastname <firstname.lastname@example.net>
23 23 verbose = True
24 24
25 25 The above entries will be referred to as ``ui.username`` and
26 26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27 27
28 28 Files
29 29 =====
30 30
31 31 Mercurial reads configuration data from several files, if they exist.
32 32 These files do not exist by default and you will have to create the
33 33 appropriate configuration files yourself:
34 34
35 35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36 36
37 37 Global configuration like the username setting is typically put into:
38 38
39 39 .. container:: windows
40 40
41 41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42 42
43 43 .. container:: unix.plan9
44 44
45 45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46 46
47 47 The names of these files depend on the system on which Mercurial is
48 48 installed. ``*.rc`` files from a single directory are read in
49 49 alphabetical order, later ones overriding earlier ones. Where multiple
50 50 paths are given below, settings from earlier paths override later
51 51 ones.
52 52
53 53 .. container:: verbose.unix
54 54
55 55 On Unix, the following files are consulted:
56 56
57 57 - ``<repo>/.hg/hgrc`` (per-repository)
58 58 - ``$HOME/.hgrc`` (per-user)
59 59 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
60 60 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
61 61 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
62 62 - ``/etc/mercurial/hgrc`` (per-system)
63 63 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
64 64 - ``<internal>/default.d/*.rc`` (defaults)
65 65
66 66 .. container:: verbose.windows
67 67
68 68 On Windows, the following files are consulted:
69 69
70 70 - ``<repo>/.hg/hgrc`` (per-repository)
71 71 - ``%USERPROFILE%\.hgrc`` (per-user)
72 72 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
73 73 - ``%HOME%\.hgrc`` (per-user)
74 74 - ``%HOME%\Mercurial.ini`` (per-user)
75 75 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
76 76 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
77 77 - ``<install-dir>\Mercurial.ini`` (per-installation)
78 78 - ``<internal>/default.d/*.rc`` (defaults)
79 79
80 80 .. note::
81 81
82 82 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
83 83 is used when running 32-bit Python on 64-bit Windows.
84 84
85 85 .. container:: windows
86 86
87 87 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
88 88
89 89 .. container:: verbose.plan9
90 90
91 91 On Plan9, the following files are consulted:
92 92
93 93 - ``<repo>/.hg/hgrc`` (per-repository)
94 94 - ``$home/lib/hgrc`` (per-user)
95 95 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
96 96 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
97 97 - ``/lib/mercurial/hgrc`` (per-system)
98 98 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
99 99 - ``<internal>/default.d/*.rc`` (defaults)
100 100
101 101 Per-repository configuration options only apply in a
102 102 particular repository. This file is not version-controlled, and
103 103 will not get transferred during a "clone" operation. Options in
104 104 this file override options in all other configuration files.
105 105
106 106 .. container:: unix.plan9
107 107
108 108 On Plan 9 and Unix, most of this file will be ignored if it doesn't
109 109 belong to a trusted user or to a trusted group. See
110 110 :hg:`help config.trusted` for more details.
111 111
112 112 Per-user configuration file(s) are for the user running Mercurial. Options
113 113 in these files apply to all Mercurial commands executed by this user in any
114 114 directory. Options in these files override per-system and per-installation
115 115 options.
116 116
117 117 Per-installation configuration files are searched for in the
118 118 directory where Mercurial is installed. ``<install-root>`` is the
119 119 parent directory of the **hg** executable (or symlink) being run.
120 120
121 121 .. container:: unix.plan9
122 122
123 123 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
124 124 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
125 125 files apply to all Mercurial commands executed by any user in any
126 126 directory.
127 127
128 128 Per-installation configuration files are for the system on
129 129 which Mercurial is running. Options in these files apply to all
130 130 Mercurial commands executed by any user in any directory. Registry
131 131 keys contain PATH-like strings, every part of which must reference
132 132 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
133 133 be read. Mercurial checks each of these locations in the specified
134 134 order until one or more configuration files are detected.
135 135
136 136 Per-system configuration files are for the system on which Mercurial
137 137 is running. Options in these files apply to all Mercurial commands
138 138 executed by any user in any directory. Options in these files
139 139 override per-installation options.
140 140
141 141 Mercurial comes with some default configuration. The default configuration
142 142 files are installed with Mercurial and will be overwritten on upgrades. Default
143 143 configuration files should never be edited by users or administrators but can
144 144 be overridden in other configuration files. So far the directory only contains
145 145 merge tool configuration but packagers can also put other default configuration
146 146 there.
147 147
148 148 Syntax
149 149 ======
150 150
151 151 A configuration file consists of sections, led by a ``[section]`` header
152 152 and followed by ``name = value`` entries (sometimes called
153 153 ``configuration keys``)::
154 154
155 155 [spam]
156 156 eggs=ham
157 157 green=
158 158 eggs
159 159
160 160 Each line contains one entry. If the lines that follow are indented,
161 161 they are treated as continuations of that entry. Leading whitespace is
162 162 removed from values. Empty lines are skipped. Lines beginning with
163 163 ``#`` or ``;`` are ignored and may be used to provide comments.
164 164
165 165 Configuration keys can be set multiple times, in which case Mercurial
166 166 will use the value that was configured last. As an example::
167 167
168 168 [spam]
169 169 eggs=large
170 170 ham=serrano
171 171 eggs=small
172 172
173 173 This would set the configuration key named ``eggs`` to ``small``.
174 174
175 175 It is also possible to define a section multiple times. A section can
176 176 be redefined on the same and/or on different configuration files. For
177 177 example::
178 178
179 179 [foo]
180 180 eggs=large
181 181 ham=serrano
182 182 eggs=small
183 183
184 184 [bar]
185 185 eggs=ham
186 186 green=
187 187 eggs
188 188
189 189 [foo]
190 190 ham=prosciutto
191 191 eggs=medium
192 192 bread=toasted
193 193
194 194 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
195 195 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
196 196 respectively. As you can see there only thing that matters is the last
197 197 value that was set for each of the configuration keys.
198 198
199 199 If a configuration key is set multiple times in different
200 200 configuration files the final value will depend on the order in which
201 201 the different configuration files are read, with settings from earlier
202 202 paths overriding later ones as described on the ``Files`` section
203 203 above.
204 204
205 205 A line of the form ``%include file`` will include ``file`` into the
206 206 current configuration file. The inclusion is recursive, which means
207 207 that included files can include other files. Filenames are relative to
208 208 the configuration file in which the ``%include`` directive is found.
209 209 Environment variables and ``~user`` constructs are expanded in
210 210 ``file``. This lets you do something like::
211 211
212 212 %include ~/.hgrc.d/$HOST.rc
213 213
214 214 to include a different configuration file on each computer you use.
215 215
216 216 A line with ``%unset name`` will remove ``name`` from the current
217 217 section, if it has been set previously.
218 218
219 219 The values are either free-form text strings, lists of text strings,
220 220 or Boolean values. Boolean values can be set to true using any of "1",
221 221 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
222 222 (all case insensitive).
223 223
224 224 List values are separated by whitespace or comma, except when values are
225 225 placed in double quotation marks::
226 226
227 227 allow_read = "John Doe, PhD", brian, betty
228 228
229 229 Quotation marks can be escaped by prefixing them with a backslash. Only
230 230 quotation marks at the beginning of a word is counted as a quotation
231 231 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
232 232
233 233 Sections
234 234 ========
235 235
236 236 This section describes the different sections that may appear in a
237 237 Mercurial configuration file, the purpose of each section, its possible
238 238 keys, and their possible values.
239 239
240 240 ``alias``
241 241 ---------
242 242
243 243 Defines command aliases.
244 244
245 245 Aliases allow you to define your own commands in terms of other
246 246 commands (or aliases), optionally including arguments. Positional
247 247 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
248 248 are expanded by Mercurial before execution. Positional arguments not
249 249 already used by ``$N`` in the definition are put at the end of the
250 250 command to be executed.
251 251
252 252 Alias definitions consist of lines of the form::
253 253
254 254 <alias> = <command> [<argument>]...
255 255
256 256 For example, this definition::
257 257
258 258 latest = log --limit 5
259 259
260 260 creates a new command ``latest`` that shows only the five most recent
261 261 changesets. You can define subsequent aliases using earlier ones::
262 262
263 263 stable5 = latest -b stable
264 264
265 265 .. note::
266 266
267 267 It is possible to create aliases with the same names as
268 268 existing commands, which will then override the original
269 269 definitions. This is almost always a bad idea!
270 270
271 271 An alias can start with an exclamation point (``!``) to make it a
272 272 shell alias. A shell alias is executed with the shell and will let you
273 273 run arbitrary commands. As an example, ::
274 274
275 275 echo = !echo $@
276 276
277 277 will let you do ``hg echo foo`` to have ``foo`` printed in your
278 278 terminal. A better example might be::
279 279
280 280 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
281 281
282 282 which will make ``hg purge`` delete all unknown files in the
283 283 repository in the same manner as the purge extension.
284 284
285 285 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
286 286 expand to the command arguments. Unmatched arguments are
287 287 removed. ``$0`` expands to the alias name and ``$@`` expands to all
288 288 arguments separated by a space. ``"$@"`` (with quotes) expands to all
289 289 arguments quoted individually and separated by a space. These expansions
290 290 happen before the command is passed to the shell.
291 291
292 292 Shell aliases are executed in an environment where ``$HG`` expands to
293 293 the path of the Mercurial that was used to execute the alias. This is
294 294 useful when you want to call further Mercurial commands in a shell
295 295 alias, as was done above for the purge alias. In addition,
296 296 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
297 297 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
298 298
299 299 .. note::
300 300
301 301 Some global configuration options such as ``-R`` are
302 302 processed before shell aliases and will thus not be passed to
303 303 aliases.
304 304
305 305
306 306 ``annotate``
307 307 ------------
308 308
309 309 Settings used when displaying file annotations. All values are
310 310 Booleans and default to False. See :hg:`help config.diff` for
311 311 related options for the diff command.
312 312
313 313 ``ignorews``
314 314 Ignore white space when comparing lines.
315 315
316 316 ``ignorewsamount``
317 317 Ignore changes in the amount of white space.
318 318
319 319 ``ignoreblanklines``
320 320 Ignore changes whose lines are all blank.
321 321
322 322
323 323 ``auth``
324 324 --------
325 325
326 326 Authentication credentials and other authentication-like configuration
327 327 for HTTP connections. This section allows you to store usernames and
328 328 passwords for use when logging *into* HTTP servers. See
329 329 :hg:`help config.web` if you want to configure *who* can login to
330 330 your HTTP server.
331 331
332 332 The following options apply to all hosts.
333 333
334 334 ``cookiefile``
335 335 Path to a file containing HTTP cookie lines. Cookies matching a
336 336 host will be sent automatically.
337 337
338 338 The file format uses the Mozilla cookies.txt format, which defines cookies
339 339 on their own lines. Each line contains 7 fields delimited by the tab
340 340 character (domain, is_domain_cookie, path, is_secure, expires, name,
341 341 value). For more info, do an Internet search for "Netscape cookies.txt
342 342 format."
343 343
344 344 Note: the cookies parser does not handle port numbers on domains. You
345 345 will need to remove ports from the domain for the cookie to be recognized.
346 346 This could result in a cookie being disclosed to an unwanted server.
347 347
348 348 The cookies file is read-only.
349 349
350 350 Other options in this section are grouped by name and have the following
351 351 format::
352 352
353 353 <name>.<argument> = <value>
354 354
355 355 where ``<name>`` is used to group arguments into authentication
356 356 entries. Example::
357 357
358 358 foo.prefix = hg.intevation.de/mercurial
359 359 foo.username = foo
360 360 foo.password = bar
361 361 foo.schemes = http https
362 362
363 363 bar.prefix = secure.example.org
364 364 bar.key = path/to/file.key
365 365 bar.cert = path/to/file.cert
366 366 bar.schemes = https
367 367
368 368 Supported arguments:
369 369
370 370 ``prefix``
371 371 Either ``*`` or a URI prefix with or without the scheme part.
372 372 The authentication entry with the longest matching prefix is used
373 373 (where ``*`` matches everything and counts as a match of length
374 374 1). If the prefix doesn't include a scheme, the match is performed
375 375 against the URI with its scheme stripped as well, and the schemes
376 376 argument, q.v., is then subsequently consulted.
377 377
378 378 ``username``
379 379 Optional. Username to authenticate with. If not given, and the
380 380 remote site requires basic or digest authentication, the user will
381 381 be prompted for it. Environment variables are expanded in the
382 382 username letting you do ``foo.username = $USER``. If the URI
383 383 includes a username, only ``[auth]`` entries with a matching
384 384 username or without a username will be considered.
385 385
386 386 ``password``
387 387 Optional. Password to authenticate with. If not given, and the
388 388 remote site requires basic or digest authentication, the user
389 389 will be prompted for it.
390 390
391 391 ``key``
392 392 Optional. PEM encoded client certificate key file. Environment
393 393 variables are expanded in the filename.
394 394
395 395 ``cert``
396 396 Optional. PEM encoded client certificate chain file. Environment
397 397 variables are expanded in the filename.
398 398
399 399 ``schemes``
400 400 Optional. Space separated list of URI schemes to use this
401 401 authentication entry with. Only used if the prefix doesn't include
402 402 a scheme. Supported schemes are http and https. They will match
403 403 static-http and static-https respectively, as well.
404 404 (default: https)
405 405
406 406 If no suitable authentication entry is found, the user is prompted
407 407 for credentials as usual if required by the remote.
408 408
409 409 ``color``
410 410 ---------
411 411
412 412 Configure the Mercurial color mode. For details about how to define your custom
413 413 effect and style see :hg:`help color`.
414 414
415 415 ``mode``
416 416 String: control the method used to output color. One of ``auto``, ``ansi``,
417 417 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
418 418 use ANSI mode by default (or win32 mode on Windows) if it detects a
419 419 terminal. Any invalid value will disable color.
420 420
421 421 ``pagermode``
422 422 String: optinal override of ``color.mode`` used with pager.
423 423
424 424 On some systems, terminfo mode may cause problems when using
425 425 color with ``less -R`` as a pager program. less with the -R option
426 426 will only display ECMA-48 color codes, and terminfo mode may sometimes
427 427 emit codes that less doesn't understand. You can work around this by
428 428 either using ansi mode (or auto mode), or by using less -r (which will
429 429 pass through all terminal control codes, not just color control
430 430 codes).
431 431
432 432 On some systems (such as MSYS in Windows), the terminal may support
433 433 a different color mode than the pager program.
434 434
435 435 ``commands``
436 436 ------------
437 437
438 438 ``status.relative``
439 439 Make paths in :hg:`status` output relative to the current directory.
440 440 (default: False)
441 441
442 442 ``update.requiredest``
443 443 Require that the user pass a destination when running :hg:`update`.
444 444 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
445 445 will be disallowed.
446 446 (default: False)
447 447
448 448 ``committemplate``
449 449 ------------------
450 450
451 451 ``changeset``
452 452 String: configuration in this section is used as the template to
453 453 customize the text shown in the editor when committing.
454 454
455 455 In addition to pre-defined template keywords, commit log specific one
456 456 below can be used for customization:
457 457
458 458 ``extramsg``
459 459 String: Extra message (typically 'Leave message empty to abort
460 460 commit.'). This may be changed by some commands or extensions.
461 461
462 462 For example, the template configuration below shows as same text as
463 463 one shown by default::
464 464
465 465 [committemplate]
466 466 changeset = {desc}\n\n
467 467 HG: Enter commit message. Lines beginning with 'HG:' are removed.
468 468 HG: {extramsg}
469 469 HG: --
470 470 HG: user: {author}\n{ifeq(p2rev, "-1", "",
471 471 "HG: branch merge\n")
472 472 }HG: branch '{branch}'\n{if(activebookmark,
473 473 "HG: bookmark '{activebookmark}'\n") }{subrepos %
474 474 "HG: subrepo {subrepo}\n" }{file_adds %
475 475 "HG: added {file}\n" }{file_mods %
476 476 "HG: changed {file}\n" }{file_dels %
477 477 "HG: removed {file}\n" }{if(files, "",
478 478 "HG: no files changed\n")}
479 479
480 480 ``diff()``
481 481 String: show the diff (see :hg:`help templates` for detail)
482 482
483 483 Sometimes it is helpful to show the diff of the changeset in the editor without
484 484 having to prefix 'HG: ' to each line so that highlighting works correctly. For
485 485 this, Mercurial provides a special string which will ignore everything below
486 486 it::
487 487
488 488 HG: ------------------------ >8 ------------------------
489 489
490 490 For example, the template configuration below will show the diff below the
491 491 extra message::
492 492
493 493 [committemplate]
494 494 changeset = {desc}\n\n
495 495 HG: Enter commit message. Lines beginning with 'HG:' are removed.
496 496 HG: {extramsg}
497 497 HG: ------------------------ >8 ------------------------
498 498 HG: Do not touch the line above.
499 499 HG: Everything below will be removed.
500 500 {diff()}
501 501
502 502 .. note::
503 503
504 504 For some problematic encodings (see :hg:`help win32mbcs` for
505 505 detail), this customization should be configured carefully, to
506 506 avoid showing broken characters.
507 507
508 508 For example, if a multibyte character ending with backslash (0x5c) is
509 509 followed by the ASCII character 'n' in the customized template,
510 510 the sequence of backslash and 'n' is treated as line-feed unexpectedly
511 511 (and the multibyte character is broken, too).
512 512
513 513 Customized template is used for commands below (``--edit`` may be
514 514 required):
515 515
516 516 - :hg:`backout`
517 517 - :hg:`commit`
518 518 - :hg:`fetch` (for merge commit only)
519 519 - :hg:`graft`
520 520 - :hg:`histedit`
521 521 - :hg:`import`
522 522 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
523 523 - :hg:`rebase`
524 524 - :hg:`shelve`
525 525 - :hg:`sign`
526 526 - :hg:`tag`
527 527 - :hg:`transplant`
528 528
529 529 Configuring items below instead of ``changeset`` allows showing
530 530 customized message only for specific actions, or showing different
531 531 messages for each action.
532 532
533 533 - ``changeset.backout`` for :hg:`backout`
534 534 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
535 535 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
536 536 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
537 537 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
538 538 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
539 539 - ``changeset.gpg.sign`` for :hg:`sign`
540 540 - ``changeset.graft`` for :hg:`graft`
541 541 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
542 542 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
543 543 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
544 544 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
545 545 - ``changeset.import.bypass`` for :hg:`import --bypass`
546 546 - ``changeset.import.normal.merge`` for :hg:`import` on merges
547 547 - ``changeset.import.normal.normal`` for :hg:`import` on other
548 548 - ``changeset.mq.qnew`` for :hg:`qnew`
549 549 - ``changeset.mq.qfold`` for :hg:`qfold`
550 550 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
551 551 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
552 552 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
553 553 - ``changeset.rebase.normal`` for :hg:`rebase` on other
554 554 - ``changeset.shelve.shelve`` for :hg:`shelve`
555 555 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
556 556 - ``changeset.tag.remove`` for :hg:`tag --remove`
557 557 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
558 558 - ``changeset.transplant.normal`` for :hg:`transplant` on other
559 559
560 560 These dot-separated lists of names are treated as hierarchical ones.
561 561 For example, ``changeset.tag.remove`` customizes the commit message
562 562 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
563 563 commit message for :hg:`tag` regardless of ``--remove`` option.
564 564
565 565 When the external editor is invoked for a commit, the corresponding
566 566 dot-separated list of names without the ``changeset.`` prefix
567 567 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
568 568 variable.
569 569
570 570 In this section, items other than ``changeset`` can be referred from
571 571 others. For example, the configuration to list committed files up
572 572 below can be referred as ``{listupfiles}``::
573 573
574 574 [committemplate]
575 575 listupfiles = {file_adds %
576 576 "HG: added {file}\n" }{file_mods %
577 577 "HG: changed {file}\n" }{file_dels %
578 578 "HG: removed {file}\n" }{if(files, "",
579 579 "HG: no files changed\n")}
580 580
581 581 ``decode/encode``
582 582 -----------------
583 583
584 584 Filters for transforming files on checkout/checkin. This would
585 585 typically be used for newline processing or other
586 586 localization/canonicalization of files.
587 587
588 588 Filters consist of a filter pattern followed by a filter command.
589 589 Filter patterns are globs by default, rooted at the repository root.
590 590 For example, to match any file ending in ``.txt`` in the root
591 591 directory only, use the pattern ``*.txt``. To match any file ending
592 592 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
593 593 For each file only the first matching filter applies.
594 594
595 595 The filter command can start with a specifier, either ``pipe:`` or
596 596 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
597 597
598 598 A ``pipe:`` command must accept data on stdin and return the transformed
599 599 data on stdout.
600 600
601 601 Pipe example::
602 602
603 603 [encode]
604 604 # uncompress gzip files on checkin to improve delta compression
605 605 # note: not necessarily a good idea, just an example
606 606 *.gz = pipe: gunzip
607 607
608 608 [decode]
609 609 # recompress gzip files when writing them to the working dir (we
610 610 # can safely omit "pipe:", because it's the default)
611 611 *.gz = gzip
612 612
613 613 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
614 614 with the name of a temporary file that contains the data to be
615 615 filtered by the command. The string ``OUTFILE`` is replaced with the name
616 616 of an empty temporary file, where the filtered data must be written by
617 617 the command.
618 618
619 619 .. container:: windows
620 620
621 621 .. note::
622 622
623 623 The tempfile mechanism is recommended for Windows systems,
624 624 where the standard shell I/O redirection operators often have
625 625 strange effects and may corrupt the contents of your files.
626 626
627 627 This filter mechanism is used internally by the ``eol`` extension to
628 628 translate line ending characters between Windows (CRLF) and Unix (LF)
629 629 format. We suggest you use the ``eol`` extension for convenience.
630 630
631 631
632 632 ``defaults``
633 633 ------------
634 634
635 635 (defaults are deprecated. Don't use them. Use aliases instead.)
636 636
637 637 Use the ``[defaults]`` section to define command defaults, i.e. the
638 638 default options/arguments to pass to the specified commands.
639 639
640 640 The following example makes :hg:`log` run in verbose mode, and
641 641 :hg:`status` show only the modified files, by default::
642 642
643 643 [defaults]
644 644 log = -v
645 645 status = -m
646 646
647 647 The actual commands, instead of their aliases, must be used when
648 648 defining command defaults. The command defaults will also be applied
649 649 to the aliases of the commands defined.
650 650
651 651
652 652 ``diff``
653 653 --------
654 654
655 655 Settings used when displaying diffs. Everything except for ``unified``
656 656 is a Boolean and defaults to False. See :hg:`help config.annotate`
657 657 for related options for the annotate command.
658 658
659 659 ``git``
660 660 Use git extended diff format.
661 661
662 662 ``nobinary``
663 663 Omit git binary patches.
664 664
665 665 ``nodates``
666 666 Don't include dates in diff headers.
667 667
668 668 ``noprefix``
669 669 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
670 670
671 671 ``showfunc``
672 672 Show which function each change is in.
673 673
674 674 ``ignorews``
675 675 Ignore white space when comparing lines.
676 676
677 677 ``ignorewsamount``
678 678 Ignore changes in the amount of white space.
679 679
680 680 ``ignoreblanklines``
681 681 Ignore changes whose lines are all blank.
682 682
683 683 ``unified``
684 684 Number of lines of context to show.
685 685
686 686 ``email``
687 687 ---------
688 688
689 689 Settings for extensions that send email messages.
690 690
691 691 ``from``
692 692 Optional. Email address to use in "From" header and SMTP envelope
693 693 of outgoing messages.
694 694
695 695 ``to``
696 696 Optional. Comma-separated list of recipients' email addresses.
697 697
698 698 ``cc``
699 699 Optional. Comma-separated list of carbon copy recipients'
700 700 email addresses.
701 701
702 702 ``bcc``
703 703 Optional. Comma-separated list of blind carbon copy recipients'
704 704 email addresses.
705 705
706 706 ``method``
707 707 Optional. Method to use to send email messages. If value is ``smtp``
708 708 (default), use SMTP (see the ``[smtp]`` section for configuration).
709 709 Otherwise, use as name of program to run that acts like sendmail
710 710 (takes ``-f`` option for sender, list of recipients on command line,
711 711 message on stdin). Normally, setting this to ``sendmail`` or
712 712 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
713 713
714 714 ``charsets``
715 715 Optional. Comma-separated list of character sets considered
716 716 convenient for recipients. Addresses, headers, and parts not
717 717 containing patches of outgoing messages will be encoded in the
718 718 first character set to which conversion from local encoding
719 719 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
720 720 conversion fails, the text in question is sent as is.
721 721 (default: '')
722 722
723 723 Order of outgoing email character sets:
724 724
725 725 1. ``us-ascii``: always first, regardless of settings
726 726 2. ``email.charsets``: in order given by user
727 727 3. ``ui.fallbackencoding``: if not in email.charsets
728 728 4. ``$HGENCODING``: if not in email.charsets
729 729 5. ``utf-8``: always last, regardless of settings
730 730
731 731 Email example::
732 732
733 733 [email]
734 734 from = Joseph User <joe.user@example.com>
735 735 method = /usr/sbin/sendmail
736 736 # charsets for western Europeans
737 737 # us-ascii, utf-8 omitted, as they are tried first and last
738 738 charsets = iso-8859-1, iso-8859-15, windows-1252
739 739
740 740
741 741 ``extensions``
742 742 --------------
743 743
744 744 Mercurial has an extension mechanism for adding new features. To
745 745 enable an extension, create an entry for it in this section.
746 746
747 747 If you know that the extension is already in Python's search path,
748 748 you can give the name of the module, followed by ``=``, with nothing
749 749 after the ``=``.
750 750
751 751 Otherwise, give a name that you choose, followed by ``=``, followed by
752 752 the path to the ``.py`` file (including the file name extension) that
753 753 defines the extension.
754 754
755 755 To explicitly disable an extension that is enabled in an hgrc of
756 756 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
757 757 or ``foo = !`` when path is not supplied.
758 758
759 759 Example for ``~/.hgrc``::
760 760
761 761 [extensions]
762 762 # (the churn extension will get loaded from Mercurial's path)
763 763 churn =
764 764 # (this extension will get loaded from the file specified)
765 765 myfeature = ~/.hgext/myfeature.py
766 766
767 767
768 768 ``format``
769 769 ----------
770 770
771 771 ``usegeneraldelta``
772 772 Enable or disable the "generaldelta" repository format which improves
773 773 repository compression by allowing "revlog" to store delta against arbitrary
774 774 revision instead of the previous stored one. This provides significant
775 775 improvement for repositories with branches.
776 776
777 777 Repositories with this on-disk format require Mercurial version 1.9.
778 778
779 779 Enabled by default.
780 780
781 781 ``dotencode``
782 782 Enable or disable the "dotencode" repository format which enhances
783 783 the "fncache" repository format (which has to be enabled to use
784 784 dotencode) to avoid issues with filenames starting with ._ on
785 785 Mac OS X and spaces on Windows.
786 786
787 787 Repositories with this on-disk format require Mercurial version 1.7.
788 788
789 789 Enabled by default.
790 790
791 791 ``usefncache``
792 792 Enable or disable the "fncache" repository format which enhances
793 793 the "store" repository format (which has to be enabled to use
794 794 fncache) to allow longer filenames and avoids using Windows
795 795 reserved names, e.g. "nul".
796 796
797 797 Repositories with this on-disk format require Mercurial version 1.1.
798 798
799 799 Enabled by default.
800 800
801 801 ``usestore``
802 802 Enable or disable the "store" repository format which improves
803 803 compatibility with systems that fold case or otherwise mangle
804 804 filenames. Disabling this option will allow you to store longer filenames
805 805 in some situations at the expense of compatibility.
806 806
807 807 Repositories with this on-disk format require Mercurial version 0.9.4.
808 808
809 809 Enabled by default.
810 810
811 811 ``graph``
812 812 ---------
813 813
814 814 Web graph view configuration. This section let you change graph
815 815 elements display properties by branches, for instance to make the
816 816 ``default`` branch stand out.
817 817
818 818 Each line has the following format::
819 819
820 820 <branch>.<argument> = <value>
821 821
822 822 where ``<branch>`` is the name of the branch being
823 823 customized. Example::
824 824
825 825 [graph]
826 826 # 2px width
827 827 default.width = 2
828 828 # red color
829 829 default.color = FF0000
830 830
831 831 Supported arguments:
832 832
833 833 ``width``
834 834 Set branch edges width in pixels.
835 835
836 836 ``color``
837 837 Set branch edges color in hexadecimal RGB notation.
838 838
839 839 ``hooks``
840 840 ---------
841 841
842 842 Commands or Python functions that get automatically executed by
843 843 various actions such as starting or finishing a commit. Multiple
844 844 hooks can be run for the same action by appending a suffix to the
845 845 action. Overriding a site-wide hook can be done by changing its
846 846 value or setting it to an empty string. Hooks can be prioritized
847 847 by adding a prefix of ``priority.`` to the hook name on a new line
848 848 and setting the priority. The default priority is 0.
849 849
850 850 Example ``.hg/hgrc``::
851 851
852 852 [hooks]
853 853 # update working directory after adding changesets
854 854 changegroup.update = hg update
855 855 # do not use the site-wide hook
856 856 incoming =
857 857 incoming.email = /my/email/hook
858 858 incoming.autobuild = /my/build/hook
859 859 # force autobuild hook to run before other incoming hooks
860 860 priority.incoming.autobuild = 1
861 861
862 862 Most hooks are run with environment variables set that give useful
863 863 additional information. For each hook below, the environment variables
864 864 it is passed are listed with names of the form ``$HG_foo``. The
865 865 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
866 866 their respectively contains the type of hook which triggered the run and
867 867 the full name of the hooks in the config. In the example about this will
868 868 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
869 869
870 870 ``changegroup``
871 871 Run after a changegroup has been added via push, pull or unbundle. ID of the
872 872 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
873 873 from which changes came is in ``$HG_URL``.
874 874
875 875 ``commit``
876 876 Run after a changeset has been created in the local repository. ID
877 877 of the newly created changeset is in ``$HG_NODE``. Parent changeset
878 878 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
879 879
880 880 ``incoming``
881 881 Run after a changeset has been pulled, pushed, or unbundled into
882 882 the local repository. The ID of the newly arrived changeset is in
883 883 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
884 884
885 885 ``outgoing``
886 886 Run after sending changes from local repository to another. ID of
887 887 first changeset sent is in ``$HG_NODE``. Source of operation is in
888 888 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
889 889
890 890 ``post-<command>``
891 891 Run after successful invocations of the associated command. The
892 892 contents of the command line are passed as ``$HG_ARGS`` and the result
893 893 code in ``$HG_RESULT``. Parsed command line arguments are passed as
894 894 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
895 895 the python data internally passed to <command>. ``$HG_OPTS`` is a
896 896 dictionary of options (with unspecified options set to their defaults).
897 897 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
898 898
899 899 ``fail-<command>``
900 900 Run after a failed invocation of an associated command. The contents
901 901 of the command line are passed as ``$HG_ARGS``. Parsed command line
902 902 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
903 903 string representations of the python data internally passed to
904 904 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
905 905 options set to their defaults). ``$HG_PATS`` is a list of arguments.
906 906 Hook failure is ignored.
907 907
908 908 ``pre-<command>``
909 909 Run before executing the associated command. The contents of the
910 910 command line are passed as ``$HG_ARGS``. Parsed command line arguments
911 911 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
912 912 representations of the data internally passed to <command>. ``$HG_OPTS``
913 913 is a dictionary of options (with unspecified options set to their
914 914 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
915 915 failure, the command doesn't execute and Mercurial returns the failure
916 916 code.
917 917
918 918 ``prechangegroup``
919 919 Run before a changegroup is added via push, pull or unbundle. Exit
920 920 status 0 allows the changegroup to proceed. Non-zero status will
921 921 cause the push, pull or unbundle to fail. URL from which changes
922 922 will come is in ``$HG_URL``.
923 923
924 924 ``precommit``
925 925 Run before starting a local commit. Exit status 0 allows the
926 926 commit to proceed. Non-zero status will cause the commit to fail.
927 927 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
928 928
929 929 ``prelistkeys``
930 930 Run before listing pushkeys (like bookmarks) in the
931 931 repository. Non-zero status will cause failure. The key namespace is
932 932 in ``$HG_NAMESPACE``.
933 933
934 934 ``preoutgoing``
935 935 Run before collecting changes to send from the local repository to
936 936 another. Non-zero status will cause failure. This lets you prevent
937 937 pull over HTTP or SSH. Also prevents against local pull, push
938 938 (outbound) or bundle commands, but not effective, since you can
939 939 just copy files instead then. Source of operation is in
940 940 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
941 941 SSH or HTTP repository. If "push", "pull" or "bundle", operation
942 942 is happening on behalf of repository on same system.
943 943
944 944 ``prepushkey``
945 945 Run before a pushkey (like a bookmark) is added to the
946 946 repository. Non-zero status will cause the key to be rejected. The
947 947 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
948 948 the old value (if any) is in ``$HG_OLD``, and the new value is in
949 949 ``$HG_NEW``.
950 950
951 951 ``pretag``
952 952 Run before creating a tag. Exit status 0 allows the tag to be
953 953 created. Non-zero status will cause the tag to fail. ID of
954 954 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
955 955 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
956 956
957 957 ``pretxnopen``
958 958 Run before any new repository transaction is open. The reason for the
959 959 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
960 960 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
961 961 transaction from being opened.
962 962
963 963 ``pretxnclose``
964 964 Run right before the transaction is actually finalized. Any repository change
965 965 will be visible to the hook program. This lets you validate the transaction
966 966 content or change it. Exit status 0 allows the commit to proceed. Non-zero
967 967 status will cause the transaction to be rolled back. The reason for the
968 968 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
969 969 the transaction will be in ``HG_TXNID``. The rest of the available data will
970 970 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
971 971 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
972 972 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
973 973 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
974 974
975 975 ``txnclose``
976 976 Run after any repository transaction has been committed. At this
977 977 point, the transaction can no longer be rolled back. The hook will run
978 978 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
979 979 details about available variables.
980 980
981 981 ``txnabort``
982 982 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
983 983 docs for details about available variables.
984 984
985 985 ``pretxnchangegroup``
986 986 Run after a changegroup has been added via push, pull or unbundle, but before
987 987 the transaction has been committed. Changegroup is visible to hook program.
988 988 This lets you validate incoming changes before accepting them. Passed the ID
989 989 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
990 990 Exit status 0 allows the transaction to commit. Non-zero status will cause
991 991 the transaction to be rolled back and the push, pull or unbundle will fail.
992 992 URL that was source of changes is in ``$HG_URL``.
993 993
994 994 ``pretxncommit``
995 995 Run after a changeset has been created but the transaction not yet
996 996 committed. Changeset is visible to hook program. This lets you
997 997 validate commit message and changes. Exit status 0 allows the
998 998 commit to proceed. Non-zero status will cause the transaction to
999 999 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
1000 1000 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1001 1001
1002 1002 ``preupdate``
1003 1003 Run before updating the working directory. Exit status 0 allows
1004 1004 the update to proceed. Non-zero status will prevent the update.
1005 1005 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
1006 1006 of second new parent is in ``$HG_PARENT2``.
1007 1007
1008 1008 ``listkeys``
1009 1009 Run after listing pushkeys (like bookmarks) in the repository. The
1010 1010 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1011 1011 dictionary containing the keys and values.
1012 1012
1013 1013 ``pushkey``
1014 1014 Run after a pushkey (like a bookmark) is added to the
1015 1015 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1016 1016 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1017 1017 value is in ``$HG_NEW``.
1018 1018
1019 1019 ``tag``
1020 1020 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
1021 1021 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
1022 1022 repository if ``$HG_LOCAL=0``.
1023 1023
1024 1024 ``update``
1025 1025 Run after updating the working directory. Changeset ID of first
1026 1026 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
1027 1027 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1028 1028 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
1029 1029
1030 1030 .. note::
1031 1031
1032 1032 It is generally better to use standard hooks rather than the
1033 1033 generic pre- and post- command hooks as they are guaranteed to be
1034 1034 called in the appropriate contexts for influencing transactions.
1035 1035 Also, hooks like "commit" will be called in all contexts that
1036 1036 generate a commit (e.g. tag) and not just the commit command.
1037 1037
1038 1038 .. note::
1039 1039
1040 1040 Environment variables with empty values may not be passed to
1041 1041 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1042 1042 will have an empty value under Unix-like platforms for non-merge
1043 1043 changesets, while it will not be available at all under Windows.
1044 1044
1045 1045 The syntax for Python hooks is as follows::
1046 1046
1047 1047 hookname = python:modulename.submodule.callable
1048 1048 hookname = python:/path/to/python/module.py:callable
1049 1049
1050 1050 Python hooks are run within the Mercurial process. Each hook is
1051 1051 called with at least three keyword arguments: a ui object (keyword
1052 1052 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1053 1053 keyword that tells what kind of hook is used. Arguments listed as
1054 1054 environment variables above are passed as keyword arguments, with no
1055 1055 ``HG_`` prefix, and names in lower case.
1056 1056
1057 1057 If a Python hook returns a "true" value or raises an exception, this
1058 1058 is treated as a failure.
1059 1059
1060 1060
1061 1061 ``hostfingerprints``
1062 1062 --------------------
1063 1063
1064 1064 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1065 1065
1066 1066 Fingerprints of the certificates of known HTTPS servers.
1067 1067
1068 1068 A HTTPS connection to a server with a fingerprint configured here will
1069 1069 only succeed if the servers certificate matches the fingerprint.
1070 1070 This is very similar to how ssh known hosts works.
1071 1071
1072 1072 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1073 1073 Multiple values can be specified (separated by spaces or commas). This can
1074 1074 be used to define both old and new fingerprints while a host transitions
1075 1075 to a new certificate.
1076 1076
1077 1077 The CA chain and web.cacerts is not used for servers with a fingerprint.
1078 1078
1079 1079 For example::
1080 1080
1081 1081 [hostfingerprints]
1082 1082 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1083 1083 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1084 1084
1085 1085 ``hostsecurity``
1086 1086 ----------------
1087 1087
1088 1088 Used to specify global and per-host security settings for connecting to
1089 1089 other machines.
1090 1090
1091 1091 The following options control default behavior for all hosts.
1092 1092
1093 1093 ``ciphers``
1094 1094 Defines the cryptographic ciphers to use for connections.
1095 1095
1096 1096 Value must be a valid OpenSSL Cipher List Format as documented at
1097 1097 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1098 1098
1099 1099 This setting is for advanced users only. Setting to incorrect values
1100 1100 can significantly lower connection security or decrease performance.
1101 1101 You have been warned.
1102 1102
1103 1103 This option requires Python 2.7.
1104 1104
1105 1105 ``minimumprotocol``
1106 1106 Defines the minimum channel encryption protocol to use.
1107 1107
1108 1108 By default, the highest version of TLS supported by both client and server
1109 1109 is used.
1110 1110
1111 1111 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1112 1112
1113 1113 When running on an old Python version, only ``tls1.0`` is allowed since
1114 1114 old versions of Python only support up to TLS 1.0.
1115 1115
1116 1116 When running a Python that supports modern TLS versions, the default is
1117 1117 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1118 1118 weakens security and should only be used as a feature of last resort if
1119 1119 a server does not support TLS 1.1+.
1120 1120
1121 1121 Options in the ``[hostsecurity]`` section can have the form
1122 1122 ``hostname``:``setting``. This allows multiple settings to be defined on a
1123 1123 per-host basis.
1124 1124
1125 1125 The following per-host settings can be defined.
1126 1126
1127 1127 ``ciphers``
1128 1128 This behaves like ``ciphers`` as described above except it only applies
1129 1129 to the host on which it is defined.
1130 1130
1131 1131 ``fingerprints``
1132 1132 A list of hashes of the DER encoded peer/remote certificate. Values have
1133 1133 the form ``algorithm``:``fingerprint``. e.g.
1134 1134 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1135 1135
1136 1136 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1137 1137 ``sha512``.
1138 1138
1139 1139 Use of ``sha256`` or ``sha512`` is preferred.
1140 1140
1141 1141 If a fingerprint is specified, the CA chain is not validated for this
1142 1142 host and Mercurial will require the remote certificate to match one
1143 1143 of the fingerprints specified. This means if the server updates its
1144 1144 certificate, Mercurial will abort until a new fingerprint is defined.
1145 1145 This can provide stronger security than traditional CA-based validation
1146 1146 at the expense of convenience.
1147 1147
1148 1148 This option takes precedence over ``verifycertsfile``.
1149 1149
1150 1150 ``minimumprotocol``
1151 1151 This behaves like ``minimumprotocol`` as described above except it
1152 1152 only applies to the host on which it is defined.
1153 1153
1154 1154 ``verifycertsfile``
1155 1155 Path to file a containing a list of PEM encoded certificates used to
1156 1156 verify the server certificate. Environment variables and ``~user``
1157 1157 constructs are expanded in the filename.
1158 1158
1159 1159 The server certificate or the certificate's certificate authority (CA)
1160 1160 must match a certificate from this file or certificate verification
1161 1161 will fail and connections to the server will be refused.
1162 1162
1163 1163 If defined, only certificates provided by this file will be used:
1164 1164 ``web.cacerts`` and any system/default certificates will not be
1165 1165 used.
1166 1166
1167 1167 This option has no effect if the per-host ``fingerprints`` option
1168 1168 is set.
1169 1169
1170 1170 The format of the file is as follows::
1171 1171
1172 1172 -----BEGIN CERTIFICATE-----
1173 1173 ... (certificate in base64 PEM encoding) ...
1174 1174 -----END CERTIFICATE-----
1175 1175 -----BEGIN CERTIFICATE-----
1176 1176 ... (certificate in base64 PEM encoding) ...
1177 1177 -----END CERTIFICATE-----
1178 1178
1179 1179 For example::
1180 1180
1181 1181 [hostsecurity]
1182 1182 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1183 1183 hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1184 1184 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1185 1185
1186 1186 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1187 1187 when connecting to ``hg.example.com``::
1188 1188
1189 1189 [hostsecurity]
1190 1190 minimumprotocol = tls1.2
1191 1191 hg.example.com:minimumprotocol = tls1.1
1192 1192
1193 1193 ``http_proxy``
1194 1194 --------------
1195 1195
1196 1196 Used to access web-based Mercurial repositories through a HTTP
1197 1197 proxy.
1198 1198
1199 1199 ``host``
1200 1200 Host name and (optional) port of the proxy server, for example
1201 1201 "myproxy:8000".
1202 1202
1203 1203 ``no``
1204 1204 Optional. Comma-separated list of host names that should bypass
1205 1205 the proxy.
1206 1206
1207 1207 ``passwd``
1208 1208 Optional. Password to authenticate with at the proxy server.
1209 1209
1210 1210 ``user``
1211 1211 Optional. User name to authenticate with at the proxy server.
1212 1212
1213 1213 ``always``
1214 1214 Optional. Always use the proxy, even for localhost and any entries
1215 1215 in ``http_proxy.no``. (default: False)
1216 1216
1217 1217 ``merge``
1218 1218 ---------
1219 1219
1220 1220 This section specifies behavior during merges and updates.
1221 1221
1222 1222 ``checkignored``
1223 1223 Controls behavior when an ignored file on disk has the same name as a tracked
1224 1224 file in the changeset being merged or updated to, and has different
1225 1225 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1226 1226 abort on such files. With ``warn``, warn on such files and back them up as
1227 1227 ``.orig``. With ``ignore``, don't print a warning and back them up as
1228 1228 ``.orig``. (default: ``abort``)
1229 1229
1230 1230 ``checkunknown``
1231 1231 Controls behavior when an unknown file that isn't ignored has the same name
1232 1232 as a tracked file in the changeset being merged or updated to, and has
1233 1233 different contents. Similar to ``merge.checkignored``, except for files that
1234 1234 are not ignored. (default: ``abort``)
1235 1235
1236 1236 ``merge-patterns``
1237 1237 ------------------
1238 1238
1239 1239 This section specifies merge tools to associate with particular file
1240 1240 patterns. Tools matched here will take precedence over the default
1241 1241 merge tool. Patterns are globs by default, rooted at the repository
1242 1242 root.
1243 1243
1244 1244 Example::
1245 1245
1246 1246 [merge-patterns]
1247 1247 **.c = kdiff3
1248 1248 **.jpg = myimgmerge
1249 1249
1250 1250 ``merge-tools``
1251 1251 ---------------
1252 1252
1253 1253 This section configures external merge tools to use for file-level
1254 1254 merges. This section has likely been preconfigured at install time.
1255 1255 Use :hg:`config merge-tools` to check the existing configuration.
1256 1256 Also see :hg:`help merge-tools` for more details.
1257 1257
1258 1258 Example ``~/.hgrc``::
1259 1259
1260 1260 [merge-tools]
1261 1261 # Override stock tool location
1262 1262 kdiff3.executable = ~/bin/kdiff3
1263 1263 # Specify command line
1264 1264 kdiff3.args = $base $local $other -o $output
1265 1265 # Give higher priority
1266 1266 kdiff3.priority = 1
1267 1267
1268 1268 # Changing the priority of preconfigured tool
1269 1269 meld.priority = 0
1270 1270
1271 1271 # Disable a preconfigured tool
1272 1272 vimdiff.disabled = yes
1273 1273
1274 1274 # Define new tool
1275 1275 myHtmlTool.args = -m $local $other $base $output
1276 1276 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1277 1277 myHtmlTool.priority = 1
1278 1278
1279 1279 Supported arguments:
1280 1280
1281 1281 ``priority``
1282 1282 The priority in which to evaluate this tool.
1283 1283 (default: 0)
1284 1284
1285 1285 ``executable``
1286 1286 Either just the name of the executable or its pathname.
1287 1287
1288 1288 .. container:: windows
1289 1289
1290 1290 On Windows, the path can use environment variables with ${ProgramFiles}
1291 1291 syntax.
1292 1292
1293 1293 (default: the tool name)
1294 1294
1295 1295 ``args``
1296 1296 The arguments to pass to the tool executable. You can refer to the
1297 1297 files being merged as well as the output file through these
1298 1298 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1299 1299 of ``$local`` and ``$other`` can vary depending on which action is being
1300 1300 performed. During and update or merge, ``$local`` represents the original
1301 1301 state of the file, while ``$other`` represents the commit you are updating
1302 1302 to or the commit you are merging with. During a rebase ``$local``
1303 1303 represents the destination of the rebase, and ``$other`` represents the
1304 1304 commit being rebased.
1305 1305 (default: ``$local $base $other``)
1306 1306
1307 1307 ``premerge``
1308 1308 Attempt to run internal non-interactive 3-way merge tool before
1309 1309 launching external tool. Options are ``true``, ``false``, ``keep`` or
1310 1310 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1311 1311 premerge fails. The ``keep-merge3`` will do the same but include information
1312 1312 about the base of the merge in the marker (see internal :merge3 in
1313 1313 :hg:`help merge-tools`).
1314 1314 (default: True)
1315 1315
1316 1316 ``binary``
1317 1317 This tool can merge binary files. (default: False, unless tool
1318 1318 was selected by file pattern match)
1319 1319
1320 1320 ``symlink``
1321 1321 This tool can merge symlinks. (default: False)
1322 1322
1323 1323 ``check``
1324 1324 A list of merge success-checking options:
1325 1325
1326 1326 ``changed``
1327 1327 Ask whether merge was successful when the merged file shows no changes.
1328 1328 ``conflicts``
1329 1329 Check whether there are conflicts even though the tool reported success.
1330 1330 ``prompt``
1331 1331 Always prompt for merge success, regardless of success reported by tool.
1332 1332
1333 1333 ``fixeol``
1334 1334 Attempt to fix up EOL changes caused by the merge tool.
1335 1335 (default: False)
1336 1336
1337 1337 ``gui``
1338 1338 This tool requires a graphical interface to run. (default: False)
1339 1339
1340 1340 .. container:: windows
1341 1341
1342 1342 ``regkey``
1343 1343 Windows registry key which describes install location of this
1344 1344 tool. Mercurial will search for this key first under
1345 1345 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1346 1346 (default: None)
1347 1347
1348 1348 ``regkeyalt``
1349 1349 An alternate Windows registry key to try if the first key is not
1350 1350 found. The alternate key uses the same ``regname`` and ``regappend``
1351 1351 semantics of the primary key. The most common use for this key
1352 1352 is to search for 32bit applications on 64bit operating systems.
1353 1353 (default: None)
1354 1354
1355 1355 ``regname``
1356 1356 Name of value to read from specified registry key.
1357 1357 (default: the unnamed (default) value)
1358 1358
1359 1359 ``regappend``
1360 1360 String to append to the value read from the registry, typically
1361 1361 the executable name of the tool.
1362 1362 (default: None)
1363 1363
1364 1364 ``pager``
1365 1365 ---------
1366 1366
1367 1367 Setting used to control when to paginate and with what external tool. See
1368 1368 :hg:`help pager` for details.
1369 1369
1370 1370 ``enable``
1371 1371 Control the pagination of command output (default: True).
1372 1372
1373 1373 ``pager``
1374 1374 Define the external tool used as pager.
1375 1375
1376 1376 If no pager is set, Mercurial uses the environment variable $PAGER.
1377 1377 If neither pager.pager, nor $PAGER is set, a default pager will be
1378 1378 used, typically `less` on Unix and `more` on Windows. Example::
1379 1379
1380 1380 [pager]
1381 1381 pager = less -FRX
1382 1382
1383 1383 ``ignore``
1384 1384 List of commands to disable the pager for. Example::
1385 1385
1386 1386 [pager]
1387 1387 ignore = version, help, update
1388 1388
1389 1389 ``patch``
1390 1390 ---------
1391 1391
1392 1392 Settings used when applying patches, for instance through the 'import'
1393 1393 command or with Mercurial Queues extension.
1394 1394
1395 1395 ``eol``
1396 1396 When set to 'strict' patch content and patched files end of lines
1397 1397 are preserved. When set to ``lf`` or ``crlf``, both files end of
1398 1398 lines are ignored when patching and the result line endings are
1399 1399 normalized to either LF (Unix) or CRLF (Windows). When set to
1400 1400 ``auto``, end of lines are again ignored while patching but line
1401 1401 endings in patched files are normalized to their original setting
1402 1402 on a per-file basis. If target file does not exist or has no end
1403 1403 of line, patch line endings are preserved.
1404 1404 (default: strict)
1405 1405
1406 1406 ``fuzz``
1407 1407 The number of lines of 'fuzz' to allow when applying patches. This
1408 1408 controls how much context the patcher is allowed to ignore when
1409 1409 trying to apply a patch.
1410 1410 (default: 2)
1411 1411
1412 1412 ``paths``
1413 1413 ---------
1414 1414
1415 1415 Assigns symbolic names and behavior to repositories.
1416 1416
1417 1417 Options are symbolic names defining the URL or directory that is the
1418 1418 location of the repository. Example::
1419 1419
1420 1420 [paths]
1421 1421 my_server = https://example.com/my_repo
1422 1422 local_path = /home/me/repo
1423 1423
1424 1424 These symbolic names can be used from the command line. To pull
1425 1425 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1426 1426 :hg:`push local_path`.
1427 1427
1428 1428 Options containing colons (``:``) denote sub-options that can influence
1429 1429 behavior for that specific path. Example::
1430 1430
1431 1431 [paths]
1432 1432 my_server = https://example.com/my_path
1433 1433 my_server:pushurl = ssh://example.com/my_path
1434 1434
1435 1435 The following sub-options can be defined:
1436 1436
1437 1437 ``pushurl``
1438 1438 The URL to use for push operations. If not defined, the location
1439 1439 defined by the path's main entry is used.
1440 1440
1441 1441 ``pushrev``
1442 1442 A revset defining which revisions to push by default.
1443 1443
1444 1444 When :hg:`push` is executed without a ``-r`` argument, the revset
1445 1445 defined by this sub-option is evaluated to determine what to push.
1446 1446
1447 1447 For example, a value of ``.`` will push the working directory's
1448 1448 revision by default.
1449 1449
1450 1450 Revsets specifying bookmarks will not result in the bookmark being
1451 1451 pushed.
1452 1452
1453 1453 The following special named paths exist:
1454 1454
1455 1455 ``default``
1456 1456 The URL or directory to use when no source or remote is specified.
1457 1457
1458 1458 :hg:`clone` will automatically define this path to the location the
1459 1459 repository was cloned from.
1460 1460
1461 1461 ``default-push``
1462 1462 (deprecated) The URL or directory for the default :hg:`push` location.
1463 1463 ``default:pushurl`` should be used instead.
1464 1464
1465 1465 ``phases``
1466 1466 ----------
1467 1467
1468 1468 Specifies default handling of phases. See :hg:`help phases` for more
1469 1469 information about working with phases.
1470 1470
1471 1471 ``publish``
1472 1472 Controls draft phase behavior when working as a server. When true,
1473 1473 pushed changesets are set to public in both client and server and
1474 1474 pulled or cloned changesets are set to public in the client.
1475 1475 (default: True)
1476 1476
1477 1477 ``new-commit``
1478 1478 Phase of newly-created commits.
1479 1479 (default: draft)
1480 1480
1481 1481 ``checksubrepos``
1482 1482 Check the phase of the current revision of each subrepository. Allowed
1483 1483 values are "ignore", "follow" and "abort". For settings other than
1484 1484 "ignore", the phase of the current revision of each subrepository is
1485 1485 checked before committing the parent repository. If any of those phases is
1486 1486 greater than the phase of the parent repository (e.g. if a subrepo is in a
1487 1487 "secret" phase while the parent repo is in "draft" phase), the commit is
1488 1488 either aborted (if checksubrepos is set to "abort") or the higher phase is
1489 1489 used for the parent repository commit (if set to "follow").
1490 1490 (default: follow)
1491 1491
1492 1492
1493 1493 ``profiling``
1494 1494 -------------
1495 1495
1496 1496 Specifies profiling type, format, and file output. Two profilers are
1497 1497 supported: an instrumenting profiler (named ``ls``), and a sampling
1498 1498 profiler (named ``stat``).
1499 1499
1500 1500 In this section description, 'profiling data' stands for the raw data
1501 1501 collected during profiling, while 'profiling report' stands for a
1502 1502 statistical text report generated from the profiling data. The
1503 1503 profiling is done using lsprof.
1504 1504
1505 1505 ``enabled``
1506 1506 Enable the profiler.
1507 1507 (default: false)
1508 1508
1509 1509 This is equivalent to passing ``--profile`` on the command line.
1510 1510
1511 1511 ``type``
1512 1512 The type of profiler to use.
1513 1513 (default: stat)
1514 1514
1515 1515 ``ls``
1516 1516 Use Python's built-in instrumenting profiler. This profiler
1517 1517 works on all platforms, but each line number it reports is the
1518 1518 first line of a function. This restriction makes it difficult to
1519 1519 identify the expensive parts of a non-trivial function.
1520 1520 ``stat``
1521 1521 Use a statistical profiler, statprof. This profiler is most
1522 1522 useful for profiling commands that run for longer than about 0.1
1523 1523 seconds.
1524 1524
1525 1525 ``format``
1526 1526 Profiling format. Specific to the ``ls`` instrumenting profiler.
1527 1527 (default: text)
1528 1528
1529 1529 ``text``
1530 1530 Generate a profiling report. When saving to a file, it should be
1531 1531 noted that only the report is saved, and the profiling data is
1532 1532 not kept.
1533 1533 ``kcachegrind``
1534 1534 Format profiling data for kcachegrind use: when saving to a
1535 1535 file, the generated file can directly be loaded into
1536 1536 kcachegrind.
1537 1537
1538 1538 ``statformat``
1539 1539 Profiling format for the ``stat`` profiler.
1540 1540 (default: hotpath)
1541 1541
1542 1542 ``hotpath``
1543 1543 Show a tree-based display containing the hot path of execution (where
1544 1544 most time was spent).
1545 1545 ``bymethod``
1546 1546 Show a table of methods ordered by how frequently they are active.
1547 1547 ``byline``
1548 1548 Show a table of lines in files ordered by how frequently they are active.
1549 1549 ``json``
1550 1550 Render profiling data as JSON.
1551 1551
1552 1552 ``frequency``
1553 1553 Sampling frequency. Specific to the ``stat`` sampling profiler.
1554 1554 (default: 1000)
1555 1555
1556 1556 ``output``
1557 1557 File path where profiling data or report should be saved. If the
1558 1558 file exists, it is replaced. (default: None, data is printed on
1559 1559 stderr)
1560 1560
1561 1561 ``sort``
1562 1562 Sort field. Specific to the ``ls`` instrumenting profiler.
1563 1563 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1564 1564 ``inlinetime``.
1565 1565 (default: inlinetime)
1566 1566
1567 1567 ``limit``
1568 1568 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1569 1569 (default: 30)
1570 1570
1571 1571 ``nested``
1572 1572 Show at most this number of lines of drill-down info after each main entry.
1573 1573 This can help explain the difference between Total and Inline.
1574 1574 Specific to the ``ls`` instrumenting profiler.
1575 1575 (default: 5)
1576 1576
1577 1577 ``progress``
1578 1578 ------------
1579 1579
1580 1580 Mercurial commands can draw progress bars that are as informative as
1581 1581 possible. Some progress bars only offer indeterminate information, while others
1582 1582 have a definite end point.
1583 1583
1584 1584 ``delay``
1585 1585 Number of seconds (float) before showing the progress bar. (default: 3)
1586 1586
1587 1587 ``changedelay``
1588 1588 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1589 1589 that value will be used instead. (default: 1)
1590 1590
1591 1591 ``refresh``
1592 1592 Time in seconds between refreshes of the progress bar. (default: 0.1)
1593 1593
1594 1594 ``format``
1595 1595 Format of the progress bar.
1596 1596
1597 1597 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1598 1598 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1599 1599 last 20 characters of the item, but this can be changed by adding either
1600 1600 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1601 1601 first num characters.
1602 1602
1603 1603 (default: topic bar number estimate)
1604 1604
1605 1605 ``width``
1606 1606 If set, the maximum width of the progress information (that is, min(width,
1607 1607 term width) will be used).
1608 1608
1609 1609 ``clear-complete``
1610 1610 Clear the progress bar after it's done. (default: True)
1611 1611
1612 1612 ``disable``
1613 1613 If true, don't show a progress bar.
1614 1614
1615 1615 ``assume-tty``
1616 1616 If true, ALWAYS show a progress bar, unless disable is given.
1617 1617
1618 1618 ``rebase``
1619 1619 ----------
1620 1620
1621 1621 ``allowdivergence``
1622 1622 Default to False, when True allow creating divergence when performing
1623 1623 rebase of obsolete changesets.
1624 1624
1625 1625 ``revsetalias``
1626 1626 ---------------
1627 1627
1628 1628 Alias definitions for revsets. See :hg:`help revsets` for details.
1629 1629
1630 1630 ``server``
1631 1631 ----------
1632 1632
1633 1633 Controls generic server settings.
1634 1634
1635 1635 ``compressionengines``
1636 1636 List of compression engines and their relative priority to advertise
1637 1637 to clients.
1638 1638
1639 1639 The order of compression engines determines their priority, the first
1640 1640 having the highest priority. If a compression engine is not listed
1641 1641 here, it won't be advertised to clients.
1642 1642
1643 1643 If not set (the default), built-in defaults are used. Run
1644 1644 :hg:`debuginstall` to list available compression engines and their
1645 1645 default wire protocol priority.
1646 1646
1647 1647 Older Mercurial clients only support zlib compression and this setting
1648 1648 has no effect for legacy clients.
1649 1649
1650 1650 ``uncompressed``
1651 1651 Whether to allow clients to clone a repository using the
1652 1652 uncompressed streaming protocol. This transfers about 40% more
1653 1653 data than a regular clone, but uses less memory and CPU on both
1654 1654 server and client. Over a LAN (100 Mbps or better) or a very fast
1655 1655 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1656 1656 regular clone. Over most WAN connections (anything slower than
1657 1657 about 6 Mbps), uncompressed streaming is slower, because of the
1658 1658 extra data transfer overhead. This mode will also temporarily hold
1659 1659 the write lock while determining what data to transfer.
1660 1660 (default: True)
1661 1661
1662 1662 ``preferuncompressed``
1663 1663 When set, clients will try to use the uncompressed streaming
1664 1664 protocol. (default: False)
1665 1665
1666 1666 ``validate``
1667 1667 Whether to validate the completeness of pushed changesets by
1668 1668 checking that all new file revisions specified in manifests are
1669 1669 present. (default: False)
1670 1670
1671 1671 ``maxhttpheaderlen``
1672 1672 Instruct HTTP clients not to send request headers longer than this
1673 1673 many bytes. (default: 1024)
1674 1674
1675 1675 ``bundle1``
1676 1676 Whether to allow clients to push and pull using the legacy bundle1
1677 1677 exchange format. (default: True)
1678 1678
1679 1679 ``bundle1gd``
1680 1680 Like ``bundle1`` but only used if the repository is using the
1681 1681 *generaldelta* storage format. (default: True)
1682 1682
1683 1683 ``bundle1.push``
1684 1684 Whether to allow clients to push using the legacy bundle1 exchange
1685 1685 format. (default: True)
1686 1686
1687 1687 ``bundle1gd.push``
1688 1688 Like ``bundle1.push`` but only used if the repository is using the
1689 1689 *generaldelta* storage format. (default: True)
1690 1690
1691 1691 ``bundle1.pull``
1692 1692 Whether to allow clients to pull using the legacy bundle1 exchange
1693 1693 format. (default: True)
1694 1694
1695 1695 ``bundle1gd.pull``
1696 1696 Like ``bundle1.pull`` but only used if the repository is using the
1697 1697 *generaldelta* storage format. (default: True)
1698 1698
1699 1699 Large repositories using the *generaldelta* storage format should
1700 1700 consider setting this option because converting *generaldelta*
1701 1701 repositories to the exchange format required by the bundle1 data
1702 1702 format can consume a lot of CPU.
1703 1703
1704 1704 ``zliblevel``
1705 1705 Integer between ``-1`` and ``9`` that controls the zlib compression level
1706 1706 for wire protocol commands that send zlib compressed output (notably the
1707 1707 commands that send repository history data).
1708 1708
1709 1709 The default (``-1``) uses the default zlib compression level, which is
1710 1710 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1711 1711 maximum compression.
1712 1712
1713 1713 Setting this option allows server operators to make trade-offs between
1714 1714 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1715 1715 but sends more bytes to clients.
1716 1716
1717 1717 This option only impacts the HTTP server.
1718 1718
1719 1719 ``zstdlevel``
1720 1720 Integer between ``1`` and ``22`` that controls the zstd compression level
1721 1721 for wire protocol commands. ``1`` is the minimal amount of compression and
1722 1722 ``22`` is the highest amount of compression.
1723 1723
1724 1724 The default (``3``) should be significantly faster than zlib while likely
1725 1725 delivering better compression ratios.
1726 1726
1727 1727 This option only impacts the HTTP server.
1728 1728
1729 1729 See also ``server.zliblevel``.
1730 1730
1731 1731 ``smtp``
1732 1732 --------
1733 1733
1734 1734 Configuration for extensions that need to send email messages.
1735 1735
1736 1736 ``host``
1737 1737 Host name of mail server, e.g. "mail.example.com".
1738 1738
1739 1739 ``port``
1740 1740 Optional. Port to connect to on mail server. (default: 465 if
1741 1741 ``tls`` is smtps; 25 otherwise)
1742 1742
1743 1743 ``tls``
1744 1744 Optional. Method to enable TLS when connecting to mail server: starttls,
1745 1745 smtps or none. (default: none)
1746 1746
1747 1747 ``username``
1748 1748 Optional. User name for authenticating with the SMTP server.
1749 1749 (default: None)
1750 1750
1751 1751 ``password``
1752 1752 Optional. Password for authenticating with the SMTP server. If not
1753 1753 specified, interactive sessions will prompt the user for a
1754 1754 password; non-interactive sessions will fail. (default: None)
1755 1755
1756 1756 ``local_hostname``
1757 1757 Optional. The hostname that the sender can use to identify
1758 1758 itself to the MTA.
1759 1759
1760 1760
1761 1761 ``subpaths``
1762 1762 ------------
1763 1763
1764 1764 Subrepository source URLs can go stale if a remote server changes name
1765 1765 or becomes temporarily unavailable. This section lets you define
1766 1766 rewrite rules of the form::
1767 1767
1768 1768 <pattern> = <replacement>
1769 1769
1770 1770 where ``pattern`` is a regular expression matching a subrepository
1771 1771 source URL and ``replacement`` is the replacement string used to
1772 1772 rewrite it. Groups can be matched in ``pattern`` and referenced in
1773 1773 ``replacements``. For instance::
1774 1774
1775 1775 http://server/(.*)-hg/ = http://hg.server/\1/
1776 1776
1777 1777 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1778 1778
1779 1779 Relative subrepository paths are first made absolute, and the
1780 1780 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1781 1781 doesn't match the full path, an attempt is made to apply it on the
1782 1782 relative path alone. The rules are applied in definition order.
1783 1783
1784 1784 ``templatealias``
1785 1785 -----------------
1786 1786
1787 1787 Alias definitions for templates. See :hg:`help templates` for details.
1788 1788
1789 1789 ``templates``
1790 1790 -------------
1791 1791
1792 1792 Use the ``[templates]`` section to define template strings.
1793 1793 See :hg:`help templates` for details.
1794 1794
1795 1795 ``trusted``
1796 1796 -----------
1797 1797
1798 1798 Mercurial will not use the settings in the
1799 1799 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1800 1800 user or to a trusted group, as various hgrc features allow arbitrary
1801 1801 commands to be run. This issue is often encountered when configuring
1802 1802 hooks or extensions for shared repositories or servers. However,
1803 1803 the web interface will use some safe settings from the ``[web]``
1804 1804 section.
1805 1805
1806 1806 This section specifies what users and groups are trusted. The
1807 1807 current user is always trusted. To trust everybody, list a user or a
1808 1808 group with name ``*``. These settings must be placed in an
1809 1809 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1810 1810 user or service running Mercurial.
1811 1811
1812 1812 ``users``
1813 1813 Comma-separated list of trusted users.
1814 1814
1815 1815 ``groups``
1816 1816 Comma-separated list of trusted groups.
1817 1817
1818 1818
1819 1819 ``ui``
1820 1820 ------
1821 1821
1822 1822 User interface controls.
1823 1823
1824 1824 ``archivemeta``
1825 1825 Whether to include the .hg_archival.txt file containing meta data
1826 1826 (hashes for the repository base and for tip) in archives created
1827 1827 by the :hg:`archive` command or downloaded via hgweb.
1828 1828 (default: True)
1829 1829
1830 1830 ``askusername``
1831 1831 Whether to prompt for a username when committing. If True, and
1832 1832 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1833 1833 be prompted to enter a username. If no username is entered, the
1834 1834 default ``USER@HOST`` is used instead.
1835 1835 (default: False)
1836 1836
1837 1837 ``clonebundles``
1838 1838 Whether the "clone bundles" feature is enabled.
1839 1839
1840 1840 When enabled, :hg:`clone` may download and apply a server-advertised
1841 1841 bundle file from a URL instead of using the normal exchange mechanism.
1842 1842
1843 1843 This can likely result in faster and more reliable clones.
1844 1844
1845 1845 (default: True)
1846 1846
1847 1847 ``clonebundlefallback``
1848 1848 Whether failure to apply an advertised "clone bundle" from a server
1849 1849 should result in fallback to a regular clone.
1850 1850
1851 1851 This is disabled by default because servers advertising "clone
1852 1852 bundles" often do so to reduce server load. If advertised bundles
1853 1853 start mass failing and clients automatically fall back to a regular
1854 1854 clone, this would add significant and unexpected load to the server
1855 1855 since the server is expecting clone operations to be offloaded to
1856 1856 pre-generated bundles. Failing fast (the default behavior) ensures
1857 1857 clients don't overwhelm the server when "clone bundle" application
1858 1858 fails.
1859 1859
1860 1860 (default: False)
1861 1861
1862 1862 ``clonebundleprefers``
1863 1863 Defines preferences for which "clone bundles" to use.
1864 1864
1865 1865 Servers advertising "clone bundles" may advertise multiple available
1866 1866 bundles. Each bundle may have different attributes, such as the bundle
1867 1867 type and compression format. This option is used to prefer a particular
1868 1868 bundle over another.
1869 1869
1870 1870 The following keys are defined by Mercurial:
1871 1871
1872 1872 BUNDLESPEC
1873 1873 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1874 1874 e.g. ``gzip-v2`` or ``bzip2-v1``.
1875 1875
1876 1876 COMPRESSION
1877 1877 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1878 1878
1879 1879 Server operators may define custom keys.
1880 1880
1881 1881 Example values: ``COMPRESSION=bzip2``,
1882 1882 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1883 1883
1884 1884 By default, the first bundle advertised by the server is used.
1885 1885
1886 1886 ``color``
1887 When to colorize output. Possible value are Boolean, "always", "auto",
1888 "never", or "debug". (default: "auto"). "auto" will use color
1889 whenever it seems possible. See :hg:`help color` for details.
1887 When to colorize output. Possible value are Boolean ("yes" or "no"), or
1888 "debug". (default: "yes"). "yes" will use color whenever it seems possible.
1889 See :hg:`help color` for details.
1890 1890
1891 1891 ``commitsubrepos``
1892 1892 Whether to commit modified subrepositories when committing the
1893 1893 parent repository. If False and one subrepository has uncommitted
1894 1894 changes, abort the commit.
1895 1895 (default: False)
1896 1896
1897 1897 ``debug``
1898 1898 Print debugging information. (default: False)
1899 1899
1900 1900 ``editor``
1901 1901 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1902 1902
1903 1903 ``fallbackencoding``
1904 1904 Encoding to try if it's not possible to decode the changelog using
1905 1905 UTF-8. (default: ISO-8859-1)
1906 1906
1907 1907 ``graphnodetemplate``
1908 1908 The template used to print changeset nodes in an ASCII revision graph.
1909 1909 (default: ``{graphnode}``)
1910 1910
1911 1911 ``ignore``
1912 1912 A file to read per-user ignore patterns from. This file should be
1913 1913 in the same format as a repository-wide .hgignore file. Filenames
1914 1914 are relative to the repository root. This option supports hook syntax,
1915 1915 so if you want to specify multiple ignore files, you can do so by
1916 1916 setting something like ``ignore.other = ~/.hgignore2``. For details
1917 1917 of the ignore file format, see the ``hgignore(5)`` man page.
1918 1918
1919 1919 ``interactive``
1920 1920 Allow to prompt the user. (default: True)
1921 1921
1922 1922 ``interface``
1923 1923 Select the default interface for interactive features (default: text).
1924 1924 Possible values are 'text' and 'curses'.
1925 1925
1926 1926 ``interface.chunkselector``
1927 1927 Select the interface for change recording (e.g. :hg:`commit -i`).
1928 1928 Possible values are 'text' and 'curses'.
1929 1929 This config overrides the interface specified by ui.interface.
1930 1930
1931 1931 ``logtemplate``
1932 1932 Template string for commands that print changesets.
1933 1933
1934 1934 ``merge``
1935 1935 The conflict resolution program to use during a manual merge.
1936 1936 For more information on merge tools see :hg:`help merge-tools`.
1937 1937 For configuring merge tools see the ``[merge-tools]`` section.
1938 1938
1939 1939 ``mergemarkers``
1940 1940 Sets the merge conflict marker label styling. The ``detailed``
1941 1941 style uses the ``mergemarkertemplate`` setting to style the labels.
1942 1942 The ``basic`` style just uses 'local' and 'other' as the marker label.
1943 1943 One of ``basic`` or ``detailed``.
1944 1944 (default: ``basic``)
1945 1945
1946 1946 ``mergemarkertemplate``
1947 1947 The template used to print the commit description next to each conflict
1948 1948 marker during merge conflicts. See :hg:`help templates` for the template
1949 1949 format.
1950 1950
1951 1951 Defaults to showing the hash, tags, branches, bookmarks, author, and
1952 1952 the first line of the commit description.
1953 1953
1954 1954 If you use non-ASCII characters in names for tags, branches, bookmarks,
1955 1955 authors, and/or commit descriptions, you must pay attention to encodings of
1956 1956 managed files. At template expansion, non-ASCII characters use the encoding
1957 1957 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1958 1958 environment variables that govern your locale. If the encoding of the merge
1959 1959 markers is different from the encoding of the merged files,
1960 1960 serious problems may occur.
1961 1961
1962 1962 ``origbackuppath``
1963 1963 The path to a directory used to store generated .orig files. If the path is
1964 1964 not a directory, one will be created.
1965 1965
1966 1966 ``patch``
1967 1967 An optional external tool that ``hg import`` and some extensions
1968 1968 will use for applying patches. By default Mercurial uses an
1969 1969 internal patch utility. The external tool must work as the common
1970 1970 Unix ``patch`` program. In particular, it must accept a ``-p``
1971 1971 argument to strip patch headers, a ``-d`` argument to specify the
1972 1972 current directory, a file name to patch, and a patch file to take
1973 1973 from stdin.
1974 1974
1975 1975 It is possible to specify a patch tool together with extra
1976 1976 arguments. For example, setting this option to ``patch --merge``
1977 1977 will use the ``patch`` program with its 2-way merge option.
1978 1978
1979 1979 ``portablefilenames``
1980 1980 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1981 1981 (default: ``warn``)
1982 1982
1983 1983 ``warn``
1984 1984 Print a warning message on POSIX platforms, if a file with a non-portable
1985 1985 filename is added (e.g. a file with a name that can't be created on
1986 1986 Windows because it contains reserved parts like ``AUX``, reserved
1987 1987 characters like ``:``, or would cause a case collision with an existing
1988 1988 file).
1989 1989
1990 1990 ``ignore``
1991 1991 Don't print a warning.
1992 1992
1993 1993 ``abort``
1994 1994 The command is aborted.
1995 1995
1996 1996 ``true``
1997 1997 Alias for ``warn``.
1998 1998
1999 1999 ``false``
2000 2000 Alias for ``ignore``.
2001 2001
2002 2002 .. container:: windows
2003 2003
2004 2004 On Windows, this configuration option is ignored and the command aborted.
2005 2005
2006 2006 ``quiet``
2007 2007 Reduce the amount of output printed.
2008 2008 (default: False)
2009 2009
2010 2010 ``remotecmd``
2011 2011 Remote command to use for clone/push/pull operations.
2012 2012 (default: ``hg``)
2013 2013
2014 2014 ``report_untrusted``
2015 2015 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2016 2016 trusted user or group.
2017 2017 (default: True)
2018 2018
2019 2019 ``slash``
2020 2020 Display paths using a slash (``/``) as the path separator. This
2021 2021 only makes a difference on systems where the default path
2022 2022 separator is not the slash character (e.g. Windows uses the
2023 2023 backslash character (``\``)).
2024 2024 (default: False)
2025 2025
2026 2026 ``statuscopies``
2027 2027 Display copies in the status command.
2028 2028
2029 2029 ``ssh``
2030 2030 Command to use for SSH connections. (default: ``ssh``)
2031 2031
2032 2032 ``strict``
2033 2033 Require exact command names, instead of allowing unambiguous
2034 2034 abbreviations. (default: False)
2035 2035
2036 2036 ``style``
2037 2037 Name of style to use for command output.
2038 2038
2039 2039 ``supportcontact``
2040 2040 A URL where users should report a Mercurial traceback. Use this if you are a
2041 2041 large organisation with its own Mercurial deployment process and crash
2042 2042 reports should be addressed to your internal support.
2043 2043
2044 2044 ``textwidth``
2045 2045 Maximum width of help text. A longer line generated by ``hg help`` or
2046 2046 ``hg subcommand --help`` will be broken after white space to get this
2047 2047 width or the terminal width, whichever comes first.
2048 2048 A non-positive value will disable this and the terminal width will be
2049 2049 used. (default: 78)
2050 2050
2051 2051 ``timeout``
2052 2052 The timeout used when a lock is held (in seconds), a negative value
2053 2053 means no timeout. (default: 600)
2054 2054
2055 2055 ``traceback``
2056 2056 Mercurial always prints a traceback when an unknown exception
2057 2057 occurs. Setting this to True will make Mercurial print a traceback
2058 2058 on all exceptions, even those recognized by Mercurial (such as
2059 2059 IOError or MemoryError). (default: False)
2060 2060
2061 2061 ``username``
2062 2062 The committer of a changeset created when running "commit".
2063 2063 Typically a person's name and email address, e.g. ``Fred Widget
2064 2064 <fred@example.com>``. Environment variables in the
2065 2065 username are expanded.
2066 2066
2067 2067 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2068 2068 hgrc is empty, e.g. if the system admin set ``username =`` in the
2069 2069 system hgrc, it has to be specified manually or in a different
2070 2070 hgrc file)
2071 2071
2072 2072 ``verbose``
2073 2073 Increase the amount of output printed. (default: False)
2074 2074
2075 2075
2076 2076 ``web``
2077 2077 -------
2078 2078
2079 2079 Web interface configuration. The settings in this section apply to
2080 2080 both the builtin webserver (started by :hg:`serve`) and the script you
2081 2081 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2082 2082 and WSGI).
2083 2083
2084 2084 The Mercurial webserver does no authentication (it does not prompt for
2085 2085 usernames and passwords to validate *who* users are), but it does do
2086 2086 authorization (it grants or denies access for *authenticated users*
2087 2087 based on settings in this section). You must either configure your
2088 2088 webserver to do authentication for you, or disable the authorization
2089 2089 checks.
2090 2090
2091 2091 For a quick setup in a trusted environment, e.g., a private LAN, where
2092 2092 you want it to accept pushes from anybody, you can use the following
2093 2093 command line::
2094 2094
2095 2095 $ hg --config web.allow_push=* --config web.push_ssl=False serve
2096 2096
2097 2097 Note that this will allow anybody to push anything to the server and
2098 2098 that this should not be used for public servers.
2099 2099
2100 2100 The full set of options is:
2101 2101
2102 2102 ``accesslog``
2103 2103 Where to output the access log. (default: stdout)
2104 2104
2105 2105 ``address``
2106 2106 Interface address to bind to. (default: all)
2107 2107
2108 2108 ``allow_archive``
2109 2109 List of archive format (bz2, gz, zip) allowed for downloading.
2110 2110 (default: empty)
2111 2111
2112 2112 ``allowbz2``
2113 2113 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2114 2114 revisions.
2115 2115 (default: False)
2116 2116
2117 2117 ``allowgz``
2118 2118 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2119 2119 revisions.
2120 2120 (default: False)
2121 2121
2122 2122 ``allowpull``
2123 2123 Whether to allow pulling from the repository. (default: True)
2124 2124
2125 2125 ``allow_push``
2126 2126 Whether to allow pushing to the repository. If empty or not set,
2127 2127 pushing is not allowed. If the special value ``*``, any remote
2128 2128 user can push, including unauthenticated users. Otherwise, the
2129 2129 remote user must have been authenticated, and the authenticated
2130 2130 user name must be present in this list. The contents of the
2131 2131 allow_push list are examined after the deny_push list.
2132 2132
2133 2133 ``allow_read``
2134 2134 If the user has not already been denied repository access due to
2135 2135 the contents of deny_read, this list determines whether to grant
2136 2136 repository access to the user. If this list is not empty, and the
2137 2137 user is unauthenticated or not present in the list, then access is
2138 2138 denied for the user. If the list is empty or not set, then access
2139 2139 is permitted to all users by default. Setting allow_read to the
2140 2140 special value ``*`` is equivalent to it not being set (i.e. access
2141 2141 is permitted to all users). The contents of the allow_read list are
2142 2142 examined after the deny_read list.
2143 2143
2144 2144 ``allowzip``
2145 2145 (DEPRECATED) Whether to allow .zip downloading of repository
2146 2146 revisions. This feature creates temporary files.
2147 2147 (default: False)
2148 2148
2149 2149 ``archivesubrepos``
2150 2150 Whether to recurse into subrepositories when archiving.
2151 2151 (default: False)
2152 2152
2153 2153 ``baseurl``
2154 2154 Base URL to use when publishing URLs in other locations, so
2155 2155 third-party tools like email notification hooks can construct
2156 2156 URLs. Example: ``http://hgserver/repos/``.
2157 2157
2158 2158 ``cacerts``
2159 2159 Path to file containing a list of PEM encoded certificate
2160 2160 authority certificates. Environment variables and ``~user``
2161 2161 constructs are expanded in the filename. If specified on the
2162 2162 client, then it will verify the identity of remote HTTPS servers
2163 2163 with these certificates.
2164 2164
2165 2165 To disable SSL verification temporarily, specify ``--insecure`` from
2166 2166 command line.
2167 2167
2168 2168 You can use OpenSSL's CA certificate file if your platform has
2169 2169 one. On most Linux systems this will be
2170 2170 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2171 2171 generate this file manually. The form must be as follows::
2172 2172
2173 2173 -----BEGIN CERTIFICATE-----
2174 2174 ... (certificate in base64 PEM encoding) ...
2175 2175 -----END CERTIFICATE-----
2176 2176 -----BEGIN CERTIFICATE-----
2177 2177 ... (certificate in base64 PEM encoding) ...
2178 2178 -----END CERTIFICATE-----
2179 2179
2180 2180 ``cache``
2181 2181 Whether to support caching in hgweb. (default: True)
2182 2182
2183 2183 ``certificate``
2184 2184 Certificate to use when running :hg:`serve`.
2185 2185
2186 2186 ``collapse``
2187 2187 With ``descend`` enabled, repositories in subdirectories are shown at
2188 2188 a single level alongside repositories in the current path. With
2189 2189 ``collapse`` also enabled, repositories residing at a deeper level than
2190 2190 the current path are grouped behind navigable directory entries that
2191 2191 lead to the locations of these repositories. In effect, this setting
2192 2192 collapses each collection of repositories found within a subdirectory
2193 2193 into a single entry for that subdirectory. (default: False)
2194 2194
2195 2195 ``comparisoncontext``
2196 2196 Number of lines of context to show in side-by-side file comparison. If
2197 2197 negative or the value ``full``, whole files are shown. (default: 5)
2198 2198
2199 2199 This setting can be overridden by a ``context`` request parameter to the
2200 2200 ``comparison`` command, taking the same values.
2201 2201
2202 2202 ``contact``
2203 2203 Name or email address of the person in charge of the repository.
2204 2204 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2205 2205
2206 2206 ``csp``
2207 2207 Send a ``Content-Security-Policy`` HTTP header with this value.
2208 2208
2209 2209 The value may contain a special string ``%nonce%``, which will be replaced
2210 2210 by a randomly-generated one-time use value. If the value contains
2211 2211 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2212 2212 one-time property of the nonce. This nonce will also be inserted into
2213 2213 ``<script>`` elements containing inline JavaScript.
2214 2214
2215 2215 Note: lots of HTML content sent by the server is derived from repository
2216 2216 data. Please consider the potential for malicious repository data to
2217 2217 "inject" itself into generated HTML content as part of your security
2218 2218 threat model.
2219 2219
2220 2220 ``deny_push``
2221 2221 Whether to deny pushing to the repository. If empty or not set,
2222 2222 push is not denied. If the special value ``*``, all remote users are
2223 2223 denied push. Otherwise, unauthenticated users are all denied, and
2224 2224 any authenticated user name present in this list is also denied. The
2225 2225 contents of the deny_push list are examined before the allow_push list.
2226 2226
2227 2227 ``deny_read``
2228 2228 Whether to deny reading/viewing of the repository. If this list is
2229 2229 not empty, unauthenticated users are all denied, and any
2230 2230 authenticated user name present in this list is also denied access to
2231 2231 the repository. If set to the special value ``*``, all remote users
2232 2232 are denied access (rarely needed ;). If deny_read is empty or not set,
2233 2233 the determination of repository access depends on the presence and
2234 2234 content of the allow_read list (see description). If both
2235 2235 deny_read and allow_read are empty or not set, then access is
2236 2236 permitted to all users by default. If the repository is being
2237 2237 served via hgwebdir, denied users will not be able to see it in
2238 2238 the list of repositories. The contents of the deny_read list have
2239 2239 priority over (are examined before) the contents of the allow_read
2240 2240 list.
2241 2241
2242 2242 ``descend``
2243 2243 hgwebdir indexes will not descend into subdirectories. Only repositories
2244 2244 directly in the current path will be shown (other repositories are still
2245 2245 available from the index corresponding to their containing path).
2246 2246
2247 2247 ``description``
2248 2248 Textual description of the repository's purpose or contents.
2249 2249 (default: "unknown")
2250 2250
2251 2251 ``encoding``
2252 2252 Character encoding name. (default: the current locale charset)
2253 2253 Example: "UTF-8".
2254 2254
2255 2255 ``errorlog``
2256 2256 Where to output the error log. (default: stderr)
2257 2257
2258 2258 ``guessmime``
2259 2259 Control MIME types for raw download of file content.
2260 2260 Set to True to let hgweb guess the content type from the file
2261 2261 extension. This will serve HTML files as ``text/html`` and might
2262 2262 allow cross-site scripting attacks when serving untrusted
2263 2263 repositories. (default: False)
2264 2264
2265 2265 ``hidden``
2266 2266 Whether to hide the repository in the hgwebdir index.
2267 2267 (default: False)
2268 2268
2269 2269 ``ipv6``
2270 2270 Whether to use IPv6. (default: False)
2271 2271
2272 2272 ``labels``
2273 2273 List of string *labels* associated with the repository.
2274 2274
2275 2275 Labels are exposed as a template keyword and can be used to customize
2276 2276 output. e.g. the ``index`` template can group or filter repositories
2277 2277 by labels and the ``summary`` template can display additional content
2278 2278 if a specific label is present.
2279 2279
2280 2280 ``logoimg``
2281 2281 File name of the logo image that some templates display on each page.
2282 2282 The file name is relative to ``staticurl``. That is, the full path to
2283 2283 the logo image is "staticurl/logoimg".
2284 2284 If unset, ``hglogo.png`` will be used.
2285 2285
2286 2286 ``logourl``
2287 2287 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2288 2288 will be used.
2289 2289
2290 2290 ``maxchanges``
2291 2291 Maximum number of changes to list on the changelog. (default: 10)
2292 2292
2293 2293 ``maxfiles``
2294 2294 Maximum number of files to list per changeset. (default: 10)
2295 2295
2296 2296 ``maxshortchanges``
2297 2297 Maximum number of changes to list on the shortlog, graph or filelog
2298 2298 pages. (default: 60)
2299 2299
2300 2300 ``name``
2301 2301 Repository name to use in the web interface.
2302 2302 (default: current working directory)
2303 2303
2304 2304 ``port``
2305 2305 Port to listen on. (default: 8000)
2306 2306
2307 2307 ``prefix``
2308 2308 Prefix path to serve from. (default: '' (server root))
2309 2309
2310 2310 ``push_ssl``
2311 2311 Whether to require that inbound pushes be transported over SSL to
2312 2312 prevent password sniffing. (default: True)
2313 2313
2314 2314 ``refreshinterval``
2315 2315 How frequently directory listings re-scan the filesystem for new
2316 2316 repositories, in seconds. This is relevant when wildcards are used
2317 2317 to define paths. Depending on how much filesystem traversal is
2318 2318 required, refreshing may negatively impact performance.
2319 2319
2320 2320 Values less than or equal to 0 always refresh.
2321 2321 (default: 20)
2322 2322
2323 2323 ``staticurl``
2324 2324 Base URL to use for static files. If unset, static files (e.g. the
2325 2325 hgicon.png favicon) will be served by the CGI script itself. Use
2326 2326 this setting to serve them directly with the HTTP server.
2327 2327 Example: ``http://hgserver/static/``.
2328 2328
2329 2329 ``stripes``
2330 2330 How many lines a "zebra stripe" should span in multi-line output.
2331 2331 Set to 0 to disable. (default: 1)
2332 2332
2333 2333 ``style``
2334 2334 Which template map style to use. The available options are the names of
2335 2335 subdirectories in the HTML templates path. (default: ``paper``)
2336 2336 Example: ``monoblue``.
2337 2337
2338 2338 ``templates``
2339 2339 Where to find the HTML templates. The default path to the HTML templates
2340 2340 can be obtained from ``hg debuginstall``.
2341 2341
2342 2342 ``websub``
2343 2343 ----------
2344 2344
2345 2345 Web substitution filter definition. You can use this section to
2346 2346 define a set of regular expression substitution patterns which
2347 2347 let you automatically modify the hgweb server output.
2348 2348
2349 2349 The default hgweb templates only apply these substitution patterns
2350 2350 on the revision description fields. You can apply them anywhere
2351 2351 you want when you create your own templates by adding calls to the
2352 2352 "websub" filter (usually after calling the "escape" filter).
2353 2353
2354 2354 This can be used, for example, to convert issue references to links
2355 2355 to your issue tracker, or to convert "markdown-like" syntax into
2356 2356 HTML (see the examples below).
2357 2357
2358 2358 Each entry in this section names a substitution filter.
2359 2359 The value of each entry defines the substitution expression itself.
2360 2360 The websub expressions follow the old interhg extension syntax,
2361 2361 which in turn imitates the Unix sed replacement syntax::
2362 2362
2363 2363 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2364 2364
2365 2365 You can use any separator other than "/". The final "i" is optional
2366 2366 and indicates that the search must be case insensitive.
2367 2367
2368 2368 Examples::
2369 2369
2370 2370 [websub]
2371 2371 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2372 2372 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2373 2373 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2374 2374
2375 2375 ``worker``
2376 2376 ----------
2377 2377
2378 2378 Parallel master/worker configuration. We currently perform working
2379 2379 directory updates in parallel on Unix-like systems, which greatly
2380 2380 helps performance.
2381 2381
2382 2382 ``numcpus``
2383 2383 Number of CPUs to use for parallel operations. A zero or
2384 2384 negative value is treated as ``use the default``.
2385 2385 (default: 4 or the number of CPUs on the system, whichever is larger)
2386 2386
2387 2387 ``backgroundclose``
2388 2388 Whether to enable closing file handles on background threads during certain
2389 2389 operations. Some platforms aren't very efficient at closing file
2390 2390 handles that have been written or appended to. By performing file closing
2391 2391 on background threads, file write rate can increase substantially.
2392 2392 (default: true on Windows, false elsewhere)
2393 2393
2394 2394 ``backgroundcloseminfilecount``
2395 2395 Minimum number of files required to trigger background file closing.
2396 2396 Operations not writing this many files won't start background close
2397 2397 threads.
2398 2398 (default: 2048)
2399 2399
2400 2400 ``backgroundclosemaxqueue``
2401 2401 The maximum number of opened file handles waiting to be closed in the
2402 2402 background. This option only has an effect if ``backgroundclose`` is
2403 2403 enabled.
2404 2404 (default: 384)
2405 2405
2406 2406 ``backgroundclosethreadcount``
2407 2407 Number of threads to process background file closes. Only relevant if
2408 2408 ``backgroundclose`` is enabled.
2409 2409 (default: 4)
@@ -1,211 +1,244 b''
1 1 Setup
2 2
3 3 $ cat <<EOF >> $HGRCPATH
4 4 > [ui]
5 5 > color = always
6 > formatted = always
6 7 > [color]
7 8 > mode = ansi
8 9 > EOF
9 10 $ hg init repo
10 11 $ cd repo
11 12 $ cat > a <<EOF
12 13 > c
13 14 > c
14 15 > a
15 16 > a
16 17 > b
17 18 > a
18 19 > a
19 20 > c
20 21 > c
21 22 > EOF
22 23 $ hg ci -Am adda
23 24 adding a
24 25 $ cat > a <<EOF
25 26 > c
26 27 > c
27 28 > a
28 29 > a
29 30 > dd
30 31 > a
31 32 > a
32 33 > c
33 34 > c
34 35 > EOF
35 36
36 37 default context
37 38
38 39 $ hg diff --nodates
39 40 \x1b[0;1mdiff -r cf9f4ba66af2 a\x1b[0m (esc)
40 41 \x1b[0;31;1m--- a/a\x1b[0m (esc)
41 42 \x1b[0;32;1m+++ b/a\x1b[0m (esc)
42 43 \x1b[0;35m@@ -2,7 +2,7 @@\x1b[0m (esc)
43 44 c
44 45 a
45 46 a
46 47 \x1b[0;31m-b\x1b[0m (esc)
47 48 \x1b[0;32m+dd\x1b[0m (esc)
48 49 a
49 50 a
50 51 c
51 52
53 (check that 'ui.color=yes' match '--color=auto')
54
55 $ hg diff --nodates --config ui.formatted=no
56 diff -r cf9f4ba66af2 a
57 --- a/a
58 +++ b/a
59 @@ -2,7 +2,7 @@
60 c
61 a
62 a
63 -b
64 +dd
65 a
66 a
67 c
68
69 (check that 'ui.color=no' disable color)
70
71 $ hg diff --nodates --config ui.formatted=yes --config ui.color=no
72 diff -r cf9f4ba66af2 a
73 --- a/a
74 +++ b/a
75 @@ -2,7 +2,7 @@
76 c
77 a
78 a
79 -b
80 +dd
81 a
82 a
83 c
84
52 85 --unified=2
53 86
54 87 $ hg diff --nodates -U 2
55 88 \x1b[0;1mdiff -r cf9f4ba66af2 a\x1b[0m (esc)
56 89 \x1b[0;31;1m--- a/a\x1b[0m (esc)
57 90 \x1b[0;32;1m+++ b/a\x1b[0m (esc)
58 91 \x1b[0;35m@@ -3,5 +3,5 @@\x1b[0m (esc)
59 92 a
60 93 a
61 94 \x1b[0;31m-b\x1b[0m (esc)
62 95 \x1b[0;32m+dd\x1b[0m (esc)
63 96 a
64 97 a
65 98
66 99 diffstat
67 100
68 101 $ hg diff --stat
69 102 a | 2 \x1b[0;32m+\x1b[0m\x1b[0;31m-\x1b[0m (esc)
70 103 1 files changed, 1 insertions(+), 1 deletions(-)
71 104 $ cat <<EOF >> $HGRCPATH
72 105 > [extensions]
73 106 > record =
74 107 > [ui]
75 108 > interactive = true
76 109 > [diff]
77 110 > git = True
78 111 > EOF
79 112
80 113 #if execbit
81 114
82 115 record
83 116
84 117 $ chmod +x a
85 118 $ hg record -m moda a <<EOF
86 119 > y
87 120 > y
88 121 > EOF
89 122 \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)
90 123 \x1b[0;36;1mold mode 100644\x1b[0m (esc)
91 124 \x1b[0;36;1mnew mode 100755\x1b[0m (esc)
92 125 1 hunks, 1 lines changed
93 126 \x1b[0;33mexamine changes to 'a'? [Ynesfdaq?]\x1b[0m y (esc)
94 127
95 128 \x1b[0;35m@@ -2,7 +2,7 @@ c\x1b[0m (esc)
96 129 c
97 130 a
98 131 a
99 132 \x1b[0;31m-b\x1b[0m (esc)
100 133 \x1b[0;32m+dd\x1b[0m (esc)
101 134 a
102 135 a
103 136 c
104 137 \x1b[0;33mrecord this change to 'a'? [Ynesfdaq?]\x1b[0m y (esc)
105 138
106 139
107 140 $ echo "[extensions]" >> $HGRCPATH
108 141 $ echo "mq=" >> $HGRCPATH
109 142 $ hg rollback
110 143 repository tip rolled back to revision 0 (undo commit)
111 144 working directory now based on revision 0
112 145
113 146 qrecord
114 147
115 148 $ hg qrecord -m moda patch <<EOF
116 149 > y
117 150 > y
118 151 > EOF
119 152 \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)
120 153 \x1b[0;36;1mold mode 100644\x1b[0m (esc)
121 154 \x1b[0;36;1mnew mode 100755\x1b[0m (esc)
122 155 1 hunks, 1 lines changed
123 156 \x1b[0;33mexamine changes to 'a'? [Ynesfdaq?]\x1b[0m y (esc)
124 157
125 158 \x1b[0;35m@@ -2,7 +2,7 @@ c\x1b[0m (esc)
126 159 c
127 160 a
128 161 a
129 162 \x1b[0;31m-b\x1b[0m (esc)
130 163 \x1b[0;32m+dd\x1b[0m (esc)
131 164 a
132 165 a
133 166 c
134 167 \x1b[0;33mrecord this change to 'a'? [Ynesfdaq?]\x1b[0m y (esc)
135 168
136 169
137 170 $ hg qpop -a
138 171 popping patch
139 172 patch queue now empty
140 173
141 174 #endif
142 175
143 176 issue3712: test colorization of subrepo diff
144 177
145 178 $ hg init sub
146 179 $ echo b > sub/b
147 180 $ hg -R sub commit -Am 'create sub'
148 181 adding b
149 182 $ echo 'sub = sub' > .hgsub
150 183 $ hg add .hgsub
151 184 $ hg commit -m 'add subrepo sub'
152 185 $ echo aa >> a
153 186 $ echo bb >> sub/b
154 187
155 188 $ hg diff -S
156 189 \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)
157 190 \x1b[0;31;1m--- a/a\x1b[0m (esc)
158 191 \x1b[0;32;1m+++ b/a\x1b[0m (esc)
159 192 \x1b[0;35m@@ -7,3 +7,4 @@\x1b[0m (esc)
160 193 a
161 194 c
162 195 c
163 196 \x1b[0;32m+aa\x1b[0m (esc)
164 197 \x1b[0;1mdiff --git a/sub/b b/sub/b\x1b[0m (esc)
165 198 \x1b[0;31;1m--- a/sub/b\x1b[0m (esc)
166 199 \x1b[0;32;1m+++ b/sub/b\x1b[0m (esc)
167 200 \x1b[0;35m@@ -1,1 +1,2 @@\x1b[0m (esc)
168 201 b
169 202 \x1b[0;32m+bb\x1b[0m (esc)
170 203
171 204 test tabs
172 205
173 206 $ cat >> a <<EOF
174 207 > one tab
175 208 > two tabs
176 209 > end tab
177 210 > mid tab
178 211 > all tabs
179 212 > EOF
180 213 $ hg diff --nodates
181 214 \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)
182 215 \x1b[0;31;1m--- a/a\x1b[0m (esc)
183 216 \x1b[0;32;1m+++ b/a\x1b[0m (esc)
184 217 \x1b[0;35m@@ -7,3 +7,9 @@\x1b[0m (esc)
185 218 a
186 219 c
187 220 c
188 221 \x1b[0;32m+aa\x1b[0m (esc)
189 222 \x1b[0;32m+\x1b[0m \x1b[0;32mone tab\x1b[0m (esc)
190 223 \x1b[0;32m+\x1b[0m \x1b[0;32mtwo tabs\x1b[0m (esc)
191 224 \x1b[0;32m+end tab\x1b[0m\x1b[0;1;41m \x1b[0m (esc)
192 225 \x1b[0;32m+mid\x1b[0m \x1b[0;32mtab\x1b[0m (esc)
193 226 \x1b[0;32m+\x1b[0m \x1b[0;32mall\x1b[0m \x1b[0;32mtabs\x1b[0m\x1b[0;1;41m \x1b[0m (esc)
194 227 $ echo "[color]" >> $HGRCPATH
195 228 $ echo "diff.tab = bold magenta" >> $HGRCPATH
196 229 $ hg diff --nodates
197 230 \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)
198 231 \x1b[0;31;1m--- a/a\x1b[0m (esc)
199 232 \x1b[0;32;1m+++ b/a\x1b[0m (esc)
200 233 \x1b[0;35m@@ -7,3 +7,9 @@\x1b[0m (esc)
201 234 a
202 235 c
203 236 c
204 237 \x1b[0;32m+aa\x1b[0m (esc)
205 238 \x1b[0;32m+\x1b[0m\x1b[0;1;35m \x1b[0m\x1b[0;32mone tab\x1b[0m (esc)
206 239 \x1b[0;32m+\x1b[0m\x1b[0;1;35m \x1b[0m\x1b[0;32mtwo tabs\x1b[0m (esc)
207 240 \x1b[0;32m+end tab\x1b[0m\x1b[0;1;41m \x1b[0m (esc)
208 241 \x1b[0;32m+mid\x1b[0m\x1b[0;1;35m \x1b[0m\x1b[0;32mtab\x1b[0m (esc)
209 242 \x1b[0;32m+\x1b[0m\x1b[0;1;35m \x1b[0m\x1b[0;32mall\x1b[0m\x1b[0;1;35m \x1b[0m\x1b[0;32mtabs\x1b[0m\x1b[0;1;41m \x1b[0m (esc)
210 243
211 244 $ cd ..
@@ -1,233 +1,234 b''
1 1 $ cat >> fakepager.py <<EOF
2 2 > import sys
3 3 > for line in sys.stdin:
4 4 > sys.stdout.write('paged! %r\n' % line)
5 5 > EOF
6 6
7 7 Enable ui.formatted because pager won't fire without it, and set up
8 8 pager and tell it to use our fake pager that lets us see when the
9 9 pager was running.
10 10 $ cat >> $HGRCPATH <<EOF
11 11 > [ui]
12 12 > formatted = yes
13 13 > color = no
14 14 > [extensions]
15 15 > pager=
16 16 > [pager]
17 17 > pager = python $TESTTMP/fakepager.py
18 18 > EOF
19 19
20 20 $ hg init repo
21 21 $ cd repo
22 22 $ echo a >> a
23 23 $ hg add a
24 24 $ hg ci -m 'add a'
25 25 $ for x in `python $TESTDIR/seq.py 1 10`; do
26 26 > echo a $x >> a
27 27 > hg ci -m "modify a $x"
28 28 > done
29 29
30 30 By default diff and log are paged, but summary is not:
31 31
32 32 $ hg diff -c 2 --pager=yes
33 33 paged! 'diff -r f4be7687d414 -r bce265549556 a\n'
34 34 paged! '--- a/a\tThu Jan 01 00:00:00 1970 +0000\n'
35 35 paged! '+++ b/a\tThu Jan 01 00:00:00 1970 +0000\n'
36 36 paged! '@@ -1,2 +1,3 @@\n'
37 37 paged! ' a\n'
38 38 paged! ' a 1\n'
39 39 paged! '+a 2\n'
40 40
41 41 $ hg log --limit 2
42 42 paged! 'changeset: 10:46106edeeb38\n'
43 43 paged! 'tag: tip\n'
44 44 paged! 'user: test\n'
45 45 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
46 46 paged! 'summary: modify a 10\n'
47 47 paged! '\n'
48 48 paged! 'changeset: 9:6dd8ea7dd621\n'
49 49 paged! 'user: test\n'
50 50 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
51 51 paged! 'summary: modify a 9\n'
52 52 paged! '\n'
53 53
54 54 $ hg summary
55 55 parent: 10:46106edeeb38 tip
56 56 modify a 10
57 57 branch: default
58 58 commit: (clean)
59 59 update: (current)
60 60 phases: 11 draft
61 61
62 62 We can enable the pager on summary:
63 63
64 64 $ hg --config pager.attend-summary=yes summary
65 65 paged! 'parent: 10:46106edeeb38 tip\n'
66 66 paged! ' modify a 10\n'
67 67 paged! 'branch: default\n'
68 68 paged! 'commit: (clean)\n'
69 69 paged! 'update: (current)\n'
70 70 paged! 'phases: 11 draft\n'
71 71
72 72 $ hg --config pager.attend-diff=no diff -c 2
73 73 diff -r f4be7687d414 -r bce265549556 a
74 74 --- a/a Thu Jan 01 00:00:00 1970 +0000
75 75 +++ b/a Thu Jan 01 00:00:00 1970 +0000
76 76 @@ -1,2 +1,3 @@
77 77 a
78 78 a 1
79 79 +a 2
80 80
81 81 If we completely change the attend list that's respected:
82 82 $ hg --config pager.attend=summary diff -c 2
83 83 diff -r f4be7687d414 -r bce265549556 a
84 84 --- a/a Thu Jan 01 00:00:00 1970 +0000
85 85 +++ b/a Thu Jan 01 00:00:00 1970 +0000
86 86 @@ -1,2 +1,3 @@
87 87 a
88 88 a 1
89 89 +a 2
90 90
91 91 If 'log' is in attend, then 'history' should also be paged:
92 92 $ hg history --limit 2 --config pager.attend=log
93 93 paged! 'changeset: 10:46106edeeb38\n'
94 94 paged! 'tag: tip\n'
95 95 paged! 'user: test\n'
96 96 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
97 97 paged! 'summary: modify a 10\n'
98 98 paged! '\n'
99 99 paged! 'changeset: 9:6dd8ea7dd621\n'
100 100 paged! 'user: test\n'
101 101 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
102 102 paged! 'summary: modify a 9\n'
103 103 paged! '\n'
104 104
105 105 Possible bug: history is explicitly ignored in pager config, but
106 106 because log is in the attend list it still gets pager treatment.
107 107
108 108 $ hg history --limit 2 --config pager.attend=log \
109 109 > --config pager.ignore=history
110 110 paged! 'changeset: 10:46106edeeb38\n'
111 111 paged! 'tag: tip\n'
112 112 paged! 'user: test\n'
113 113 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
114 114 paged! 'summary: modify a 10\n'
115 115 paged! '\n'
116 116 paged! 'changeset: 9:6dd8ea7dd621\n'
117 117 paged! 'user: test\n'
118 118 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
119 119 paged! 'summary: modify a 9\n'
120 120 paged! '\n'
121 121
122 122 Possible bug: history is explicitly marked as attend-history=no, but
123 123 it doesn't fail to get paged because log is still in the attend list.
124 124
125 125 $ hg history --limit 2 --config pager.attend-history=no
126 126 paged! 'changeset: 10:46106edeeb38\n'
127 127 paged! 'tag: tip\n'
128 128 paged! 'user: test\n'
129 129 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
130 130 paged! 'summary: modify a 10\n'
131 131 paged! '\n'
132 132 paged! 'changeset: 9:6dd8ea7dd621\n'
133 133 paged! 'user: test\n'
134 134 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
135 135 paged! 'summary: modify a 9\n'
136 136 paged! '\n'
137 137
138 138 Possible bug: disabling pager for log but enabling it for history
139 139 doesn't result in history being paged.
140 140
141 141 $ hg history --limit 2 --config pager.attend-log=no \
142 142 > --config pager.attend-history=yes
143 143 changeset: 10:46106edeeb38
144 144 tag: tip
145 145 user: test
146 146 date: Thu Jan 01 00:00:00 1970 +0000
147 147 summary: modify a 10
148 148
149 149 changeset: 9:6dd8ea7dd621
150 150 user: test
151 151 date: Thu Jan 01 00:00:00 1970 +0000
152 152 summary: modify a 9
153 153
154 154 Pager should not start if stdout is not a tty.
155 155
156 156 $ hg log -l1 -q --config ui.formatted=False
157 157 10:46106edeeb38
158 158
159 159 Pager with color enabled allows colors to come through by default,
160 160 even though stdout is no longer a tty.
161 161 $ cat >> $HGRCPATH <<EOF
162 162 > [ui]
163 163 > color = yes
164 > formatted = yes
164 165 > [color]
165 166 > mode = ansi
166 167 > EOF
167 168 $ hg log --limit 3
168 169 paged! '\x1b[0;33mchangeset: 10:46106edeeb38\x1b[0m\n'
169 170 paged! 'tag: tip\n'
170 171 paged! 'user: test\n'
171 172 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
172 173 paged! 'summary: modify a 10\n'
173 174 paged! '\n'
174 175 paged! '\x1b[0;33mchangeset: 9:6dd8ea7dd621\x1b[0m\n'
175 176 paged! 'user: test\n'
176 177 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
177 178 paged! 'summary: modify a 9\n'
178 179 paged! '\n'
179 180 paged! '\x1b[0;33mchangeset: 8:cff05a6312fe\x1b[0m\n'
180 181 paged! 'user: test\n'
181 182 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
182 183 paged! 'summary: modify a 8\n'
183 184 paged! '\n'
184 185
185 186 Pager works with shell aliases.
186 187
187 188 $ cat >> $HGRCPATH <<EOF
188 189 > [alias]
189 190 > echoa = !echo a
190 191 > EOF
191 192
192 193 $ hg echoa
193 194 a
194 195 $ hg --config pager.attend-echoa=yes echoa
195 196 paged! 'a\n'
196 197
197 198 Pager works with hg aliases including environment variables.
198 199
199 200 $ cat >> $HGRCPATH <<'EOF'
200 201 > [alias]
201 202 > printa = log -T "$A\n" -r 0
202 203 > EOF
203 204
204 205 $ A=1 hg --config pager.attend-printa=yes printa
205 206 paged! '1\n'
206 207 $ A=2 hg --config pager.attend-printa=yes printa
207 208 paged! '2\n'
208 209
209 210 Something that's explicitly attended is still not paginated if the
210 211 pager is globally set to off using a flag:
211 212 $ A=2 hg --config pager.attend-printa=yes printa --pager=no
212 213 2
213 214
214 215 Pager should not override the exit code of other commands
215 216
216 217 $ cat >> $TESTTMP/fortytwo.py <<'EOF'
217 218 > from mercurial import cmdutil, commands
218 219 > cmdtable = {}
219 220 > command = cmdutil.command(cmdtable)
220 221 > @command('fortytwo', [], 'fortytwo', norepo=True)
221 222 > def fortytwo(ui, *opts):
222 223 > ui.write('42\n')
223 224 > return 42
224 225 > EOF
225 226
226 227 $ cat >> $HGRCPATH <<'EOF'
227 228 > [extensions]
228 229 > fortytwo = $TESTTMP/fortytwo.py
229 230 > EOF
230 231
231 232 $ hg fortytwo --pager=on
232 233 paged! '42\n'
233 234 [42]
@@ -1,326 +1,327 b''
1 1 $ cat >> fakepager.py <<EOF
2 2 > import sys
3 3 > for line in sys.stdin:
4 4 > sys.stdout.write('paged! %r\n' % line)
5 5 > EOF
6 6
7 7 Enable ui.formatted because pager won't fire without it, and set up
8 8 pager and tell it to use our fake pager that lets us see when the
9 9 pager was running.
10 10 $ cat >> $HGRCPATH <<EOF
11 11 > [ui]
12 12 > formatted = yes
13 13 > color = no
14 14 > [pager]
15 15 > pager = python $TESTTMP/fakepager.py
16 16 > EOF
17 17
18 18 $ hg init repo
19 19 $ cd repo
20 20 $ echo a >> a
21 21 $ hg add a
22 22 $ hg ci -m 'add a'
23 23 $ for x in `python $TESTDIR/seq.py 1 10`; do
24 24 > echo a $x >> a
25 25 > hg ci -m "modify a $x"
26 26 > done
27 27
28 28 By default diff and log are paged, but id is not:
29 29
30 30 $ hg diff -c 2 --pager=yes
31 31 paged! 'diff -r f4be7687d414 -r bce265549556 a\n'
32 32 paged! '--- a/a\tThu Jan 01 00:00:00 1970 +0000\n'
33 33 paged! '+++ b/a\tThu Jan 01 00:00:00 1970 +0000\n'
34 34 paged! '@@ -1,2 +1,3 @@\n'
35 35 paged! ' a\n'
36 36 paged! ' a 1\n'
37 37 paged! '+a 2\n'
38 38
39 39 $ hg log --limit 2
40 40 paged! 'changeset: 10:46106edeeb38\n'
41 41 paged! 'tag: tip\n'
42 42 paged! 'user: test\n'
43 43 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
44 44 paged! 'summary: modify a 10\n'
45 45 paged! '\n'
46 46 paged! 'changeset: 9:6dd8ea7dd621\n'
47 47 paged! 'user: test\n'
48 48 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
49 49 paged! 'summary: modify a 9\n'
50 50 paged! '\n'
51 51
52 52 $ hg id
53 53 46106edeeb38 tip
54 54
55 55 We can control the pager from the config
56 56
57 57 $ hg log --limit 1 --config 'pager.enable=False'
58 58 changeset: 10:46106edeeb38
59 59 tag: tip
60 60 user: test
61 61 date: Thu Jan 01 00:00:00 1970 +0000
62 62 summary: modify a 10
63 63
64 64 $ hg log --limit 1 --config 'pager.enable=0'
65 65 changeset: 10:46106edeeb38
66 66 tag: tip
67 67 user: test
68 68 date: Thu Jan 01 00:00:00 1970 +0000
69 69 summary: modify a 10
70 70
71 71 $ hg log --limit 1 --config 'pager.enable=1'
72 72 paged! 'changeset: 10:46106edeeb38\n'
73 73 paged! 'tag: tip\n'
74 74 paged! 'user: test\n'
75 75 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
76 76 paged! 'summary: modify a 10\n'
77 77 paged! '\n'
78 78
79 79 We can enable the pager on id:
80 80
81 81 BROKEN: should be paged
82 82 $ hg --config pager.attend-id=yes id
83 83 46106edeeb38 tip
84 84
85 85 Setting attend-$COMMAND to a false value works, even with pager in
86 86 core:
87 87 $ hg --config pager.attend-diff=no diff -c 2
88 88 diff -r f4be7687d414 -r bce265549556 a
89 89 --- a/a Thu Jan 01 00:00:00 1970 +0000
90 90 +++ b/a Thu Jan 01 00:00:00 1970 +0000
91 91 @@ -1,2 +1,3 @@
92 92 a
93 93 a 1
94 94 +a 2
95 95
96 96 Command aliases should have same behavior as main command
97 97
98 98 $ hg history --limit 2
99 99 paged! 'changeset: 10:46106edeeb38\n'
100 100 paged! 'tag: tip\n'
101 101 paged! 'user: test\n'
102 102 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
103 103 paged! 'summary: modify a 10\n'
104 104 paged! '\n'
105 105 paged! 'changeset: 9:6dd8ea7dd621\n'
106 106 paged! 'user: test\n'
107 107 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
108 108 paged! 'summary: modify a 9\n'
109 109 paged! '\n'
110 110
111 111 Abbreviated command alias should also be paged
112 112
113 113 $ hg hist -l 1
114 114 paged! 'changeset: 10:46106edeeb38\n'
115 115 paged! 'tag: tip\n'
116 116 paged! 'user: test\n'
117 117 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
118 118 paged! 'summary: modify a 10\n'
119 119 paged! '\n'
120 120
121 121 Attend for an abbreviated command does not work
122 122
123 123 $ hg --config pager.attend-ident=true ident
124 124 46106edeeb38 tip
125 125
126 126 $ hg --config extensions.pager= --config pager.attend-ident=true ident
127 127 46106edeeb38 tip
128 128
129 129 Pager should not start if stdout is not a tty.
130 130
131 131 $ hg log -l1 -q --config ui.formatted=False
132 132 10:46106edeeb38
133 133
134 134 Pager should be disabled if pager.pager is empty (otherwise the output would
135 135 be silently lost.)
136 136
137 137 $ hg log -l1 -q --config pager.pager=
138 138 10:46106edeeb38
139 139
140 140 Pager with color enabled allows colors to come through by default,
141 141 even though stdout is no longer a tty.
142 142 $ cat >> $HGRCPATH <<EOF
143 143 > [ui]
144 144 > color = yes
145 > formatted = yes
145 146 > [color]
146 147 > mode = ansi
147 148 > EOF
148 149 $ hg log --limit 3
149 150 paged! '\x1b[0;33mchangeset: 10:46106edeeb38\x1b[0m\n'
150 151 paged! 'tag: tip\n'
151 152 paged! 'user: test\n'
152 153 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
153 154 paged! 'summary: modify a 10\n'
154 155 paged! '\n'
155 156 paged! '\x1b[0;33mchangeset: 9:6dd8ea7dd621\x1b[0m\n'
156 157 paged! 'user: test\n'
157 158 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
158 159 paged! 'summary: modify a 9\n'
159 160 paged! '\n'
160 161 paged! '\x1b[0;33mchangeset: 8:cff05a6312fe\x1b[0m\n'
161 162 paged! 'user: test\n'
162 163 paged! 'date: Thu Jan 01 00:00:00 1970 +0000\n'
163 164 paged! 'summary: modify a 8\n'
164 165 paged! '\n'
165 166
166 167 An invalid pager command name is reported sensibly if we don't have to
167 168 use shell=True in the subprocess call:
168 169 $ hg log --limit 3 --config pager.pager=this-command-better-never-exist
169 170 missing pager command 'this-command-better-never-exist', skipping pager
170 171 \x1b[0;33mchangeset: 10:46106edeeb38\x1b[0m (esc)
171 172 tag: tip
172 173 user: test
173 174 date: Thu Jan 01 00:00:00 1970 +0000
174 175 summary: modify a 10
175 176
176 177 \x1b[0;33mchangeset: 9:6dd8ea7dd621\x1b[0m (esc)
177 178 user: test
178 179 date: Thu Jan 01 00:00:00 1970 +0000
179 180 summary: modify a 9
180 181
181 182 \x1b[0;33mchangeset: 8:cff05a6312fe\x1b[0m (esc)
182 183 user: test
183 184 date: Thu Jan 01 00:00:00 1970 +0000
184 185 summary: modify a 8
185 186
186 187
187 188 A complicated pager command gets worse behavior. Bonus points if you can
188 189 improve this.
189 190 $ hg log --limit 3 \
190 191 > --config pager.pager='this-command-better-never-exist --seriously' \
191 192 > 2>/dev/null || true
192 193
193 194 Pager works with shell aliases.
194 195
195 196 $ cat >> $HGRCPATH <<EOF
196 197 > [alias]
197 198 > echoa = !echo a
198 199 > EOF
199 200
200 201 $ hg echoa
201 202 a
202 203 BROKEN: should be paged
203 204 $ hg --config pager.attend-echoa=yes echoa
204 205 a
205 206
206 207 Pager works with hg aliases including environment variables.
207 208
208 209 $ cat >> $HGRCPATH <<'EOF'
209 210 > [alias]
210 211 > printa = log -T "$A\n" -r 0
211 212 > EOF
212 213
213 214 $ A=1 hg --config pager.attend-printa=yes printa
214 215 paged! '1\n'
215 216 $ A=2 hg --config pager.attend-printa=yes printa
216 217 paged! '2\n'
217 218
218 219 Something that's explicitly attended is still not paginated if the
219 220 pager is globally set to off using a flag:
220 221 $ A=2 hg --config pager.attend-printa=yes printa --pager=no
221 222 2
222 223
223 224 Pager should not override the exit code of other commands
224 225
225 226 $ cat >> $TESTTMP/fortytwo.py <<'EOF'
226 227 > from mercurial import cmdutil, commands
227 228 > cmdtable = {}
228 229 > command = cmdutil.command(cmdtable)
229 230 > @command('fortytwo', [], 'fortytwo', norepo=True)
230 231 > def fortytwo(ui, *opts):
231 232 > ui.write('42\n')
232 233 > return 42
233 234 > EOF
234 235
235 236 $ cat >> $HGRCPATH <<'EOF'
236 237 > [extensions]
237 238 > fortytwo = $TESTTMP/fortytwo.py
238 239 > EOF
239 240
240 241 $ hg fortytwo --pager=on
241 242 paged! '42\n'
242 243 [42]
243 244
244 245 A command that asks for paging using ui.pager() directly works:
245 246 $ hg blame a
246 247 paged! ' 0: a\n'
247 248 paged! ' 1: a 1\n'
248 249 paged! ' 2: a 2\n'
249 250 paged! ' 3: a 3\n'
250 251 paged! ' 4: a 4\n'
251 252 paged! ' 5: a 5\n'
252 253 paged! ' 6: a 6\n'
253 254 paged! ' 7: a 7\n'
254 255 paged! ' 8: a 8\n'
255 256 paged! ' 9: a 9\n'
256 257 paged! '10: a 10\n'
257 258 but not with HGPLAIN
258 259 $ HGPLAIN=1 hg blame a
259 260 0: a
260 261 1: a 1
261 262 2: a 2
262 263 3: a 3
263 264 4: a 4
264 265 5: a 5
265 266 6: a 6
266 267 7: a 7
267 268 8: a 8
268 269 9: a 9
269 270 10: a 10
270 271 explicit flags work too:
271 272 $ hg blame --pager=no a
272 273 0: a
273 274 1: a 1
274 275 2: a 2
275 276 3: a 3
276 277 4: a 4
277 278 5: a 5
278 279 6: a 6
279 280 7: a 7
280 281 8: a 8
281 282 9: a 9
282 283 10: a 10
283 284
284 285 Put annotate in the ignore list for pager:
285 286 $ cat >> $HGRCPATH <<EOF
286 287 > [pager]
287 288 > ignore = annotate
288 289 > EOF
289 290 $ hg blame a
290 291 0: a
291 292 1: a 1
292 293 2: a 2
293 294 3: a 3
294 295 4: a 4
295 296 5: a 5
296 297 6: a 6
297 298 7: a 7
298 299 8: a 8
299 300 9: a 9
300 301 10: a 10
301 302
302 303 Environment variables like LESS and LV are set automatically:
303 304 $ cat > $TESTTMP/printlesslv.py <<EOF
304 305 > import os, sys
305 306 > sys.stdin.read()
306 307 > for name in ['LESS', 'LV']:
307 308 > sys.stdout.write(('%s=%s\n') % (name, os.environ.get(name, '-')))
308 309 > sys.stdout.flush()
309 310 > EOF
310 311
311 312 $ cat >> $HGRCPATH <<EOF
312 313 > [alias]
313 314 > noop = log -r 0 -T ''
314 315 > [ui]
315 316 > formatted=1
316 317 > [pager]
317 318 > pager = $PYTHON $TESTTMP/printlesslv.py
318 319 > EOF
319 320 $ unset LESS
320 321 $ unset LV
321 322 $ hg noop --pager=on
322 323 LESS=FRX
323 324 LV=-c
324 325 $ LESS=EFGH hg noop --pager=on
325 326 LESS=EFGH
326 327 LV=-c
@@ -1,389 +1,390 b''
1 1 $ cat <<EOF >> $HGRCPATH
2 2 > [ui]
3 3 > color = always
4 > formatted = yes
4 5 > [color]
5 6 > mode = ansi
6 7 > EOF
7 8 Terminfo codes compatibility fix
8 9 $ echo "color.none=0" >> $HGRCPATH
9 10
10 11 $ hg init repo1
11 12 $ cd repo1
12 13 $ mkdir a b a/1 b/1 b/2
13 14 $ touch in_root a/in_a b/in_b a/1/in_a_1 b/1/in_b_1 b/2/in_b_2
14 15
15 16 hg status in repo root:
16 17
17 18 $ hg status
18 19 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
19 20 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
20 21 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
21 22 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
22 23 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
23 24 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
24 25
25 26 $ hg status --color=debug
26 27 [status.unknown|? ][status.unknown|a/1/in_a_1]
27 28 [status.unknown|? ][status.unknown|a/in_a]
28 29 [status.unknown|? ][status.unknown|b/1/in_b_1]
29 30 [status.unknown|? ][status.unknown|b/2/in_b_2]
30 31 [status.unknown|? ][status.unknown|b/in_b]
31 32 [status.unknown|? ][status.unknown|in_root]
32 33
33 34 hg status with template
34 35 $ hg status -T "{label('red', path)}\n" --color=debug
35 36 [red|a/1/in_a_1]
36 37 [red|a/in_a]
37 38 [red|b/1/in_b_1]
38 39 [red|b/2/in_b_2]
39 40 [red|b/in_b]
40 41 [red|in_root]
41 42
42 43 hg status . in repo root:
43 44
44 45 $ hg status .
45 46 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
46 47 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
47 48 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
48 49 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
49 50 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
50 51 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
51 52
52 53 $ hg status --cwd a
53 54 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
54 55 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
55 56 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
56 57 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
57 58 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
58 59 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
59 60 $ hg status --cwd a .
60 61 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m1/in_a_1\x1b[0m (esc)
61 62 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_a\x1b[0m (esc)
62 63 $ hg status --cwd a ..
63 64 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m1/in_a_1\x1b[0m (esc)
64 65 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_a\x1b[0m (esc)
65 66 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../b/1/in_b_1\x1b[0m (esc)
66 67 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../b/2/in_b_2\x1b[0m (esc)
67 68 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../b/in_b\x1b[0m (esc)
68 69 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../in_root\x1b[0m (esc)
69 70
70 71 $ hg status --cwd b
71 72 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
72 73 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
73 74 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
74 75 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
75 76 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
76 77 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
77 78 $ hg status --cwd b .
78 79 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m1/in_b_1\x1b[0m (esc)
79 80 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m2/in_b_2\x1b[0m (esc)
80 81 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_b\x1b[0m (esc)
81 82 $ hg status --cwd b ..
82 83 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../a/1/in_a_1\x1b[0m (esc)
83 84 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../a/in_a\x1b[0m (esc)
84 85 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m1/in_b_1\x1b[0m (esc)
85 86 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m2/in_b_2\x1b[0m (esc)
86 87 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_b\x1b[0m (esc)
87 88 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../in_root\x1b[0m (esc)
88 89
89 90 $ hg status --cwd a/1
90 91 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
91 92 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
92 93 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
93 94 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
94 95 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
95 96 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
96 97 $ hg status --cwd a/1 .
97 98 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_a_1\x1b[0m (esc)
98 99 $ hg status --cwd a/1 ..
99 100 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_a_1\x1b[0m (esc)
100 101 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../in_a\x1b[0m (esc)
101 102
102 103 $ hg status --cwd b/1
103 104 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
104 105 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
105 106 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
106 107 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
107 108 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
108 109 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
109 110 $ hg status --cwd b/1 .
110 111 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_b_1\x1b[0m (esc)
111 112 $ hg status --cwd b/1 ..
112 113 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_b_1\x1b[0m (esc)
113 114 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../2/in_b_2\x1b[0m (esc)
114 115 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../in_b\x1b[0m (esc)
115 116
116 117 $ hg status --cwd b/2
117 118 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/1/in_a_1\x1b[0m (esc)
118 119 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4ma/in_a\x1b[0m (esc)
119 120 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/1/in_b_1\x1b[0m (esc)
120 121 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/2/in_b_2\x1b[0m (esc)
121 122 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4mb/in_b\x1b[0m (esc)
122 123 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_root\x1b[0m (esc)
123 124 $ hg status --cwd b/2 .
124 125 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_b_2\x1b[0m (esc)
125 126 $ hg status --cwd b/2 ..
126 127 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../1/in_b_1\x1b[0m (esc)
127 128 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4min_b_2\x1b[0m (esc)
128 129 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4m../in_b\x1b[0m (esc)
129 130
130 131 Make sure --color=never works
131 132 $ hg status --color=never
132 133 ? a/1/in_a_1
133 134 ? a/in_a
134 135 ? b/1/in_b_1
135 136 ? b/2/in_b_2
136 137 ? b/in_b
137 138 ? in_root
138 139
139 140 Make sure ui.formatted=False works
140 141 $ hg status --color=auto --config ui.formatted=False
141 142 ? a/1/in_a_1
142 143 ? a/in_a
143 144 ? b/1/in_b_1
144 145 ? b/2/in_b_2
145 146 ? b/in_b
146 147 ? in_root
147 148
148 149 $ cd ..
149 150
150 151 $ hg init repo2
151 152 $ cd repo2
152 153 $ touch modified removed deleted ignored
153 154 $ echo "^ignored$" > .hgignore
154 155 $ hg ci -A -m 'initial checkin'
155 156 adding .hgignore
156 157 adding deleted
157 158 adding modified
158 159 adding removed
159 160 $ hg log --color=debug
160 161 [log.changeset changeset.draft|changeset: 0:389aef86a55e]
161 162 [log.tag|tag: tip]
162 163 [log.user|user: test]
163 164 [log.date|date: Thu Jan 01 00:00:00 1970 +0000]
164 165 [log.summary|summary: initial checkin]
165 166
166 167 $ hg log -Tcompact --color=debug
167 168 [log.changeset changeset.draft|0][tip] [log.node|389aef86a55e] [log.date|1970-01-01 00:00 +0000] [log.user|test]
168 169 [ui.note log.description|initial checkin]
169 170
170 171 Labels on empty strings should not be displayed, labels on custom
171 172 templates should be.
172 173
173 174 $ hg log --color=debug -T '{label("my.label",author)}\n{label("skipped.label","")}'
174 175 [my.label|test]
175 176 $ touch modified added unknown ignored
176 177 $ hg add added
177 178 $ hg remove removed
178 179 $ rm deleted
179 180
180 181 hg status:
181 182
182 183 $ hg status
183 184 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
184 185 \x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
185 186 \x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
186 187 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
187 188
188 189 hg status modified added removed deleted unknown never-existed ignored:
189 190
190 191 $ hg status modified added removed deleted unknown never-existed ignored
191 192 never-existed: * (glob)
192 193 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
193 194 \x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
194 195 \x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
195 196 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
196 197
197 198 $ hg copy modified copied
198 199
199 200 hg status -C:
200 201
201 202 $ hg status -C
202 203 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
203 204 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1mcopied\x1b[0m (esc)
204 205 \x1b[0;0m modified\x1b[0m (esc)
205 206 \x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
206 207 \x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
207 208 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
208 209
209 210 hg status -A:
210 211
211 212 $ hg status -A
212 213 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
213 214 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1mcopied\x1b[0m (esc)
214 215 \x1b[0;0m modified\x1b[0m (esc)
215 216 \x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
216 217 \x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
217 218 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
218 219 \x1b[0;30;1mI \x1b[0m\x1b[0;30;1mignored\x1b[0m (esc)
219 220 \x1b[0;0mC \x1b[0m\x1b[0;0m.hgignore\x1b[0m (esc)
220 221 \x1b[0;0mC \x1b[0m\x1b[0;0mmodified\x1b[0m (esc)
221 222
222 223
223 224 hg status -A (with terminfo color):
224 225
225 226 #if tic
226 227
227 228 $ mkdir "$TESTTMP/terminfo"
228 229 $ TERMINFO="$TESTTMP/terminfo" tic "$TESTDIR/hgterm.ti"
229 230 $ TERM=hgterm TERMINFO="$TESTTMP/terminfo" hg status --config color.mode=terminfo -A
230 231 \x1b[30m\x1b[32m\x1b[1mA \x1b[30m\x1b[30m\x1b[32m\x1b[1madded\x1b[30m (esc)
231 232 \x1b[30m\x1b[32m\x1b[1mA \x1b[30m\x1b[30m\x1b[32m\x1b[1mcopied\x1b[30m (esc)
232 233 \x1b[30m\x1b[30m modified\x1b[30m (esc)
233 234 \x1b[30m\x1b[31m\x1b[1mR \x1b[30m\x1b[30m\x1b[31m\x1b[1mremoved\x1b[30m (esc)
234 235 \x1b[30m\x1b[36m\x1b[1m\x1b[4m! \x1b[30m\x1b[30m\x1b[36m\x1b[1m\x1b[4mdeleted\x1b[30m (esc)
235 236 \x1b[30m\x1b[35m\x1b[1m\x1b[4m? \x1b[30m\x1b[30m\x1b[35m\x1b[1m\x1b[4munknown\x1b[30m (esc)
236 237 \x1b[30m\x1b[30m\x1b[1mI \x1b[30m\x1b[30m\x1b[30m\x1b[1mignored\x1b[30m (esc)
237 238 \x1b[30m\x1b[30mC \x1b[30m\x1b[30m\x1b[30m.hgignore\x1b[30m (esc)
238 239 \x1b[30m\x1b[30mC \x1b[30m\x1b[30m\x1b[30mmodified\x1b[30m (esc)
239 240
240 241 The user can define effects with raw terminfo codes:
241 242
242 243 $ cat <<EOF >> $HGRCPATH
243 244 > # Completely bogus code for dim
244 245 > terminfo.dim = \E[88m
245 246 > # We can override what's in the terminfo database, too
246 247 > terminfo.bold = \E[2m
247 248 > EOF
248 249 $ TERM=hgterm TERMINFO="$TESTTMP/terminfo" hg status --config color.mode=terminfo --config color.status.clean=dim -A
249 250 \x1b[30m\x1b[32m\x1b[2mA \x1b[30m\x1b[30m\x1b[32m\x1b[2madded\x1b[30m (esc)
250 251 \x1b[30m\x1b[32m\x1b[2mA \x1b[30m\x1b[30m\x1b[32m\x1b[2mcopied\x1b[30m (esc)
251 252 \x1b[30m\x1b[30m modified\x1b[30m (esc)
252 253 \x1b[30m\x1b[31m\x1b[2mR \x1b[30m\x1b[30m\x1b[31m\x1b[2mremoved\x1b[30m (esc)
253 254 \x1b[30m\x1b[36m\x1b[2m\x1b[4m! \x1b[30m\x1b[30m\x1b[36m\x1b[2m\x1b[4mdeleted\x1b[30m (esc)
254 255 \x1b[30m\x1b[35m\x1b[2m\x1b[4m? \x1b[30m\x1b[30m\x1b[35m\x1b[2m\x1b[4munknown\x1b[30m (esc)
255 256 \x1b[30m\x1b[30m\x1b[2mI \x1b[30m\x1b[30m\x1b[30m\x1b[2mignored\x1b[30m (esc)
256 257 \x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88m.hgignore\x1b[30m (esc)
257 258 \x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88mmodified\x1b[30m (esc)
258 259
259 260 #endif
260 261
261 262
262 263 $ echo "^ignoreddir$" > .hgignore
263 264 $ mkdir ignoreddir
264 265 $ touch ignoreddir/file
265 266
266 267 hg status ignoreddir/file:
267 268
268 269 $ hg status ignoreddir/file
269 270
270 271 hg status -i ignoreddir/file:
271 272
272 273 $ hg status -i ignoreddir/file
273 274 \x1b[0;30;1mI \x1b[0m\x1b[0;30;1mignoreddir/file\x1b[0m (esc)
274 275 $ cd ..
275 276
276 277 check 'status -q' and some combinations
277 278
278 279 $ hg init repo3
279 280 $ cd repo3
280 281 $ touch modified removed deleted ignored
281 282 $ echo "^ignored$" > .hgignore
282 283 $ hg commit -A -m 'initial checkin'
283 284 adding .hgignore
284 285 adding deleted
285 286 adding modified
286 287 adding removed
287 288 $ touch added unknown ignored
288 289 $ hg add added
289 290 $ echo "test" >> modified
290 291 $ hg remove removed
291 292 $ rm deleted
292 293 $ hg copy modified copied
293 294
294 295 test unknown color
295 296
296 297 $ hg --config color.status.modified=periwinkle status
297 298 ignoring unknown color/effect 'periwinkle' (configured in color.status.modified)
298 299 ignoring unknown color/effect 'periwinkle' (configured in color.status.modified)
299 300 ignoring unknown color/effect 'periwinkle' (configured in color.status.modified)
300 301 M modified
301 302 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
302 303 \x1b[0;32;1mA \x1b[0m\x1b[0;32;1mcopied\x1b[0m (esc)
303 304 \x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
304 305 \x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
305 306 \x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
306 307
307 308 Run status with 2 different flags.
308 309 Check if result is the same or different.
309 310 If result is not as expected, raise error
310 311
311 312 $ assert() {
312 313 > hg status $1 > ../a
313 314 > hg status $2 > ../b
314 315 > if diff ../a ../b > /dev/null; then
315 316 > out=0
316 317 > else
317 318 > out=1
318 319 > fi
319 320 > if [ $3 -eq 0 ]; then
320 321 > df="same"
321 322 > else
322 323 > df="different"
323 324 > fi
324 325 > if [ $out -ne $3 ]; then
325 326 > echo "Error on $1 and $2, should be $df."
326 327 > fi
327 328 > }
328 329
329 330 assert flag1 flag2 [0-same | 1-different]
330 331
331 332 $ assert "-q" "-mard" 0
332 333 $ assert "-A" "-marduicC" 0
333 334 $ assert "-qA" "-mardcC" 0
334 335 $ assert "-qAui" "-A" 0
335 336 $ assert "-qAu" "-marducC" 0
336 337 $ assert "-qAi" "-mardicC" 0
337 338 $ assert "-qu" "-u" 0
338 339 $ assert "-q" "-u" 1
339 340 $ assert "-m" "-a" 1
340 341 $ assert "-r" "-d" 1
341 342 $ cd ..
342 343
343 344 test 'resolve -l'
344 345
345 346 $ hg init repo4
346 347 $ cd repo4
347 348 $ echo "file a" > a
348 349 $ echo "file b" > b
349 350 $ hg add a b
350 351 $ hg commit -m "initial"
351 352 $ echo "file a change 1" > a
352 353 $ echo "file b change 1" > b
353 354 $ hg commit -m "head 1"
354 355 $ hg update 0
355 356 2 files updated, 0 files merged, 0 files removed, 0 files unresolved
356 357 $ echo "file a change 2" > a
357 358 $ echo "file b change 2" > b
358 359 $ hg commit -m "head 2"
359 360 created new head
360 361 $ hg merge
361 362 merging a
362 363 merging b
363 364 warning: conflicts while merging a! (edit, then use 'hg resolve --mark')
364 365 warning: conflicts while merging b! (edit, then use 'hg resolve --mark')
365 366 0 files updated, 0 files merged, 0 files removed, 2 files unresolved
366 367 use 'hg resolve' to retry unresolved file merges or 'hg update -C .' to abandon
367 368 [1]
368 369 $ hg resolve -m b
369 370
370 371 hg resolve with one unresolved, one resolved:
371 372
372 373 $ hg resolve -l
373 374 \x1b[0;31;1mU \x1b[0m\x1b[0;31;1ma\x1b[0m (esc)
374 375 \x1b[0;32;1mR \x1b[0m\x1b[0;32;1mb\x1b[0m (esc)
375 376
376 377 color coding of error message with current availability of curses
377 378
378 379 $ hg unknowncommand > /dev/null
379 380 hg: unknown command 'unknowncommand'
380 381 [255]
381 382
382 383 color coding of error message without curses
383 384
384 385 $ echo 'raise ImportError' > curses.py
385 386 $ PYTHONPATH=`pwd`:$PYTHONPATH hg unknowncommand > /dev/null
386 387 hg: unknown command 'unknowncommand'
387 388 [255]
388 389
389 390 $ cd ..
General Comments 0
You need to be logged in to leave comments. Login now