##// END OF EJS Templates
ui: add config knob to redirect status messages to stderr (API)...
Yuya Nishihara -
r40580:840cd57c default
parent child Browse files
Show More
@@ -1,1441 +1,1444 b''
1 # configitems.py - centralized declaration of configuration option
1 # configitems.py - centralized declaration of configuration option
2 #
2 #
3 # Copyright 2017 Pierre-Yves David <pierre-yves.david@octobus.net>
3 # Copyright 2017 Pierre-Yves David <pierre-yves.david@octobus.net>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7
7
8 from __future__ import absolute_import
8 from __future__ import absolute_import
9
9
10 import functools
10 import functools
11 import re
11 import re
12
12
13 from . import (
13 from . import (
14 encoding,
14 encoding,
15 error,
15 error,
16 )
16 )
17
17
18 def loadconfigtable(ui, extname, configtable):
18 def loadconfigtable(ui, extname, configtable):
19 """update config item known to the ui with the extension ones"""
19 """update config item known to the ui with the extension ones"""
20 for section, items in sorted(configtable.items()):
20 for section, items in sorted(configtable.items()):
21 knownitems = ui._knownconfig.setdefault(section, itemregister())
21 knownitems = ui._knownconfig.setdefault(section, itemregister())
22 knownkeys = set(knownitems)
22 knownkeys = set(knownitems)
23 newkeys = set(items)
23 newkeys = set(items)
24 for key in sorted(knownkeys & newkeys):
24 for key in sorted(knownkeys & newkeys):
25 msg = "extension '%s' overwrite config item '%s.%s'"
25 msg = "extension '%s' overwrite config item '%s.%s'"
26 msg %= (extname, section, key)
26 msg %= (extname, section, key)
27 ui.develwarn(msg, config='warn-config')
27 ui.develwarn(msg, config='warn-config')
28
28
29 knownitems.update(items)
29 knownitems.update(items)
30
30
31 class configitem(object):
31 class configitem(object):
32 """represent a known config item
32 """represent a known config item
33
33
34 :section: the official config section where to find this item,
34 :section: the official config section where to find this item,
35 :name: the official name within the section,
35 :name: the official name within the section,
36 :default: default value for this item,
36 :default: default value for this item,
37 :alias: optional list of tuples as alternatives,
37 :alias: optional list of tuples as alternatives,
38 :generic: this is a generic definition, match name using regular expression.
38 :generic: this is a generic definition, match name using regular expression.
39 """
39 """
40
40
41 def __init__(self, section, name, default=None, alias=(),
41 def __init__(self, section, name, default=None, alias=(),
42 generic=False, priority=0):
42 generic=False, priority=0):
43 self.section = section
43 self.section = section
44 self.name = name
44 self.name = name
45 self.default = default
45 self.default = default
46 self.alias = list(alias)
46 self.alias = list(alias)
47 self.generic = generic
47 self.generic = generic
48 self.priority = priority
48 self.priority = priority
49 self._re = None
49 self._re = None
50 if generic:
50 if generic:
51 self._re = re.compile(self.name)
51 self._re = re.compile(self.name)
52
52
53 class itemregister(dict):
53 class itemregister(dict):
54 """A specialized dictionary that can handle wild-card selection"""
54 """A specialized dictionary that can handle wild-card selection"""
55
55
56 def __init__(self):
56 def __init__(self):
57 super(itemregister, self).__init__()
57 super(itemregister, self).__init__()
58 self._generics = set()
58 self._generics = set()
59
59
60 def update(self, other):
60 def update(self, other):
61 super(itemregister, self).update(other)
61 super(itemregister, self).update(other)
62 self._generics.update(other._generics)
62 self._generics.update(other._generics)
63
63
64 def __setitem__(self, key, item):
64 def __setitem__(self, key, item):
65 super(itemregister, self).__setitem__(key, item)
65 super(itemregister, self).__setitem__(key, item)
66 if item.generic:
66 if item.generic:
67 self._generics.add(item)
67 self._generics.add(item)
68
68
69 def get(self, key):
69 def get(self, key):
70 baseitem = super(itemregister, self).get(key)
70 baseitem = super(itemregister, self).get(key)
71 if baseitem is not None and not baseitem.generic:
71 if baseitem is not None and not baseitem.generic:
72 return baseitem
72 return baseitem
73
73
74 # search for a matching generic item
74 # search for a matching generic item
75 generics = sorted(self._generics, key=(lambda x: (x.priority, x.name)))
75 generics = sorted(self._generics, key=(lambda x: (x.priority, x.name)))
76 for item in generics:
76 for item in generics:
77 # we use 'match' instead of 'search' to make the matching simpler
77 # we use 'match' instead of 'search' to make the matching simpler
78 # for people unfamiliar with regular expression. Having the match
78 # for people unfamiliar with regular expression. Having the match
79 # rooted to the start of the string will produce less surprising
79 # rooted to the start of the string will produce less surprising
80 # result for user writing simple regex for sub-attribute.
80 # result for user writing simple regex for sub-attribute.
81 #
81 #
82 # For example using "color\..*" match produces an unsurprising
82 # For example using "color\..*" match produces an unsurprising
83 # result, while using search could suddenly match apparently
83 # result, while using search could suddenly match apparently
84 # unrelated configuration that happens to contains "color."
84 # unrelated configuration that happens to contains "color."
85 # anywhere. This is a tradeoff where we favor requiring ".*" on
85 # anywhere. This is a tradeoff where we favor requiring ".*" on
86 # some match to avoid the need to prefix most pattern with "^".
86 # some match to avoid the need to prefix most pattern with "^".
87 # The "^" seems more error prone.
87 # The "^" seems more error prone.
88 if item._re.match(key):
88 if item._re.match(key):
89 return item
89 return item
90
90
91 return None
91 return None
92
92
93 coreitems = {}
93 coreitems = {}
94
94
95 def _register(configtable, *args, **kwargs):
95 def _register(configtable, *args, **kwargs):
96 item = configitem(*args, **kwargs)
96 item = configitem(*args, **kwargs)
97 section = configtable.setdefault(item.section, itemregister())
97 section = configtable.setdefault(item.section, itemregister())
98 if item.name in section:
98 if item.name in section:
99 msg = "duplicated config item registration for '%s.%s'"
99 msg = "duplicated config item registration for '%s.%s'"
100 raise error.ProgrammingError(msg % (item.section, item.name))
100 raise error.ProgrammingError(msg % (item.section, item.name))
101 section[item.name] = item
101 section[item.name] = item
102
102
103 # special value for case where the default is derived from other values
103 # special value for case where the default is derived from other values
104 dynamicdefault = object()
104 dynamicdefault = object()
105
105
106 # Registering actual config items
106 # Registering actual config items
107
107
108 def getitemregister(configtable):
108 def getitemregister(configtable):
109 f = functools.partial(_register, configtable)
109 f = functools.partial(_register, configtable)
110 # export pseudo enum as configitem.*
110 # export pseudo enum as configitem.*
111 f.dynamicdefault = dynamicdefault
111 f.dynamicdefault = dynamicdefault
112 return f
112 return f
113
113
114 coreconfigitem = getitemregister(coreitems)
114 coreconfigitem = getitemregister(coreitems)
115
115
116 coreconfigitem('alias', '.*',
116 coreconfigitem('alias', '.*',
117 default=dynamicdefault,
117 default=dynamicdefault,
118 generic=True,
118 generic=True,
119 )
119 )
120 coreconfigitem('annotate', 'nodates',
120 coreconfigitem('annotate', 'nodates',
121 default=False,
121 default=False,
122 )
122 )
123 coreconfigitem('annotate', 'showfunc',
123 coreconfigitem('annotate', 'showfunc',
124 default=False,
124 default=False,
125 )
125 )
126 coreconfigitem('annotate', 'unified',
126 coreconfigitem('annotate', 'unified',
127 default=None,
127 default=None,
128 )
128 )
129 coreconfigitem('annotate', 'git',
129 coreconfigitem('annotate', 'git',
130 default=False,
130 default=False,
131 )
131 )
132 coreconfigitem('annotate', 'ignorews',
132 coreconfigitem('annotate', 'ignorews',
133 default=False,
133 default=False,
134 )
134 )
135 coreconfigitem('annotate', 'ignorewsamount',
135 coreconfigitem('annotate', 'ignorewsamount',
136 default=False,
136 default=False,
137 )
137 )
138 coreconfigitem('annotate', 'ignoreblanklines',
138 coreconfigitem('annotate', 'ignoreblanklines',
139 default=False,
139 default=False,
140 )
140 )
141 coreconfigitem('annotate', 'ignorewseol',
141 coreconfigitem('annotate', 'ignorewseol',
142 default=False,
142 default=False,
143 )
143 )
144 coreconfigitem('annotate', 'nobinary',
144 coreconfigitem('annotate', 'nobinary',
145 default=False,
145 default=False,
146 )
146 )
147 coreconfigitem('annotate', 'noprefix',
147 coreconfigitem('annotate', 'noprefix',
148 default=False,
148 default=False,
149 )
149 )
150 coreconfigitem('annotate', 'word-diff',
150 coreconfigitem('annotate', 'word-diff',
151 default=False,
151 default=False,
152 )
152 )
153 coreconfigitem('auth', 'cookiefile',
153 coreconfigitem('auth', 'cookiefile',
154 default=None,
154 default=None,
155 )
155 )
156 # bookmarks.pushing: internal hack for discovery
156 # bookmarks.pushing: internal hack for discovery
157 coreconfigitem('bookmarks', 'pushing',
157 coreconfigitem('bookmarks', 'pushing',
158 default=list,
158 default=list,
159 )
159 )
160 # bundle.mainreporoot: internal hack for bundlerepo
160 # bundle.mainreporoot: internal hack for bundlerepo
161 coreconfigitem('bundle', 'mainreporoot',
161 coreconfigitem('bundle', 'mainreporoot',
162 default='',
162 default='',
163 )
163 )
164 coreconfigitem('censor', 'policy',
164 coreconfigitem('censor', 'policy',
165 default='abort',
165 default='abort',
166 )
166 )
167 coreconfigitem('chgserver', 'idletimeout',
167 coreconfigitem('chgserver', 'idletimeout',
168 default=3600,
168 default=3600,
169 )
169 )
170 coreconfigitem('chgserver', 'skiphash',
170 coreconfigitem('chgserver', 'skiphash',
171 default=False,
171 default=False,
172 )
172 )
173 coreconfigitem('cmdserver', 'log',
173 coreconfigitem('cmdserver', 'log',
174 default=None,
174 default=None,
175 )
175 )
176 coreconfigitem('color', '.*',
176 coreconfigitem('color', '.*',
177 default=None,
177 default=None,
178 generic=True,
178 generic=True,
179 )
179 )
180 coreconfigitem('color', 'mode',
180 coreconfigitem('color', 'mode',
181 default='auto',
181 default='auto',
182 )
182 )
183 coreconfigitem('color', 'pagermode',
183 coreconfigitem('color', 'pagermode',
184 default=dynamicdefault,
184 default=dynamicdefault,
185 )
185 )
186 coreconfigitem('commands', 'grep.all-files',
186 coreconfigitem('commands', 'grep.all-files',
187 default=False,
187 default=False,
188 )
188 )
189 coreconfigitem('commands', 'resolve.confirm',
189 coreconfigitem('commands', 'resolve.confirm',
190 default=False,
190 default=False,
191 )
191 )
192 coreconfigitem('commands', 'resolve.explicit-re-merge',
192 coreconfigitem('commands', 'resolve.explicit-re-merge',
193 default=False,
193 default=False,
194 )
194 )
195 coreconfigitem('commands', 'resolve.mark-check',
195 coreconfigitem('commands', 'resolve.mark-check',
196 default='none',
196 default='none',
197 )
197 )
198 coreconfigitem('commands', 'show.aliasprefix',
198 coreconfigitem('commands', 'show.aliasprefix',
199 default=list,
199 default=list,
200 )
200 )
201 coreconfigitem('commands', 'status.relative',
201 coreconfigitem('commands', 'status.relative',
202 default=False,
202 default=False,
203 )
203 )
204 coreconfigitem('commands', 'status.skipstates',
204 coreconfigitem('commands', 'status.skipstates',
205 default=[],
205 default=[],
206 )
206 )
207 coreconfigitem('commands', 'status.terse',
207 coreconfigitem('commands', 'status.terse',
208 default='',
208 default='',
209 )
209 )
210 coreconfigitem('commands', 'status.verbose',
210 coreconfigitem('commands', 'status.verbose',
211 default=False,
211 default=False,
212 )
212 )
213 coreconfigitem('commands', 'update.check',
213 coreconfigitem('commands', 'update.check',
214 default=None,
214 default=None,
215 )
215 )
216 coreconfigitem('commands', 'update.requiredest',
216 coreconfigitem('commands', 'update.requiredest',
217 default=False,
217 default=False,
218 )
218 )
219 coreconfigitem('committemplate', '.*',
219 coreconfigitem('committemplate', '.*',
220 default=None,
220 default=None,
221 generic=True,
221 generic=True,
222 )
222 )
223 coreconfigitem('convert', 'bzr.saverev',
223 coreconfigitem('convert', 'bzr.saverev',
224 default=True,
224 default=True,
225 )
225 )
226 coreconfigitem('convert', 'cvsps.cache',
226 coreconfigitem('convert', 'cvsps.cache',
227 default=True,
227 default=True,
228 )
228 )
229 coreconfigitem('convert', 'cvsps.fuzz',
229 coreconfigitem('convert', 'cvsps.fuzz',
230 default=60,
230 default=60,
231 )
231 )
232 coreconfigitem('convert', 'cvsps.logencoding',
232 coreconfigitem('convert', 'cvsps.logencoding',
233 default=None,
233 default=None,
234 )
234 )
235 coreconfigitem('convert', 'cvsps.mergefrom',
235 coreconfigitem('convert', 'cvsps.mergefrom',
236 default=None,
236 default=None,
237 )
237 )
238 coreconfigitem('convert', 'cvsps.mergeto',
238 coreconfigitem('convert', 'cvsps.mergeto',
239 default=None,
239 default=None,
240 )
240 )
241 coreconfigitem('convert', 'git.committeractions',
241 coreconfigitem('convert', 'git.committeractions',
242 default=lambda: ['messagedifferent'],
242 default=lambda: ['messagedifferent'],
243 )
243 )
244 coreconfigitem('convert', 'git.extrakeys',
244 coreconfigitem('convert', 'git.extrakeys',
245 default=list,
245 default=list,
246 )
246 )
247 coreconfigitem('convert', 'git.findcopiesharder',
247 coreconfigitem('convert', 'git.findcopiesharder',
248 default=False,
248 default=False,
249 )
249 )
250 coreconfigitem('convert', 'git.remoteprefix',
250 coreconfigitem('convert', 'git.remoteprefix',
251 default='remote',
251 default='remote',
252 )
252 )
253 coreconfigitem('convert', 'git.renamelimit',
253 coreconfigitem('convert', 'git.renamelimit',
254 default=400,
254 default=400,
255 )
255 )
256 coreconfigitem('convert', 'git.saverev',
256 coreconfigitem('convert', 'git.saverev',
257 default=True,
257 default=True,
258 )
258 )
259 coreconfigitem('convert', 'git.similarity',
259 coreconfigitem('convert', 'git.similarity',
260 default=50,
260 default=50,
261 )
261 )
262 coreconfigitem('convert', 'git.skipsubmodules',
262 coreconfigitem('convert', 'git.skipsubmodules',
263 default=False,
263 default=False,
264 )
264 )
265 coreconfigitem('convert', 'hg.clonebranches',
265 coreconfigitem('convert', 'hg.clonebranches',
266 default=False,
266 default=False,
267 )
267 )
268 coreconfigitem('convert', 'hg.ignoreerrors',
268 coreconfigitem('convert', 'hg.ignoreerrors',
269 default=False,
269 default=False,
270 )
270 )
271 coreconfigitem('convert', 'hg.revs',
271 coreconfigitem('convert', 'hg.revs',
272 default=None,
272 default=None,
273 )
273 )
274 coreconfigitem('convert', 'hg.saverev',
274 coreconfigitem('convert', 'hg.saverev',
275 default=False,
275 default=False,
276 )
276 )
277 coreconfigitem('convert', 'hg.sourcename',
277 coreconfigitem('convert', 'hg.sourcename',
278 default=None,
278 default=None,
279 )
279 )
280 coreconfigitem('convert', 'hg.startrev',
280 coreconfigitem('convert', 'hg.startrev',
281 default=None,
281 default=None,
282 )
282 )
283 coreconfigitem('convert', 'hg.tagsbranch',
283 coreconfigitem('convert', 'hg.tagsbranch',
284 default='default',
284 default='default',
285 )
285 )
286 coreconfigitem('convert', 'hg.usebranchnames',
286 coreconfigitem('convert', 'hg.usebranchnames',
287 default=True,
287 default=True,
288 )
288 )
289 coreconfigitem('convert', 'ignoreancestorcheck',
289 coreconfigitem('convert', 'ignoreancestorcheck',
290 default=False,
290 default=False,
291 )
291 )
292 coreconfigitem('convert', 'localtimezone',
292 coreconfigitem('convert', 'localtimezone',
293 default=False,
293 default=False,
294 )
294 )
295 coreconfigitem('convert', 'p4.encoding',
295 coreconfigitem('convert', 'p4.encoding',
296 default=dynamicdefault,
296 default=dynamicdefault,
297 )
297 )
298 coreconfigitem('convert', 'p4.startrev',
298 coreconfigitem('convert', 'p4.startrev',
299 default=0,
299 default=0,
300 )
300 )
301 coreconfigitem('convert', 'skiptags',
301 coreconfigitem('convert', 'skiptags',
302 default=False,
302 default=False,
303 )
303 )
304 coreconfigitem('convert', 'svn.debugsvnlog',
304 coreconfigitem('convert', 'svn.debugsvnlog',
305 default=True,
305 default=True,
306 )
306 )
307 coreconfigitem('convert', 'svn.trunk',
307 coreconfigitem('convert', 'svn.trunk',
308 default=None,
308 default=None,
309 )
309 )
310 coreconfigitem('convert', 'svn.tags',
310 coreconfigitem('convert', 'svn.tags',
311 default=None,
311 default=None,
312 )
312 )
313 coreconfigitem('convert', 'svn.branches',
313 coreconfigitem('convert', 'svn.branches',
314 default=None,
314 default=None,
315 )
315 )
316 coreconfigitem('convert', 'svn.startrev',
316 coreconfigitem('convert', 'svn.startrev',
317 default=0,
317 default=0,
318 )
318 )
319 coreconfigitem('debug', 'dirstate.delaywrite',
319 coreconfigitem('debug', 'dirstate.delaywrite',
320 default=0,
320 default=0,
321 )
321 )
322 coreconfigitem('defaults', '.*',
322 coreconfigitem('defaults', '.*',
323 default=None,
323 default=None,
324 generic=True,
324 generic=True,
325 )
325 )
326 coreconfigitem('devel', 'all-warnings',
326 coreconfigitem('devel', 'all-warnings',
327 default=False,
327 default=False,
328 )
328 )
329 coreconfigitem('devel', 'bundle2.debug',
329 coreconfigitem('devel', 'bundle2.debug',
330 default=False,
330 default=False,
331 )
331 )
332 coreconfigitem('devel', 'bundle.delta',
332 coreconfigitem('devel', 'bundle.delta',
333 default='',
333 default='',
334 )
334 )
335 coreconfigitem('devel', 'cache-vfs',
335 coreconfigitem('devel', 'cache-vfs',
336 default=None,
336 default=None,
337 )
337 )
338 coreconfigitem('devel', 'check-locks',
338 coreconfigitem('devel', 'check-locks',
339 default=False,
339 default=False,
340 )
340 )
341 coreconfigitem('devel', 'check-relroot',
341 coreconfigitem('devel', 'check-relroot',
342 default=False,
342 default=False,
343 )
343 )
344 coreconfigitem('devel', 'default-date',
344 coreconfigitem('devel', 'default-date',
345 default=None,
345 default=None,
346 )
346 )
347 coreconfigitem('devel', 'deprec-warn',
347 coreconfigitem('devel', 'deprec-warn',
348 default=False,
348 default=False,
349 )
349 )
350 coreconfigitem('devel', 'disableloaddefaultcerts',
350 coreconfigitem('devel', 'disableloaddefaultcerts',
351 default=False,
351 default=False,
352 )
352 )
353 coreconfigitem('devel', 'warn-empty-changegroup',
353 coreconfigitem('devel', 'warn-empty-changegroup',
354 default=False,
354 default=False,
355 )
355 )
356 coreconfigitem('devel', 'legacy.exchange',
356 coreconfigitem('devel', 'legacy.exchange',
357 default=list,
357 default=list,
358 )
358 )
359 coreconfigitem('devel', 'servercafile',
359 coreconfigitem('devel', 'servercafile',
360 default='',
360 default='',
361 )
361 )
362 coreconfigitem('devel', 'serverexactprotocol',
362 coreconfigitem('devel', 'serverexactprotocol',
363 default='',
363 default='',
364 )
364 )
365 coreconfigitem('devel', 'serverrequirecert',
365 coreconfigitem('devel', 'serverrequirecert',
366 default=False,
366 default=False,
367 )
367 )
368 coreconfigitem('devel', 'strip-obsmarkers',
368 coreconfigitem('devel', 'strip-obsmarkers',
369 default=True,
369 default=True,
370 )
370 )
371 coreconfigitem('devel', 'warn-config',
371 coreconfigitem('devel', 'warn-config',
372 default=None,
372 default=None,
373 )
373 )
374 coreconfigitem('devel', 'warn-config-default',
374 coreconfigitem('devel', 'warn-config-default',
375 default=None,
375 default=None,
376 )
376 )
377 coreconfigitem('devel', 'user.obsmarker',
377 coreconfigitem('devel', 'user.obsmarker',
378 default=None,
378 default=None,
379 )
379 )
380 coreconfigitem('devel', 'warn-config-unknown',
380 coreconfigitem('devel', 'warn-config-unknown',
381 default=None,
381 default=None,
382 )
382 )
383 coreconfigitem('devel', 'debug.copies',
383 coreconfigitem('devel', 'debug.copies',
384 default=False,
384 default=False,
385 )
385 )
386 coreconfigitem('devel', 'debug.extensions',
386 coreconfigitem('devel', 'debug.extensions',
387 default=False,
387 default=False,
388 )
388 )
389 coreconfigitem('devel', 'debug.peer-request',
389 coreconfigitem('devel', 'debug.peer-request',
390 default=False,
390 default=False,
391 )
391 )
392 coreconfigitem('diff', 'nodates',
392 coreconfigitem('diff', 'nodates',
393 default=False,
393 default=False,
394 )
394 )
395 coreconfigitem('diff', 'showfunc',
395 coreconfigitem('diff', 'showfunc',
396 default=False,
396 default=False,
397 )
397 )
398 coreconfigitem('diff', 'unified',
398 coreconfigitem('diff', 'unified',
399 default=None,
399 default=None,
400 )
400 )
401 coreconfigitem('diff', 'git',
401 coreconfigitem('diff', 'git',
402 default=False,
402 default=False,
403 )
403 )
404 coreconfigitem('diff', 'ignorews',
404 coreconfigitem('diff', 'ignorews',
405 default=False,
405 default=False,
406 )
406 )
407 coreconfigitem('diff', 'ignorewsamount',
407 coreconfigitem('diff', 'ignorewsamount',
408 default=False,
408 default=False,
409 )
409 )
410 coreconfigitem('diff', 'ignoreblanklines',
410 coreconfigitem('diff', 'ignoreblanklines',
411 default=False,
411 default=False,
412 )
412 )
413 coreconfigitem('diff', 'ignorewseol',
413 coreconfigitem('diff', 'ignorewseol',
414 default=False,
414 default=False,
415 )
415 )
416 coreconfigitem('diff', 'nobinary',
416 coreconfigitem('diff', 'nobinary',
417 default=False,
417 default=False,
418 )
418 )
419 coreconfigitem('diff', 'noprefix',
419 coreconfigitem('diff', 'noprefix',
420 default=False,
420 default=False,
421 )
421 )
422 coreconfigitem('diff', 'word-diff',
422 coreconfigitem('diff', 'word-diff',
423 default=False,
423 default=False,
424 )
424 )
425 coreconfigitem('email', 'bcc',
425 coreconfigitem('email', 'bcc',
426 default=None,
426 default=None,
427 )
427 )
428 coreconfigitem('email', 'cc',
428 coreconfigitem('email', 'cc',
429 default=None,
429 default=None,
430 )
430 )
431 coreconfigitem('email', 'charsets',
431 coreconfigitem('email', 'charsets',
432 default=list,
432 default=list,
433 )
433 )
434 coreconfigitem('email', 'from',
434 coreconfigitem('email', 'from',
435 default=None,
435 default=None,
436 )
436 )
437 coreconfigitem('email', 'method',
437 coreconfigitem('email', 'method',
438 default='smtp',
438 default='smtp',
439 )
439 )
440 coreconfigitem('email', 'reply-to',
440 coreconfigitem('email', 'reply-to',
441 default=None,
441 default=None,
442 )
442 )
443 coreconfigitem('email', 'to',
443 coreconfigitem('email', 'to',
444 default=None,
444 default=None,
445 )
445 )
446 coreconfigitem('experimental', 'archivemetatemplate',
446 coreconfigitem('experimental', 'archivemetatemplate',
447 default=dynamicdefault,
447 default=dynamicdefault,
448 )
448 )
449 coreconfigitem('experimental', 'bundle-phases',
449 coreconfigitem('experimental', 'bundle-phases',
450 default=False,
450 default=False,
451 )
451 )
452 coreconfigitem('experimental', 'bundle2-advertise',
452 coreconfigitem('experimental', 'bundle2-advertise',
453 default=True,
453 default=True,
454 )
454 )
455 coreconfigitem('experimental', 'bundle2-output-capture',
455 coreconfigitem('experimental', 'bundle2-output-capture',
456 default=False,
456 default=False,
457 )
457 )
458 coreconfigitem('experimental', 'bundle2.pushback',
458 coreconfigitem('experimental', 'bundle2.pushback',
459 default=False,
459 default=False,
460 )
460 )
461 coreconfigitem('experimental', 'bundle2lazylocking',
461 coreconfigitem('experimental', 'bundle2lazylocking',
462 default=False,
462 default=False,
463 )
463 )
464 coreconfigitem('experimental', 'bundlecomplevel',
464 coreconfigitem('experimental', 'bundlecomplevel',
465 default=None,
465 default=None,
466 )
466 )
467 coreconfigitem('experimental', 'bundlecomplevel.bzip2',
467 coreconfigitem('experimental', 'bundlecomplevel.bzip2',
468 default=None,
468 default=None,
469 )
469 )
470 coreconfigitem('experimental', 'bundlecomplevel.gzip',
470 coreconfigitem('experimental', 'bundlecomplevel.gzip',
471 default=None,
471 default=None,
472 )
472 )
473 coreconfigitem('experimental', 'bundlecomplevel.none',
473 coreconfigitem('experimental', 'bundlecomplevel.none',
474 default=None,
474 default=None,
475 )
475 )
476 coreconfigitem('experimental', 'bundlecomplevel.zstd',
476 coreconfigitem('experimental', 'bundlecomplevel.zstd',
477 default=None,
477 default=None,
478 )
478 )
479 coreconfigitem('experimental', 'changegroup3',
479 coreconfigitem('experimental', 'changegroup3',
480 default=False,
480 default=False,
481 )
481 )
482 coreconfigitem('experimental', 'clientcompressionengines',
482 coreconfigitem('experimental', 'clientcompressionengines',
483 default=list,
483 default=list,
484 )
484 )
485 coreconfigitem('experimental', 'copytrace',
485 coreconfigitem('experimental', 'copytrace',
486 default='on',
486 default='on',
487 )
487 )
488 coreconfigitem('experimental', 'copytrace.movecandidateslimit',
488 coreconfigitem('experimental', 'copytrace.movecandidateslimit',
489 default=100,
489 default=100,
490 )
490 )
491 coreconfigitem('experimental', 'copytrace.sourcecommitlimit',
491 coreconfigitem('experimental', 'copytrace.sourcecommitlimit',
492 default=100,
492 default=100,
493 )
493 )
494 coreconfigitem('experimental', 'crecordtest',
494 coreconfigitem('experimental', 'crecordtest',
495 default=None,
495 default=None,
496 )
496 )
497 coreconfigitem('experimental', 'directaccess',
497 coreconfigitem('experimental', 'directaccess',
498 default=False,
498 default=False,
499 )
499 )
500 coreconfigitem('experimental', 'directaccess.revnums',
500 coreconfigitem('experimental', 'directaccess.revnums',
501 default=False,
501 default=False,
502 )
502 )
503 coreconfigitem('experimental', 'editortmpinhg',
503 coreconfigitem('experimental', 'editortmpinhg',
504 default=False,
504 default=False,
505 )
505 )
506 coreconfigitem('experimental', 'evolution',
506 coreconfigitem('experimental', 'evolution',
507 default=list,
507 default=list,
508 )
508 )
509 coreconfigitem('experimental', 'evolution.allowdivergence',
509 coreconfigitem('experimental', 'evolution.allowdivergence',
510 default=False,
510 default=False,
511 alias=[('experimental', 'allowdivergence')]
511 alias=[('experimental', 'allowdivergence')]
512 )
512 )
513 coreconfigitem('experimental', 'evolution.allowunstable',
513 coreconfigitem('experimental', 'evolution.allowunstable',
514 default=None,
514 default=None,
515 )
515 )
516 coreconfigitem('experimental', 'evolution.createmarkers',
516 coreconfigitem('experimental', 'evolution.createmarkers',
517 default=None,
517 default=None,
518 )
518 )
519 coreconfigitem('experimental', 'evolution.effect-flags',
519 coreconfigitem('experimental', 'evolution.effect-flags',
520 default=True,
520 default=True,
521 alias=[('experimental', 'effect-flags')]
521 alias=[('experimental', 'effect-flags')]
522 )
522 )
523 coreconfigitem('experimental', 'evolution.exchange',
523 coreconfigitem('experimental', 'evolution.exchange',
524 default=None,
524 default=None,
525 )
525 )
526 coreconfigitem('experimental', 'evolution.bundle-obsmarker',
526 coreconfigitem('experimental', 'evolution.bundle-obsmarker',
527 default=False,
527 default=False,
528 )
528 )
529 coreconfigitem('experimental', 'evolution.report-instabilities',
529 coreconfigitem('experimental', 'evolution.report-instabilities',
530 default=True,
530 default=True,
531 )
531 )
532 coreconfigitem('experimental', 'evolution.track-operation',
532 coreconfigitem('experimental', 'evolution.track-operation',
533 default=True,
533 default=True,
534 )
534 )
535 coreconfigitem('experimental', 'maxdeltachainspan',
535 coreconfigitem('experimental', 'maxdeltachainspan',
536 default=-1,
536 default=-1,
537 )
537 )
538 coreconfigitem('experimental', 'mergetempdirprefix',
538 coreconfigitem('experimental', 'mergetempdirprefix',
539 default=None,
539 default=None,
540 )
540 )
541 coreconfigitem('experimental', 'mmapindexthreshold',
541 coreconfigitem('experimental', 'mmapindexthreshold',
542 default=None,
542 default=None,
543 )
543 )
544 coreconfigitem('experimental', 'narrow',
544 coreconfigitem('experimental', 'narrow',
545 default=False,
545 default=False,
546 )
546 )
547 coreconfigitem('experimental', 'nonnormalparanoidcheck',
547 coreconfigitem('experimental', 'nonnormalparanoidcheck',
548 default=False,
548 default=False,
549 )
549 )
550 coreconfigitem('experimental', 'exportableenviron',
550 coreconfigitem('experimental', 'exportableenviron',
551 default=list,
551 default=list,
552 )
552 )
553 coreconfigitem('experimental', 'extendedheader.index',
553 coreconfigitem('experimental', 'extendedheader.index',
554 default=None,
554 default=None,
555 )
555 )
556 coreconfigitem('experimental', 'extendedheader.similarity',
556 coreconfigitem('experimental', 'extendedheader.similarity',
557 default=False,
557 default=False,
558 )
558 )
559 coreconfigitem('experimental', 'format.compression',
559 coreconfigitem('experimental', 'format.compression',
560 default='zlib',
560 default='zlib',
561 )
561 )
562 coreconfigitem('experimental', 'graphshorten',
562 coreconfigitem('experimental', 'graphshorten',
563 default=False,
563 default=False,
564 )
564 )
565 coreconfigitem('experimental', 'graphstyle.parent',
565 coreconfigitem('experimental', 'graphstyle.parent',
566 default=dynamicdefault,
566 default=dynamicdefault,
567 )
567 )
568 coreconfigitem('experimental', 'graphstyle.missing',
568 coreconfigitem('experimental', 'graphstyle.missing',
569 default=dynamicdefault,
569 default=dynamicdefault,
570 )
570 )
571 coreconfigitem('experimental', 'graphstyle.grandparent',
571 coreconfigitem('experimental', 'graphstyle.grandparent',
572 default=dynamicdefault,
572 default=dynamicdefault,
573 )
573 )
574 coreconfigitem('experimental', 'hook-track-tags',
574 coreconfigitem('experimental', 'hook-track-tags',
575 default=False,
575 default=False,
576 )
576 )
577 coreconfigitem('experimental', 'httppeer.advertise-v2',
577 coreconfigitem('experimental', 'httppeer.advertise-v2',
578 default=False,
578 default=False,
579 )
579 )
580 coreconfigitem('experimental', 'httppeer.v2-encoder-order',
580 coreconfigitem('experimental', 'httppeer.v2-encoder-order',
581 default=None,
581 default=None,
582 )
582 )
583 coreconfigitem('experimental', 'httppostargs',
583 coreconfigitem('experimental', 'httppostargs',
584 default=False,
584 default=False,
585 )
585 )
586 coreconfigitem('experimental', 'mergedriver',
586 coreconfigitem('experimental', 'mergedriver',
587 default=None,
587 default=None,
588 )
588 )
589 coreconfigitem('experimental', 'nointerrupt', default=False)
589 coreconfigitem('experimental', 'nointerrupt', default=False)
590 coreconfigitem('experimental', 'nointerrupt-interactiveonly', default=True)
590 coreconfigitem('experimental', 'nointerrupt-interactiveonly', default=True)
591
591
592 coreconfigitem('experimental', 'obsmarkers-exchange-debug',
592 coreconfigitem('experimental', 'obsmarkers-exchange-debug',
593 default=False,
593 default=False,
594 )
594 )
595 coreconfigitem('experimental', 'remotenames',
595 coreconfigitem('experimental', 'remotenames',
596 default=False,
596 default=False,
597 )
597 )
598 coreconfigitem('experimental', 'removeemptydirs',
598 coreconfigitem('experimental', 'removeemptydirs',
599 default=True,
599 default=True,
600 )
600 )
601 coreconfigitem('experimental', 'revisions.prefixhexnode',
601 coreconfigitem('experimental', 'revisions.prefixhexnode',
602 default=False,
602 default=False,
603 )
603 )
604 coreconfigitem('experimental', 'revlogv2',
604 coreconfigitem('experimental', 'revlogv2',
605 default=None,
605 default=None,
606 )
606 )
607 coreconfigitem('experimental', 'revisions.disambiguatewithin',
607 coreconfigitem('experimental', 'revisions.disambiguatewithin',
608 default=None,
608 default=None,
609 )
609 )
610 coreconfigitem('experimental', 'server.filesdata.recommended-batch-size',
610 coreconfigitem('experimental', 'server.filesdata.recommended-batch-size',
611 default=50000,
611 default=50000,
612 )
612 )
613 coreconfigitem('experimental', 'server.manifestdata.recommended-batch-size',
613 coreconfigitem('experimental', 'server.manifestdata.recommended-batch-size',
614 default=100000,
614 default=100000,
615 )
615 )
616 coreconfigitem('experimental', 'server.stream-narrow-clones',
616 coreconfigitem('experimental', 'server.stream-narrow-clones',
617 default=False,
617 default=False,
618 )
618 )
619 coreconfigitem('experimental', 'single-head-per-branch',
619 coreconfigitem('experimental', 'single-head-per-branch',
620 default=False,
620 default=False,
621 )
621 )
622 coreconfigitem('experimental', 'sshserver.support-v2',
622 coreconfigitem('experimental', 'sshserver.support-v2',
623 default=False,
623 default=False,
624 )
624 )
625 coreconfigitem('experimental', 'sparse-read',
625 coreconfigitem('experimental', 'sparse-read',
626 default=False,
626 default=False,
627 )
627 )
628 coreconfigitem('experimental', 'sparse-read.density-threshold',
628 coreconfigitem('experimental', 'sparse-read.density-threshold',
629 default=0.50,
629 default=0.50,
630 )
630 )
631 coreconfigitem('experimental', 'sparse-read.min-gap-size',
631 coreconfigitem('experimental', 'sparse-read.min-gap-size',
632 default='65K',
632 default='65K',
633 )
633 )
634 coreconfigitem('experimental', 'treemanifest',
634 coreconfigitem('experimental', 'treemanifest',
635 default=False,
635 default=False,
636 )
636 )
637 coreconfigitem('experimental', 'update.atomic-file',
637 coreconfigitem('experimental', 'update.atomic-file',
638 default=False,
638 default=False,
639 )
639 )
640 coreconfigitem('experimental', 'sshpeer.advertise-v2',
640 coreconfigitem('experimental', 'sshpeer.advertise-v2',
641 default=False,
641 default=False,
642 )
642 )
643 coreconfigitem('experimental', 'web.apiserver',
643 coreconfigitem('experimental', 'web.apiserver',
644 default=False,
644 default=False,
645 )
645 )
646 coreconfigitem('experimental', 'web.api.http-v2',
646 coreconfigitem('experimental', 'web.api.http-v2',
647 default=False,
647 default=False,
648 )
648 )
649 coreconfigitem('experimental', 'web.api.debugreflect',
649 coreconfigitem('experimental', 'web.api.debugreflect',
650 default=False,
650 default=False,
651 )
651 )
652 coreconfigitem('experimental', 'worker.wdir-get-thread-safe',
652 coreconfigitem('experimental', 'worker.wdir-get-thread-safe',
653 default=False,
653 default=False,
654 )
654 )
655 coreconfigitem('experimental', 'xdiff',
655 coreconfigitem('experimental', 'xdiff',
656 default=False,
656 default=False,
657 )
657 )
658 coreconfigitem('extensions', '.*',
658 coreconfigitem('extensions', '.*',
659 default=None,
659 default=None,
660 generic=True,
660 generic=True,
661 )
661 )
662 coreconfigitem('extdata', '.*',
662 coreconfigitem('extdata', '.*',
663 default=None,
663 default=None,
664 generic=True,
664 generic=True,
665 )
665 )
666 coreconfigitem('format', 'chunkcachesize',
666 coreconfigitem('format', 'chunkcachesize',
667 default=None,
667 default=None,
668 )
668 )
669 coreconfigitem('format', 'dotencode',
669 coreconfigitem('format', 'dotencode',
670 default=True,
670 default=True,
671 )
671 )
672 coreconfigitem('format', 'generaldelta',
672 coreconfigitem('format', 'generaldelta',
673 default=False,
673 default=False,
674 )
674 )
675 coreconfigitem('format', 'manifestcachesize',
675 coreconfigitem('format', 'manifestcachesize',
676 default=None,
676 default=None,
677 )
677 )
678 coreconfigitem('format', 'maxchainlen',
678 coreconfigitem('format', 'maxchainlen',
679 default=dynamicdefault,
679 default=dynamicdefault,
680 )
680 )
681 coreconfigitem('format', 'obsstore-version',
681 coreconfigitem('format', 'obsstore-version',
682 default=None,
682 default=None,
683 )
683 )
684 coreconfigitem('format', 'sparse-revlog',
684 coreconfigitem('format', 'sparse-revlog',
685 default=False,
685 default=False,
686 )
686 )
687 coreconfigitem('format', 'usefncache',
687 coreconfigitem('format', 'usefncache',
688 default=True,
688 default=True,
689 )
689 )
690 coreconfigitem('format', 'usegeneraldelta',
690 coreconfigitem('format', 'usegeneraldelta',
691 default=True,
691 default=True,
692 )
692 )
693 coreconfigitem('format', 'usestore',
693 coreconfigitem('format', 'usestore',
694 default=True,
694 default=True,
695 )
695 )
696 coreconfigitem('format', 'internal-phase',
696 coreconfigitem('format', 'internal-phase',
697 default=False,
697 default=False,
698 )
698 )
699 coreconfigitem('fsmonitor', 'warn_when_unused',
699 coreconfigitem('fsmonitor', 'warn_when_unused',
700 default=True,
700 default=True,
701 )
701 )
702 coreconfigitem('fsmonitor', 'warn_update_file_count',
702 coreconfigitem('fsmonitor', 'warn_update_file_count',
703 default=50000,
703 default=50000,
704 )
704 )
705 coreconfigitem('help', 'hidden-command\..*',
705 coreconfigitem('help', 'hidden-command\..*',
706 default=False,
706 default=False,
707 generic=True,
707 generic=True,
708 )
708 )
709 coreconfigitem('help', 'hidden-topic\..*',
709 coreconfigitem('help', 'hidden-topic\..*',
710 default=False,
710 default=False,
711 generic=True,
711 generic=True,
712 )
712 )
713 coreconfigitem('hooks', '.*',
713 coreconfigitem('hooks', '.*',
714 default=dynamicdefault,
714 default=dynamicdefault,
715 generic=True,
715 generic=True,
716 )
716 )
717 coreconfigitem('hgweb-paths', '.*',
717 coreconfigitem('hgweb-paths', '.*',
718 default=list,
718 default=list,
719 generic=True,
719 generic=True,
720 )
720 )
721 coreconfigitem('hostfingerprints', '.*',
721 coreconfigitem('hostfingerprints', '.*',
722 default=list,
722 default=list,
723 generic=True,
723 generic=True,
724 )
724 )
725 coreconfigitem('hostsecurity', 'ciphers',
725 coreconfigitem('hostsecurity', 'ciphers',
726 default=None,
726 default=None,
727 )
727 )
728 coreconfigitem('hostsecurity', 'disabletls10warning',
728 coreconfigitem('hostsecurity', 'disabletls10warning',
729 default=False,
729 default=False,
730 )
730 )
731 coreconfigitem('hostsecurity', 'minimumprotocol',
731 coreconfigitem('hostsecurity', 'minimumprotocol',
732 default=dynamicdefault,
732 default=dynamicdefault,
733 )
733 )
734 coreconfigitem('hostsecurity', '.*:minimumprotocol$',
734 coreconfigitem('hostsecurity', '.*:minimumprotocol$',
735 default=dynamicdefault,
735 default=dynamicdefault,
736 generic=True,
736 generic=True,
737 )
737 )
738 coreconfigitem('hostsecurity', '.*:ciphers$',
738 coreconfigitem('hostsecurity', '.*:ciphers$',
739 default=dynamicdefault,
739 default=dynamicdefault,
740 generic=True,
740 generic=True,
741 )
741 )
742 coreconfigitem('hostsecurity', '.*:fingerprints$',
742 coreconfigitem('hostsecurity', '.*:fingerprints$',
743 default=list,
743 default=list,
744 generic=True,
744 generic=True,
745 )
745 )
746 coreconfigitem('hostsecurity', '.*:verifycertsfile$',
746 coreconfigitem('hostsecurity', '.*:verifycertsfile$',
747 default=None,
747 default=None,
748 generic=True,
748 generic=True,
749 )
749 )
750
750
751 coreconfigitem('http_proxy', 'always',
751 coreconfigitem('http_proxy', 'always',
752 default=False,
752 default=False,
753 )
753 )
754 coreconfigitem('http_proxy', 'host',
754 coreconfigitem('http_proxy', 'host',
755 default=None,
755 default=None,
756 )
756 )
757 coreconfigitem('http_proxy', 'no',
757 coreconfigitem('http_proxy', 'no',
758 default=list,
758 default=list,
759 )
759 )
760 coreconfigitem('http_proxy', 'passwd',
760 coreconfigitem('http_proxy', 'passwd',
761 default=None,
761 default=None,
762 )
762 )
763 coreconfigitem('http_proxy', 'user',
763 coreconfigitem('http_proxy', 'user',
764 default=None,
764 default=None,
765 )
765 )
766
766
767 coreconfigitem('http', 'timeout',
767 coreconfigitem('http', 'timeout',
768 default=None,
768 default=None,
769 )
769 )
770
770
771 coreconfigitem('logtoprocess', 'commandexception',
771 coreconfigitem('logtoprocess', 'commandexception',
772 default=None,
772 default=None,
773 )
773 )
774 coreconfigitem('logtoprocess', 'commandfinish',
774 coreconfigitem('logtoprocess', 'commandfinish',
775 default=None,
775 default=None,
776 )
776 )
777 coreconfigitem('logtoprocess', 'command',
777 coreconfigitem('logtoprocess', 'command',
778 default=None,
778 default=None,
779 )
779 )
780 coreconfigitem('logtoprocess', 'develwarn',
780 coreconfigitem('logtoprocess', 'develwarn',
781 default=None,
781 default=None,
782 )
782 )
783 coreconfigitem('logtoprocess', 'uiblocked',
783 coreconfigitem('logtoprocess', 'uiblocked',
784 default=None,
784 default=None,
785 )
785 )
786 coreconfigitem('merge', 'checkunknown',
786 coreconfigitem('merge', 'checkunknown',
787 default='abort',
787 default='abort',
788 )
788 )
789 coreconfigitem('merge', 'checkignored',
789 coreconfigitem('merge', 'checkignored',
790 default='abort',
790 default='abort',
791 )
791 )
792 coreconfigitem('experimental', 'merge.checkpathconflicts',
792 coreconfigitem('experimental', 'merge.checkpathconflicts',
793 default=False,
793 default=False,
794 )
794 )
795 coreconfigitem('merge', 'followcopies',
795 coreconfigitem('merge', 'followcopies',
796 default=True,
796 default=True,
797 )
797 )
798 coreconfigitem('merge', 'on-failure',
798 coreconfigitem('merge', 'on-failure',
799 default='continue',
799 default='continue',
800 )
800 )
801 coreconfigitem('merge', 'preferancestor',
801 coreconfigitem('merge', 'preferancestor',
802 default=lambda: ['*'],
802 default=lambda: ['*'],
803 )
803 )
804 coreconfigitem('merge', 'strict-capability-check',
804 coreconfigitem('merge', 'strict-capability-check',
805 default=False,
805 default=False,
806 )
806 )
807 coreconfigitem('merge-tools', '.*',
807 coreconfigitem('merge-tools', '.*',
808 default=None,
808 default=None,
809 generic=True,
809 generic=True,
810 )
810 )
811 coreconfigitem('merge-tools', br'.*\.args$',
811 coreconfigitem('merge-tools', br'.*\.args$',
812 default="$local $base $other",
812 default="$local $base $other",
813 generic=True,
813 generic=True,
814 priority=-1,
814 priority=-1,
815 )
815 )
816 coreconfigitem('merge-tools', br'.*\.binary$',
816 coreconfigitem('merge-tools', br'.*\.binary$',
817 default=False,
817 default=False,
818 generic=True,
818 generic=True,
819 priority=-1,
819 priority=-1,
820 )
820 )
821 coreconfigitem('merge-tools', br'.*\.check$',
821 coreconfigitem('merge-tools', br'.*\.check$',
822 default=list,
822 default=list,
823 generic=True,
823 generic=True,
824 priority=-1,
824 priority=-1,
825 )
825 )
826 coreconfigitem('merge-tools', br'.*\.checkchanged$',
826 coreconfigitem('merge-tools', br'.*\.checkchanged$',
827 default=False,
827 default=False,
828 generic=True,
828 generic=True,
829 priority=-1,
829 priority=-1,
830 )
830 )
831 coreconfigitem('merge-tools', br'.*\.executable$',
831 coreconfigitem('merge-tools', br'.*\.executable$',
832 default=dynamicdefault,
832 default=dynamicdefault,
833 generic=True,
833 generic=True,
834 priority=-1,
834 priority=-1,
835 )
835 )
836 coreconfigitem('merge-tools', br'.*\.fixeol$',
836 coreconfigitem('merge-tools', br'.*\.fixeol$',
837 default=False,
837 default=False,
838 generic=True,
838 generic=True,
839 priority=-1,
839 priority=-1,
840 )
840 )
841 coreconfigitem('merge-tools', br'.*\.gui$',
841 coreconfigitem('merge-tools', br'.*\.gui$',
842 default=False,
842 default=False,
843 generic=True,
843 generic=True,
844 priority=-1,
844 priority=-1,
845 )
845 )
846 coreconfigitem('merge-tools', br'.*\.mergemarkers$',
846 coreconfigitem('merge-tools', br'.*\.mergemarkers$',
847 default='basic',
847 default='basic',
848 generic=True,
848 generic=True,
849 priority=-1,
849 priority=-1,
850 )
850 )
851 coreconfigitem('merge-tools', br'.*\.mergemarkertemplate$',
851 coreconfigitem('merge-tools', br'.*\.mergemarkertemplate$',
852 default=dynamicdefault, # take from ui.mergemarkertemplate
852 default=dynamicdefault, # take from ui.mergemarkertemplate
853 generic=True,
853 generic=True,
854 priority=-1,
854 priority=-1,
855 )
855 )
856 coreconfigitem('merge-tools', br'.*\.priority$',
856 coreconfigitem('merge-tools', br'.*\.priority$',
857 default=0,
857 default=0,
858 generic=True,
858 generic=True,
859 priority=-1,
859 priority=-1,
860 )
860 )
861 coreconfigitem('merge-tools', br'.*\.premerge$',
861 coreconfigitem('merge-tools', br'.*\.premerge$',
862 default=dynamicdefault,
862 default=dynamicdefault,
863 generic=True,
863 generic=True,
864 priority=-1,
864 priority=-1,
865 )
865 )
866 coreconfigitem('merge-tools', br'.*\.symlink$',
866 coreconfigitem('merge-tools', br'.*\.symlink$',
867 default=False,
867 default=False,
868 generic=True,
868 generic=True,
869 priority=-1,
869 priority=-1,
870 )
870 )
871 coreconfigitem('pager', 'attend-.*',
871 coreconfigitem('pager', 'attend-.*',
872 default=dynamicdefault,
872 default=dynamicdefault,
873 generic=True,
873 generic=True,
874 )
874 )
875 coreconfigitem('pager', 'ignore',
875 coreconfigitem('pager', 'ignore',
876 default=list,
876 default=list,
877 )
877 )
878 coreconfigitem('pager', 'pager',
878 coreconfigitem('pager', 'pager',
879 default=dynamicdefault,
879 default=dynamicdefault,
880 )
880 )
881 coreconfigitem('patch', 'eol',
881 coreconfigitem('patch', 'eol',
882 default='strict',
882 default='strict',
883 )
883 )
884 coreconfigitem('patch', 'fuzz',
884 coreconfigitem('patch', 'fuzz',
885 default=2,
885 default=2,
886 )
886 )
887 coreconfigitem('paths', 'default',
887 coreconfigitem('paths', 'default',
888 default=None,
888 default=None,
889 )
889 )
890 coreconfigitem('paths', 'default-push',
890 coreconfigitem('paths', 'default-push',
891 default=None,
891 default=None,
892 )
892 )
893 coreconfigitem('paths', '.*',
893 coreconfigitem('paths', '.*',
894 default=None,
894 default=None,
895 generic=True,
895 generic=True,
896 )
896 )
897 coreconfigitem('phases', 'checksubrepos',
897 coreconfigitem('phases', 'checksubrepos',
898 default='follow',
898 default='follow',
899 )
899 )
900 coreconfigitem('phases', 'new-commit',
900 coreconfigitem('phases', 'new-commit',
901 default='draft',
901 default='draft',
902 )
902 )
903 coreconfigitem('phases', 'publish',
903 coreconfigitem('phases', 'publish',
904 default=True,
904 default=True,
905 )
905 )
906 coreconfigitem('profiling', 'enabled',
906 coreconfigitem('profiling', 'enabled',
907 default=False,
907 default=False,
908 )
908 )
909 coreconfigitem('profiling', 'format',
909 coreconfigitem('profiling', 'format',
910 default='text',
910 default='text',
911 )
911 )
912 coreconfigitem('profiling', 'freq',
912 coreconfigitem('profiling', 'freq',
913 default=1000,
913 default=1000,
914 )
914 )
915 coreconfigitem('profiling', 'limit',
915 coreconfigitem('profiling', 'limit',
916 default=30,
916 default=30,
917 )
917 )
918 coreconfigitem('profiling', 'nested',
918 coreconfigitem('profiling', 'nested',
919 default=0,
919 default=0,
920 )
920 )
921 coreconfigitem('profiling', 'output',
921 coreconfigitem('profiling', 'output',
922 default=None,
922 default=None,
923 )
923 )
924 coreconfigitem('profiling', 'showmax',
924 coreconfigitem('profiling', 'showmax',
925 default=0.999,
925 default=0.999,
926 )
926 )
927 coreconfigitem('profiling', 'showmin',
927 coreconfigitem('profiling', 'showmin',
928 default=dynamicdefault,
928 default=dynamicdefault,
929 )
929 )
930 coreconfigitem('profiling', 'sort',
930 coreconfigitem('profiling', 'sort',
931 default='inlinetime',
931 default='inlinetime',
932 )
932 )
933 coreconfigitem('profiling', 'statformat',
933 coreconfigitem('profiling', 'statformat',
934 default='hotpath',
934 default='hotpath',
935 )
935 )
936 coreconfigitem('profiling', 'time-track',
936 coreconfigitem('profiling', 'time-track',
937 default=dynamicdefault,
937 default=dynamicdefault,
938 )
938 )
939 coreconfigitem('profiling', 'type',
939 coreconfigitem('profiling', 'type',
940 default='stat',
940 default='stat',
941 )
941 )
942 coreconfigitem('progress', 'assume-tty',
942 coreconfigitem('progress', 'assume-tty',
943 default=False,
943 default=False,
944 )
944 )
945 coreconfigitem('progress', 'changedelay',
945 coreconfigitem('progress', 'changedelay',
946 default=1,
946 default=1,
947 )
947 )
948 coreconfigitem('progress', 'clear-complete',
948 coreconfigitem('progress', 'clear-complete',
949 default=True,
949 default=True,
950 )
950 )
951 coreconfigitem('progress', 'debug',
951 coreconfigitem('progress', 'debug',
952 default=False,
952 default=False,
953 )
953 )
954 coreconfigitem('progress', 'delay',
954 coreconfigitem('progress', 'delay',
955 default=3,
955 default=3,
956 )
956 )
957 coreconfigitem('progress', 'disable',
957 coreconfigitem('progress', 'disable',
958 default=False,
958 default=False,
959 )
959 )
960 coreconfigitem('progress', 'estimateinterval',
960 coreconfigitem('progress', 'estimateinterval',
961 default=60.0,
961 default=60.0,
962 )
962 )
963 coreconfigitem('progress', 'format',
963 coreconfigitem('progress', 'format',
964 default=lambda: ['topic', 'bar', 'number', 'estimate'],
964 default=lambda: ['topic', 'bar', 'number', 'estimate'],
965 )
965 )
966 coreconfigitem('progress', 'refresh',
966 coreconfigitem('progress', 'refresh',
967 default=0.1,
967 default=0.1,
968 )
968 )
969 coreconfigitem('progress', 'width',
969 coreconfigitem('progress', 'width',
970 default=dynamicdefault,
970 default=dynamicdefault,
971 )
971 )
972 coreconfigitem('push', 'pushvars.server',
972 coreconfigitem('push', 'pushvars.server',
973 default=False,
973 default=False,
974 )
974 )
975 coreconfigitem('storage', 'new-repo-backend',
975 coreconfigitem('storage', 'new-repo-backend',
976 default='revlogv1',
976 default='revlogv1',
977 )
977 )
978 coreconfigitem('storage', 'revlog.optimize-delta-parent-choice',
978 coreconfigitem('storage', 'revlog.optimize-delta-parent-choice',
979 default=True,
979 default=True,
980 alias=[('format', 'aggressivemergedeltas')],
980 alias=[('format', 'aggressivemergedeltas')],
981 )
981 )
982 coreconfigitem('server', 'bookmarks-pushkey-compat',
982 coreconfigitem('server', 'bookmarks-pushkey-compat',
983 default=True,
983 default=True,
984 )
984 )
985 coreconfigitem('server', 'bundle1',
985 coreconfigitem('server', 'bundle1',
986 default=True,
986 default=True,
987 )
987 )
988 coreconfigitem('server', 'bundle1gd',
988 coreconfigitem('server', 'bundle1gd',
989 default=None,
989 default=None,
990 )
990 )
991 coreconfigitem('server', 'bundle1.pull',
991 coreconfigitem('server', 'bundle1.pull',
992 default=None,
992 default=None,
993 )
993 )
994 coreconfigitem('server', 'bundle1gd.pull',
994 coreconfigitem('server', 'bundle1gd.pull',
995 default=None,
995 default=None,
996 )
996 )
997 coreconfigitem('server', 'bundle1.push',
997 coreconfigitem('server', 'bundle1.push',
998 default=None,
998 default=None,
999 )
999 )
1000 coreconfigitem('server', 'bundle1gd.push',
1000 coreconfigitem('server', 'bundle1gd.push',
1001 default=None,
1001 default=None,
1002 )
1002 )
1003 coreconfigitem('server', 'bundle2.stream',
1003 coreconfigitem('server', 'bundle2.stream',
1004 default=True,
1004 default=True,
1005 alias=[('experimental', 'bundle2.stream')]
1005 alias=[('experimental', 'bundle2.stream')]
1006 )
1006 )
1007 coreconfigitem('server', 'compressionengines',
1007 coreconfigitem('server', 'compressionengines',
1008 default=list,
1008 default=list,
1009 )
1009 )
1010 coreconfigitem('server', 'concurrent-push-mode',
1010 coreconfigitem('server', 'concurrent-push-mode',
1011 default='strict',
1011 default='strict',
1012 )
1012 )
1013 coreconfigitem('server', 'disablefullbundle',
1013 coreconfigitem('server', 'disablefullbundle',
1014 default=False,
1014 default=False,
1015 )
1015 )
1016 coreconfigitem('server', 'maxhttpheaderlen',
1016 coreconfigitem('server', 'maxhttpheaderlen',
1017 default=1024,
1017 default=1024,
1018 )
1018 )
1019 coreconfigitem('server', 'pullbundle',
1019 coreconfigitem('server', 'pullbundle',
1020 default=False,
1020 default=False,
1021 )
1021 )
1022 coreconfigitem('server', 'preferuncompressed',
1022 coreconfigitem('server', 'preferuncompressed',
1023 default=False,
1023 default=False,
1024 )
1024 )
1025 coreconfigitem('server', 'streamunbundle',
1025 coreconfigitem('server', 'streamunbundle',
1026 default=False,
1026 default=False,
1027 )
1027 )
1028 coreconfigitem('server', 'uncompressed',
1028 coreconfigitem('server', 'uncompressed',
1029 default=True,
1029 default=True,
1030 )
1030 )
1031 coreconfigitem('server', 'uncompressedallowsecret',
1031 coreconfigitem('server', 'uncompressedallowsecret',
1032 default=False,
1032 default=False,
1033 )
1033 )
1034 coreconfigitem('server', 'validate',
1034 coreconfigitem('server', 'validate',
1035 default=False,
1035 default=False,
1036 )
1036 )
1037 coreconfigitem('server', 'zliblevel',
1037 coreconfigitem('server', 'zliblevel',
1038 default=-1,
1038 default=-1,
1039 )
1039 )
1040 coreconfigitem('server', 'zstdlevel',
1040 coreconfigitem('server', 'zstdlevel',
1041 default=3,
1041 default=3,
1042 )
1042 )
1043 coreconfigitem('share', 'pool',
1043 coreconfigitem('share', 'pool',
1044 default=None,
1044 default=None,
1045 )
1045 )
1046 coreconfigitem('share', 'poolnaming',
1046 coreconfigitem('share', 'poolnaming',
1047 default='identity',
1047 default='identity',
1048 )
1048 )
1049 coreconfigitem('smtp', 'host',
1049 coreconfigitem('smtp', 'host',
1050 default=None,
1050 default=None,
1051 )
1051 )
1052 coreconfigitem('smtp', 'local_hostname',
1052 coreconfigitem('smtp', 'local_hostname',
1053 default=None,
1053 default=None,
1054 )
1054 )
1055 coreconfigitem('smtp', 'password',
1055 coreconfigitem('smtp', 'password',
1056 default=None,
1056 default=None,
1057 )
1057 )
1058 coreconfigitem('smtp', 'port',
1058 coreconfigitem('smtp', 'port',
1059 default=dynamicdefault,
1059 default=dynamicdefault,
1060 )
1060 )
1061 coreconfigitem('smtp', 'tls',
1061 coreconfigitem('smtp', 'tls',
1062 default='none',
1062 default='none',
1063 )
1063 )
1064 coreconfigitem('smtp', 'username',
1064 coreconfigitem('smtp', 'username',
1065 default=None,
1065 default=None,
1066 )
1066 )
1067 coreconfigitem('sparse', 'missingwarning',
1067 coreconfigitem('sparse', 'missingwarning',
1068 default=True,
1068 default=True,
1069 )
1069 )
1070 coreconfigitem('subrepos', 'allowed',
1070 coreconfigitem('subrepos', 'allowed',
1071 default=dynamicdefault, # to make backporting simpler
1071 default=dynamicdefault, # to make backporting simpler
1072 )
1072 )
1073 coreconfigitem('subrepos', 'hg:allowed',
1073 coreconfigitem('subrepos', 'hg:allowed',
1074 default=dynamicdefault,
1074 default=dynamicdefault,
1075 )
1075 )
1076 coreconfigitem('subrepos', 'git:allowed',
1076 coreconfigitem('subrepos', 'git:allowed',
1077 default=dynamicdefault,
1077 default=dynamicdefault,
1078 )
1078 )
1079 coreconfigitem('subrepos', 'svn:allowed',
1079 coreconfigitem('subrepos', 'svn:allowed',
1080 default=dynamicdefault,
1080 default=dynamicdefault,
1081 )
1081 )
1082 coreconfigitem('templates', '.*',
1082 coreconfigitem('templates', '.*',
1083 default=None,
1083 default=None,
1084 generic=True,
1084 generic=True,
1085 )
1085 )
1086 coreconfigitem('trusted', 'groups',
1086 coreconfigitem('trusted', 'groups',
1087 default=list,
1087 default=list,
1088 )
1088 )
1089 coreconfigitem('trusted', 'users',
1089 coreconfigitem('trusted', 'users',
1090 default=list,
1090 default=list,
1091 )
1091 )
1092 coreconfigitem('ui', '_usedassubrepo',
1092 coreconfigitem('ui', '_usedassubrepo',
1093 default=False,
1093 default=False,
1094 )
1094 )
1095 coreconfigitem('ui', 'allowemptycommit',
1095 coreconfigitem('ui', 'allowemptycommit',
1096 default=False,
1096 default=False,
1097 )
1097 )
1098 coreconfigitem('ui', 'archivemeta',
1098 coreconfigitem('ui', 'archivemeta',
1099 default=True,
1099 default=True,
1100 )
1100 )
1101 coreconfigitem('ui', 'askusername',
1101 coreconfigitem('ui', 'askusername',
1102 default=False,
1102 default=False,
1103 )
1103 )
1104 coreconfigitem('ui', 'clonebundlefallback',
1104 coreconfigitem('ui', 'clonebundlefallback',
1105 default=False,
1105 default=False,
1106 )
1106 )
1107 coreconfigitem('ui', 'clonebundleprefers',
1107 coreconfigitem('ui', 'clonebundleprefers',
1108 default=list,
1108 default=list,
1109 )
1109 )
1110 coreconfigitem('ui', 'clonebundles',
1110 coreconfigitem('ui', 'clonebundles',
1111 default=True,
1111 default=True,
1112 )
1112 )
1113 coreconfigitem('ui', 'color',
1113 coreconfigitem('ui', 'color',
1114 default='auto',
1114 default='auto',
1115 )
1115 )
1116 coreconfigitem('ui', 'commitsubrepos',
1116 coreconfigitem('ui', 'commitsubrepos',
1117 default=False,
1117 default=False,
1118 )
1118 )
1119 coreconfigitem('ui', 'debug',
1119 coreconfigitem('ui', 'debug',
1120 default=False,
1120 default=False,
1121 )
1121 )
1122 coreconfigitem('ui', 'debugger',
1122 coreconfigitem('ui', 'debugger',
1123 default=None,
1123 default=None,
1124 )
1124 )
1125 coreconfigitem('ui', 'editor',
1125 coreconfigitem('ui', 'editor',
1126 default=dynamicdefault,
1126 default=dynamicdefault,
1127 )
1127 )
1128 coreconfigitem('ui', 'fallbackencoding',
1128 coreconfigitem('ui', 'fallbackencoding',
1129 default=None,
1129 default=None,
1130 )
1130 )
1131 coreconfigitem('ui', 'forcecwd',
1131 coreconfigitem('ui', 'forcecwd',
1132 default=None,
1132 default=None,
1133 )
1133 )
1134 coreconfigitem('ui', 'forcemerge',
1134 coreconfigitem('ui', 'forcemerge',
1135 default=None,
1135 default=None,
1136 )
1136 )
1137 coreconfigitem('ui', 'formatdebug',
1137 coreconfigitem('ui', 'formatdebug',
1138 default=False,
1138 default=False,
1139 )
1139 )
1140 coreconfigitem('ui', 'formatjson',
1140 coreconfigitem('ui', 'formatjson',
1141 default=False,
1141 default=False,
1142 )
1142 )
1143 coreconfigitem('ui', 'formatted',
1143 coreconfigitem('ui', 'formatted',
1144 default=None,
1144 default=None,
1145 )
1145 )
1146 coreconfigitem('ui', 'graphnodetemplate',
1146 coreconfigitem('ui', 'graphnodetemplate',
1147 default=None,
1147 default=None,
1148 )
1148 )
1149 coreconfigitem('ui', 'history-editing-backup',
1149 coreconfigitem('ui', 'history-editing-backup',
1150 default=True,
1150 default=True,
1151 )
1151 )
1152 coreconfigitem('ui', 'interactive',
1152 coreconfigitem('ui', 'interactive',
1153 default=None,
1153 default=None,
1154 )
1154 )
1155 coreconfigitem('ui', 'interface',
1155 coreconfigitem('ui', 'interface',
1156 default=None,
1156 default=None,
1157 )
1157 )
1158 coreconfigitem('ui', 'interface.chunkselector',
1158 coreconfigitem('ui', 'interface.chunkselector',
1159 default=None,
1159 default=None,
1160 )
1160 )
1161 coreconfigitem('ui', 'large-file-limit',
1161 coreconfigitem('ui', 'large-file-limit',
1162 default=10000000,
1162 default=10000000,
1163 )
1163 )
1164 coreconfigitem('ui', 'logblockedtimes',
1164 coreconfigitem('ui', 'logblockedtimes',
1165 default=False,
1165 default=False,
1166 )
1166 )
1167 coreconfigitem('ui', 'logtemplate',
1167 coreconfigitem('ui', 'logtemplate',
1168 default=None,
1168 default=None,
1169 )
1169 )
1170 coreconfigitem('ui', 'merge',
1170 coreconfigitem('ui', 'merge',
1171 default=None,
1171 default=None,
1172 )
1172 )
1173 coreconfigitem('ui', 'mergemarkers',
1173 coreconfigitem('ui', 'mergemarkers',
1174 default='basic',
1174 default='basic',
1175 )
1175 )
1176 coreconfigitem('ui', 'mergemarkertemplate',
1176 coreconfigitem('ui', 'mergemarkertemplate',
1177 default=('{node|short} '
1177 default=('{node|short} '
1178 '{ifeq(tags, "tip", "", '
1178 '{ifeq(tags, "tip", "", '
1179 'ifeq(tags, "", "", "{tags} "))}'
1179 'ifeq(tags, "", "", "{tags} "))}'
1180 '{if(bookmarks, "{bookmarks} ")}'
1180 '{if(bookmarks, "{bookmarks} ")}'
1181 '{ifeq(branch, "default", "", "{branch} ")}'
1181 '{ifeq(branch, "default", "", "{branch} ")}'
1182 '- {author|user}: {desc|firstline}')
1182 '- {author|user}: {desc|firstline}')
1183 )
1183 )
1184 coreconfigitem('ui', 'message-output',
1185 default='stdio',
1186 )
1184 coreconfigitem('ui', 'nontty',
1187 coreconfigitem('ui', 'nontty',
1185 default=False,
1188 default=False,
1186 )
1189 )
1187 coreconfigitem('ui', 'origbackuppath',
1190 coreconfigitem('ui', 'origbackuppath',
1188 default=None,
1191 default=None,
1189 )
1192 )
1190 coreconfigitem('ui', 'paginate',
1193 coreconfigitem('ui', 'paginate',
1191 default=True,
1194 default=True,
1192 )
1195 )
1193 coreconfigitem('ui', 'patch',
1196 coreconfigitem('ui', 'patch',
1194 default=None,
1197 default=None,
1195 )
1198 )
1196 coreconfigitem('ui', 'pre-merge-tool-output-template',
1199 coreconfigitem('ui', 'pre-merge-tool-output-template',
1197 default=None,
1200 default=None,
1198 )
1201 )
1199 coreconfigitem('ui', 'portablefilenames',
1202 coreconfigitem('ui', 'portablefilenames',
1200 default='warn',
1203 default='warn',
1201 )
1204 )
1202 coreconfigitem('ui', 'promptecho',
1205 coreconfigitem('ui', 'promptecho',
1203 default=False,
1206 default=False,
1204 )
1207 )
1205 coreconfigitem('ui', 'quiet',
1208 coreconfigitem('ui', 'quiet',
1206 default=False,
1209 default=False,
1207 )
1210 )
1208 coreconfigitem('ui', 'quietbookmarkmove',
1211 coreconfigitem('ui', 'quietbookmarkmove',
1209 default=False,
1212 default=False,
1210 )
1213 )
1211 coreconfigitem('ui', 'remotecmd',
1214 coreconfigitem('ui', 'remotecmd',
1212 default='hg',
1215 default='hg',
1213 )
1216 )
1214 coreconfigitem('ui', 'report_untrusted',
1217 coreconfigitem('ui', 'report_untrusted',
1215 default=True,
1218 default=True,
1216 )
1219 )
1217 coreconfigitem('ui', 'rollback',
1220 coreconfigitem('ui', 'rollback',
1218 default=True,
1221 default=True,
1219 )
1222 )
1220 coreconfigitem('ui', 'signal-safe-lock',
1223 coreconfigitem('ui', 'signal-safe-lock',
1221 default=True,
1224 default=True,
1222 )
1225 )
1223 coreconfigitem('ui', 'slash',
1226 coreconfigitem('ui', 'slash',
1224 default=False,
1227 default=False,
1225 )
1228 )
1226 coreconfigitem('ui', 'ssh',
1229 coreconfigitem('ui', 'ssh',
1227 default='ssh',
1230 default='ssh',
1228 )
1231 )
1229 coreconfigitem('ui', 'ssherrorhint',
1232 coreconfigitem('ui', 'ssherrorhint',
1230 default=None,
1233 default=None,
1231 )
1234 )
1232 coreconfigitem('ui', 'statuscopies',
1235 coreconfigitem('ui', 'statuscopies',
1233 default=False,
1236 default=False,
1234 )
1237 )
1235 coreconfigitem('ui', 'strict',
1238 coreconfigitem('ui', 'strict',
1236 default=False,
1239 default=False,
1237 )
1240 )
1238 coreconfigitem('ui', 'style',
1241 coreconfigitem('ui', 'style',
1239 default='',
1242 default='',
1240 )
1243 )
1241 coreconfigitem('ui', 'supportcontact',
1244 coreconfigitem('ui', 'supportcontact',
1242 default=None,
1245 default=None,
1243 )
1246 )
1244 coreconfigitem('ui', 'textwidth',
1247 coreconfigitem('ui', 'textwidth',
1245 default=78,
1248 default=78,
1246 )
1249 )
1247 coreconfigitem('ui', 'timeout',
1250 coreconfigitem('ui', 'timeout',
1248 default='600',
1251 default='600',
1249 )
1252 )
1250 coreconfigitem('ui', 'timeout.warn',
1253 coreconfigitem('ui', 'timeout.warn',
1251 default=0,
1254 default=0,
1252 )
1255 )
1253 coreconfigitem('ui', 'traceback',
1256 coreconfigitem('ui', 'traceback',
1254 default=False,
1257 default=False,
1255 )
1258 )
1256 coreconfigitem('ui', 'tweakdefaults',
1259 coreconfigitem('ui', 'tweakdefaults',
1257 default=False,
1260 default=False,
1258 )
1261 )
1259 coreconfigitem('ui', 'username',
1262 coreconfigitem('ui', 'username',
1260 alias=[('ui', 'user')]
1263 alias=[('ui', 'user')]
1261 )
1264 )
1262 coreconfigitem('ui', 'verbose',
1265 coreconfigitem('ui', 'verbose',
1263 default=False,
1266 default=False,
1264 )
1267 )
1265 coreconfigitem('verify', 'skipflags',
1268 coreconfigitem('verify', 'skipflags',
1266 default=None,
1269 default=None,
1267 )
1270 )
1268 coreconfigitem('web', 'allowbz2',
1271 coreconfigitem('web', 'allowbz2',
1269 default=False,
1272 default=False,
1270 )
1273 )
1271 coreconfigitem('web', 'allowgz',
1274 coreconfigitem('web', 'allowgz',
1272 default=False,
1275 default=False,
1273 )
1276 )
1274 coreconfigitem('web', 'allow-pull',
1277 coreconfigitem('web', 'allow-pull',
1275 alias=[('web', 'allowpull')],
1278 alias=[('web', 'allowpull')],
1276 default=True,
1279 default=True,
1277 )
1280 )
1278 coreconfigitem('web', 'allow-push',
1281 coreconfigitem('web', 'allow-push',
1279 alias=[('web', 'allow_push')],
1282 alias=[('web', 'allow_push')],
1280 default=list,
1283 default=list,
1281 )
1284 )
1282 coreconfigitem('web', 'allowzip',
1285 coreconfigitem('web', 'allowzip',
1283 default=False,
1286 default=False,
1284 )
1287 )
1285 coreconfigitem('web', 'archivesubrepos',
1288 coreconfigitem('web', 'archivesubrepos',
1286 default=False,
1289 default=False,
1287 )
1290 )
1288 coreconfigitem('web', 'cache',
1291 coreconfigitem('web', 'cache',
1289 default=True,
1292 default=True,
1290 )
1293 )
1291 coreconfigitem('web', 'contact',
1294 coreconfigitem('web', 'contact',
1292 default=None,
1295 default=None,
1293 )
1296 )
1294 coreconfigitem('web', 'deny_push',
1297 coreconfigitem('web', 'deny_push',
1295 default=list,
1298 default=list,
1296 )
1299 )
1297 coreconfigitem('web', 'guessmime',
1300 coreconfigitem('web', 'guessmime',
1298 default=False,
1301 default=False,
1299 )
1302 )
1300 coreconfigitem('web', 'hidden',
1303 coreconfigitem('web', 'hidden',
1301 default=False,
1304 default=False,
1302 )
1305 )
1303 coreconfigitem('web', 'labels',
1306 coreconfigitem('web', 'labels',
1304 default=list,
1307 default=list,
1305 )
1308 )
1306 coreconfigitem('web', 'logoimg',
1309 coreconfigitem('web', 'logoimg',
1307 default='hglogo.png',
1310 default='hglogo.png',
1308 )
1311 )
1309 coreconfigitem('web', 'logourl',
1312 coreconfigitem('web', 'logourl',
1310 default='https://mercurial-scm.org/',
1313 default='https://mercurial-scm.org/',
1311 )
1314 )
1312 coreconfigitem('web', 'accesslog',
1315 coreconfigitem('web', 'accesslog',
1313 default='-',
1316 default='-',
1314 )
1317 )
1315 coreconfigitem('web', 'address',
1318 coreconfigitem('web', 'address',
1316 default='',
1319 default='',
1317 )
1320 )
1318 coreconfigitem('web', 'allow-archive',
1321 coreconfigitem('web', 'allow-archive',
1319 alias=[('web', 'allow_archive')],
1322 alias=[('web', 'allow_archive')],
1320 default=list,
1323 default=list,
1321 )
1324 )
1322 coreconfigitem('web', 'allow_read',
1325 coreconfigitem('web', 'allow_read',
1323 default=list,
1326 default=list,
1324 )
1327 )
1325 coreconfigitem('web', 'baseurl',
1328 coreconfigitem('web', 'baseurl',
1326 default=None,
1329 default=None,
1327 )
1330 )
1328 coreconfigitem('web', 'cacerts',
1331 coreconfigitem('web', 'cacerts',
1329 default=None,
1332 default=None,
1330 )
1333 )
1331 coreconfigitem('web', 'certificate',
1334 coreconfigitem('web', 'certificate',
1332 default=None,
1335 default=None,
1333 )
1336 )
1334 coreconfigitem('web', 'collapse',
1337 coreconfigitem('web', 'collapse',
1335 default=False,
1338 default=False,
1336 )
1339 )
1337 coreconfigitem('web', 'csp',
1340 coreconfigitem('web', 'csp',
1338 default=None,
1341 default=None,
1339 )
1342 )
1340 coreconfigitem('web', 'deny_read',
1343 coreconfigitem('web', 'deny_read',
1341 default=list,
1344 default=list,
1342 )
1345 )
1343 coreconfigitem('web', 'descend',
1346 coreconfigitem('web', 'descend',
1344 default=True,
1347 default=True,
1345 )
1348 )
1346 coreconfigitem('web', 'description',
1349 coreconfigitem('web', 'description',
1347 default="",
1350 default="",
1348 )
1351 )
1349 coreconfigitem('web', 'encoding',
1352 coreconfigitem('web', 'encoding',
1350 default=lambda: encoding.encoding,
1353 default=lambda: encoding.encoding,
1351 )
1354 )
1352 coreconfigitem('web', 'errorlog',
1355 coreconfigitem('web', 'errorlog',
1353 default='-',
1356 default='-',
1354 )
1357 )
1355 coreconfigitem('web', 'ipv6',
1358 coreconfigitem('web', 'ipv6',
1356 default=False,
1359 default=False,
1357 )
1360 )
1358 coreconfigitem('web', 'maxchanges',
1361 coreconfigitem('web', 'maxchanges',
1359 default=10,
1362 default=10,
1360 )
1363 )
1361 coreconfigitem('web', 'maxfiles',
1364 coreconfigitem('web', 'maxfiles',
1362 default=10,
1365 default=10,
1363 )
1366 )
1364 coreconfigitem('web', 'maxshortchanges',
1367 coreconfigitem('web', 'maxshortchanges',
1365 default=60,
1368 default=60,
1366 )
1369 )
1367 coreconfigitem('web', 'motd',
1370 coreconfigitem('web', 'motd',
1368 default='',
1371 default='',
1369 )
1372 )
1370 coreconfigitem('web', 'name',
1373 coreconfigitem('web', 'name',
1371 default=dynamicdefault,
1374 default=dynamicdefault,
1372 )
1375 )
1373 coreconfigitem('web', 'port',
1376 coreconfigitem('web', 'port',
1374 default=8000,
1377 default=8000,
1375 )
1378 )
1376 coreconfigitem('web', 'prefix',
1379 coreconfigitem('web', 'prefix',
1377 default='',
1380 default='',
1378 )
1381 )
1379 coreconfigitem('web', 'push_ssl',
1382 coreconfigitem('web', 'push_ssl',
1380 default=True,
1383 default=True,
1381 )
1384 )
1382 coreconfigitem('web', 'refreshinterval',
1385 coreconfigitem('web', 'refreshinterval',
1383 default=20,
1386 default=20,
1384 )
1387 )
1385 coreconfigitem('web', 'server-header',
1388 coreconfigitem('web', 'server-header',
1386 default=None,
1389 default=None,
1387 )
1390 )
1388 coreconfigitem('web', 'static',
1391 coreconfigitem('web', 'static',
1389 default=None,
1392 default=None,
1390 )
1393 )
1391 coreconfigitem('web', 'staticurl',
1394 coreconfigitem('web', 'staticurl',
1392 default=None,
1395 default=None,
1393 )
1396 )
1394 coreconfigitem('web', 'stripes',
1397 coreconfigitem('web', 'stripes',
1395 default=1,
1398 default=1,
1396 )
1399 )
1397 coreconfigitem('web', 'style',
1400 coreconfigitem('web', 'style',
1398 default='paper',
1401 default='paper',
1399 )
1402 )
1400 coreconfigitem('web', 'templates',
1403 coreconfigitem('web', 'templates',
1401 default=None,
1404 default=None,
1402 )
1405 )
1403 coreconfigitem('web', 'view',
1406 coreconfigitem('web', 'view',
1404 default='served',
1407 default='served',
1405 )
1408 )
1406 coreconfigitem('worker', 'backgroundclose',
1409 coreconfigitem('worker', 'backgroundclose',
1407 default=dynamicdefault,
1410 default=dynamicdefault,
1408 )
1411 )
1409 # Windows defaults to a limit of 512 open files. A buffer of 128
1412 # Windows defaults to a limit of 512 open files. A buffer of 128
1410 # should give us enough headway.
1413 # should give us enough headway.
1411 coreconfigitem('worker', 'backgroundclosemaxqueue',
1414 coreconfigitem('worker', 'backgroundclosemaxqueue',
1412 default=384,
1415 default=384,
1413 )
1416 )
1414 coreconfigitem('worker', 'backgroundcloseminfilecount',
1417 coreconfigitem('worker', 'backgroundcloseminfilecount',
1415 default=2048,
1418 default=2048,
1416 )
1419 )
1417 coreconfigitem('worker', 'backgroundclosethreadcount',
1420 coreconfigitem('worker', 'backgroundclosethreadcount',
1418 default=4,
1421 default=4,
1419 )
1422 )
1420 coreconfigitem('worker', 'enabled',
1423 coreconfigitem('worker', 'enabled',
1421 default=True,
1424 default=True,
1422 )
1425 )
1423 coreconfigitem('worker', 'numcpus',
1426 coreconfigitem('worker', 'numcpus',
1424 default=None,
1427 default=None,
1425 )
1428 )
1426
1429
1427 # Rebase related configuration moved to core because other extension are doing
1430 # Rebase related configuration moved to core because other extension are doing
1428 # strange things. For example, shelve import the extensions to reuse some bit
1431 # strange things. For example, shelve import the extensions to reuse some bit
1429 # without formally loading it.
1432 # without formally loading it.
1430 coreconfigitem('commands', 'rebase.requiredest',
1433 coreconfigitem('commands', 'rebase.requiredest',
1431 default=False,
1434 default=False,
1432 )
1435 )
1433 coreconfigitem('experimental', 'rebaseskipobsolete',
1436 coreconfigitem('experimental', 'rebaseskipobsolete',
1434 default=True,
1437 default=True,
1435 )
1438 )
1436 coreconfigitem('rebase', 'singletransaction',
1439 coreconfigitem('rebase', 'singletransaction',
1437 default=False,
1440 default=False,
1438 )
1441 )
1439 coreconfigitem('rebase', 'experimental.inmemory',
1442 coreconfigitem('rebase', 'experimental.inmemory',
1440 default=False,
1443 default=False,
1441 )
1444 )
@@ -1,2745 +1,2753 b''
1 The Mercurial system uses a set of configuration files to control
1 The Mercurial system uses a set of configuration files to control
2 aspects of its behavior.
2 aspects of its behavior.
3
3
4 Troubleshooting
4 Troubleshooting
5 ===============
5 ===============
6
6
7 If you're having problems with your configuration,
7 If you're having problems with your configuration,
8 :hg:`config --debug` can help you understand what is introducing
8 :hg:`config --debug` can help you understand what is introducing
9 a setting into your environment.
9 a setting into your environment.
10
10
11 See :hg:`help config.syntax` and :hg:`help config.files`
11 See :hg:`help config.syntax` and :hg:`help config.files`
12 for information about how and where to override things.
12 for information about how and where to override things.
13
13
14 Structure
14 Structure
15 =========
15 =========
16
16
17 The configuration files use a simple ini-file format. A configuration
17 The configuration files use a simple ini-file format. A configuration
18 file consists of sections, led by a ``[section]`` header and followed
18 file consists of sections, led by a ``[section]`` header and followed
19 by ``name = value`` entries::
19 by ``name = value`` entries::
20
20
21 [ui]
21 [ui]
22 username = Firstname Lastname <firstname.lastname@example.net>
22 username = Firstname Lastname <firstname.lastname@example.net>
23 verbose = True
23 verbose = True
24
24
25 The above entries will be referred to as ``ui.username`` and
25 The above entries will be referred to as ``ui.username`` and
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27
27
28 Files
28 Files
29 =====
29 =====
30
30
31 Mercurial reads configuration data from several files, if they exist.
31 Mercurial reads configuration data from several files, if they exist.
32 These files do not exist by default and you will have to create the
32 These files do not exist by default and you will have to create the
33 appropriate configuration files yourself:
33 appropriate configuration files yourself:
34
34
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36
36
37 Global configuration like the username setting is typically put into:
37 Global configuration like the username setting is typically put into:
38
38
39 .. container:: windows
39 .. container:: windows
40
40
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42
42
43 .. container:: unix.plan9
43 .. container:: unix.plan9
44
44
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46
46
47 The names of these files depend on the system on which Mercurial is
47 The names of these files depend on the system on which Mercurial is
48 installed. ``*.rc`` files from a single directory are read in
48 installed. ``*.rc`` files from a single directory are read in
49 alphabetical order, later ones overriding earlier ones. Where multiple
49 alphabetical order, later ones overriding earlier ones. Where multiple
50 paths are given below, settings from earlier paths override later
50 paths are given below, settings from earlier paths override later
51 ones.
51 ones.
52
52
53 .. container:: verbose.unix
53 .. container:: verbose.unix
54
54
55 On Unix, the following files are consulted:
55 On Unix, the following files are consulted:
56
56
57 - ``<repo>/.hg/hgrc`` (per-repository)
57 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``$HOME/.hgrc`` (per-user)
58 - ``$HOME/.hgrc`` (per-user)
59 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
59 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
60 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
61 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
62 - ``/etc/mercurial/hgrc`` (per-system)
62 - ``/etc/mercurial/hgrc`` (per-system)
63 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
64 - ``<internal>/default.d/*.rc`` (defaults)
64 - ``<internal>/default.d/*.rc`` (defaults)
65
65
66 .. container:: verbose.windows
66 .. container:: verbose.windows
67
67
68 On Windows, the following files are consulted:
68 On Windows, the following files are consulted:
69
69
70 - ``<repo>/.hg/hgrc`` (per-repository)
70 - ``<repo>/.hg/hgrc`` (per-repository)
71 - ``%USERPROFILE%\.hgrc`` (per-user)
71 - ``%USERPROFILE%\.hgrc`` (per-user)
72 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
73 - ``%HOME%\.hgrc`` (per-user)
73 - ``%HOME%\.hgrc`` (per-user)
74 - ``%HOME%\Mercurial.ini`` (per-user)
74 - ``%HOME%\Mercurial.ini`` (per-user)
75 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
76 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
77 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 - ``<install-dir>\Mercurial.ini`` (per-installation)
78 - ``<internal>/default.d/*.rc`` (defaults)
78 - ``<internal>/default.d/*.rc`` (defaults)
79
79
80 .. note::
80 .. note::
81
81
82 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
83 is used when running 32-bit Python on 64-bit Windows.
83 is used when running 32-bit Python on 64-bit Windows.
84
84
85 .. container:: windows
85 .. container:: windows
86
86
87 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
88
88
89 .. container:: verbose.plan9
89 .. container:: verbose.plan9
90
90
91 On Plan9, the following files are consulted:
91 On Plan9, the following files are consulted:
92
92
93 - ``<repo>/.hg/hgrc`` (per-repository)
93 - ``<repo>/.hg/hgrc`` (per-repository)
94 - ``$home/lib/hgrc`` (per-user)
94 - ``$home/lib/hgrc`` (per-user)
95 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
96 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
97 - ``/lib/mercurial/hgrc`` (per-system)
97 - ``/lib/mercurial/hgrc`` (per-system)
98 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
99 - ``<internal>/default.d/*.rc`` (defaults)
99 - ``<internal>/default.d/*.rc`` (defaults)
100
100
101 Per-repository configuration options only apply in a
101 Per-repository configuration options only apply in a
102 particular repository. This file is not version-controlled, and
102 particular repository. This file is not version-controlled, and
103 will not get transferred during a "clone" operation. Options in
103 will not get transferred during a "clone" operation. Options in
104 this file override options in all other configuration files.
104 this file override options in all other configuration files.
105
105
106 .. container:: unix.plan9
106 .. container:: unix.plan9
107
107
108 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 On Plan 9 and Unix, most of this file will be ignored if it doesn't
109 belong to a trusted user or to a trusted group. See
109 belong to a trusted user or to a trusted group. See
110 :hg:`help config.trusted` for more details.
110 :hg:`help config.trusted` for more details.
111
111
112 Per-user configuration file(s) are for the user running Mercurial. Options
112 Per-user configuration file(s) are for the user running Mercurial. Options
113 in these files apply to all Mercurial commands executed by this user in any
113 in these files apply to all Mercurial commands executed by this user in any
114 directory. Options in these files override per-system and per-installation
114 directory. Options in these files override per-system and per-installation
115 options.
115 options.
116
116
117 Per-installation configuration files are searched for in the
117 Per-installation configuration files are searched for in the
118 directory where Mercurial is installed. ``<install-root>`` is the
118 directory where Mercurial is installed. ``<install-root>`` is the
119 parent directory of the **hg** executable (or symlink) being run.
119 parent directory of the **hg** executable (or symlink) being run.
120
120
121 .. container:: unix.plan9
121 .. container:: unix.plan9
122
122
123 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
124 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
125 files apply to all Mercurial commands executed by any user in any
125 files apply to all Mercurial commands executed by any user in any
126 directory.
126 directory.
127
127
128 Per-installation configuration files are for the system on
128 Per-installation configuration files are for the system on
129 which Mercurial is running. Options in these files apply to all
129 which Mercurial is running. Options in these files apply to all
130 Mercurial commands executed by any user in any directory. Registry
130 Mercurial commands executed by any user in any directory. Registry
131 keys contain PATH-like strings, every part of which must reference
131 keys contain PATH-like strings, every part of which must reference
132 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
133 be read. Mercurial checks each of these locations in the specified
133 be read. Mercurial checks each of these locations in the specified
134 order until one or more configuration files are detected.
134 order until one or more configuration files are detected.
135
135
136 Per-system configuration files are for the system on which Mercurial
136 Per-system configuration files are for the system on which Mercurial
137 is running. Options in these files apply to all Mercurial commands
137 is running. Options in these files apply to all Mercurial commands
138 executed by any user in any directory. Options in these files
138 executed by any user in any directory. Options in these files
139 override per-installation options.
139 override per-installation options.
140
140
141 Mercurial comes with some default configuration. The default configuration
141 Mercurial comes with some default configuration. The default configuration
142 files are installed with Mercurial and will be overwritten on upgrades. Default
142 files are installed with Mercurial and will be overwritten on upgrades. Default
143 configuration files should never be edited by users or administrators but can
143 configuration files should never be edited by users or administrators but can
144 be overridden in other configuration files. So far the directory only contains
144 be overridden in other configuration files. So far the directory only contains
145 merge tool configuration but packagers can also put other default configuration
145 merge tool configuration but packagers can also put other default configuration
146 there.
146 there.
147
147
148 Syntax
148 Syntax
149 ======
149 ======
150
150
151 A configuration file consists of sections, led by a ``[section]`` header
151 A configuration file consists of sections, led by a ``[section]`` header
152 and followed by ``name = value`` entries (sometimes called
152 and followed by ``name = value`` entries (sometimes called
153 ``configuration keys``)::
153 ``configuration keys``)::
154
154
155 [spam]
155 [spam]
156 eggs=ham
156 eggs=ham
157 green=
157 green=
158 eggs
158 eggs
159
159
160 Each line contains one entry. If the lines that follow are indented,
160 Each line contains one entry. If the lines that follow are indented,
161 they are treated as continuations of that entry. Leading whitespace is
161 they are treated as continuations of that entry. Leading whitespace is
162 removed from values. Empty lines are skipped. Lines beginning with
162 removed from values. Empty lines are skipped. Lines beginning with
163 ``#`` or ``;`` are ignored and may be used to provide comments.
163 ``#`` or ``;`` are ignored and may be used to provide comments.
164
164
165 Configuration keys can be set multiple times, in which case Mercurial
165 Configuration keys can be set multiple times, in which case Mercurial
166 will use the value that was configured last. As an example::
166 will use the value that was configured last. As an example::
167
167
168 [spam]
168 [spam]
169 eggs=large
169 eggs=large
170 ham=serrano
170 ham=serrano
171 eggs=small
171 eggs=small
172
172
173 This would set the configuration key named ``eggs`` to ``small``.
173 This would set the configuration key named ``eggs`` to ``small``.
174
174
175 It is also possible to define a section multiple times. A section can
175 It is also possible to define a section multiple times. A section can
176 be redefined on the same and/or on different configuration files. For
176 be redefined on the same and/or on different configuration files. For
177 example::
177 example::
178
178
179 [foo]
179 [foo]
180 eggs=large
180 eggs=large
181 ham=serrano
181 ham=serrano
182 eggs=small
182 eggs=small
183
183
184 [bar]
184 [bar]
185 eggs=ham
185 eggs=ham
186 green=
186 green=
187 eggs
187 eggs
188
188
189 [foo]
189 [foo]
190 ham=prosciutto
190 ham=prosciutto
191 eggs=medium
191 eggs=medium
192 bread=toasted
192 bread=toasted
193
193
194 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
195 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
196 respectively. As you can see there only thing that matters is the last
196 respectively. As you can see there only thing that matters is the last
197 value that was set for each of the configuration keys.
197 value that was set for each of the configuration keys.
198
198
199 If a configuration key is set multiple times in different
199 If a configuration key is set multiple times in different
200 configuration files the final value will depend on the order in which
200 configuration files the final value will depend on the order in which
201 the different configuration files are read, with settings from earlier
201 the different configuration files are read, with settings from earlier
202 paths overriding later ones as described on the ``Files`` section
202 paths overriding later ones as described on the ``Files`` section
203 above.
203 above.
204
204
205 A line of the form ``%include file`` will include ``file`` into the
205 A line of the form ``%include file`` will include ``file`` into the
206 current configuration file. The inclusion is recursive, which means
206 current configuration file. The inclusion is recursive, which means
207 that included files can include other files. Filenames are relative to
207 that included files can include other files. Filenames are relative to
208 the configuration file in which the ``%include`` directive is found.
208 the configuration file in which the ``%include`` directive is found.
209 Environment variables and ``~user`` constructs are expanded in
209 Environment variables and ``~user`` constructs are expanded in
210 ``file``. This lets you do something like::
210 ``file``. This lets you do something like::
211
211
212 %include ~/.hgrc.d/$HOST.rc
212 %include ~/.hgrc.d/$HOST.rc
213
213
214 to include a different configuration file on each computer you use.
214 to include a different configuration file on each computer you use.
215
215
216 A line with ``%unset name`` will remove ``name`` from the current
216 A line with ``%unset name`` will remove ``name`` from the current
217 section, if it has been set previously.
217 section, if it has been set previously.
218
218
219 The values are either free-form text strings, lists of text strings,
219 The values are either free-form text strings, lists of text strings,
220 or Boolean values. Boolean values can be set to true using any of "1",
220 or Boolean values. Boolean values can be set to true using any of "1",
221 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
222 (all case insensitive).
222 (all case insensitive).
223
223
224 List values are separated by whitespace or comma, except when values are
224 List values are separated by whitespace or comma, except when values are
225 placed in double quotation marks::
225 placed in double quotation marks::
226
226
227 allow_read = "John Doe, PhD", brian, betty
227 allow_read = "John Doe, PhD", brian, betty
228
228
229 Quotation marks can be escaped by prefixing them with a backslash. Only
229 Quotation marks can be escaped by prefixing them with a backslash. Only
230 quotation marks at the beginning of a word is counted as a quotation
230 quotation marks at the beginning of a word is counted as a quotation
231 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
232
232
233 Sections
233 Sections
234 ========
234 ========
235
235
236 This section describes the different sections that may appear in a
236 This section describes the different sections that may appear in a
237 Mercurial configuration file, the purpose of each section, its possible
237 Mercurial configuration file, the purpose of each section, its possible
238 keys, and their possible values.
238 keys, and their possible values.
239
239
240 ``alias``
240 ``alias``
241 ---------
241 ---------
242
242
243 Defines command aliases.
243 Defines command aliases.
244
244
245 Aliases allow you to define your own commands in terms of other
245 Aliases allow you to define your own commands in terms of other
246 commands (or aliases), optionally including arguments. Positional
246 commands (or aliases), optionally including arguments. Positional
247 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
248 are expanded by Mercurial before execution. Positional arguments not
248 are expanded by Mercurial before execution. Positional arguments not
249 already used by ``$N`` in the definition are put at the end of the
249 already used by ``$N`` in the definition are put at the end of the
250 command to be executed.
250 command to be executed.
251
251
252 Alias definitions consist of lines of the form::
252 Alias definitions consist of lines of the form::
253
253
254 <alias> = <command> [<argument>]...
254 <alias> = <command> [<argument>]...
255
255
256 For example, this definition::
256 For example, this definition::
257
257
258 latest = log --limit 5
258 latest = log --limit 5
259
259
260 creates a new command ``latest`` that shows only the five most recent
260 creates a new command ``latest`` that shows only the five most recent
261 changesets. You can define subsequent aliases using earlier ones::
261 changesets. You can define subsequent aliases using earlier ones::
262
262
263 stable5 = latest -b stable
263 stable5 = latest -b stable
264
264
265 .. note::
265 .. note::
266
266
267 It is possible to create aliases with the same names as
267 It is possible to create aliases with the same names as
268 existing commands, which will then override the original
268 existing commands, which will then override the original
269 definitions. This is almost always a bad idea!
269 definitions. This is almost always a bad idea!
270
270
271 An alias can start with an exclamation point (``!``) to make it a
271 An alias can start with an exclamation point (``!``) to make it a
272 shell alias. A shell alias is executed with the shell and will let you
272 shell alias. A shell alias is executed with the shell and will let you
273 run arbitrary commands. As an example, ::
273 run arbitrary commands. As an example, ::
274
274
275 echo = !echo $@
275 echo = !echo $@
276
276
277 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 will let you do ``hg echo foo`` to have ``foo`` printed in your
278 terminal. A better example might be::
278 terminal. A better example might be::
279
279
280 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
280 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
281
281
282 which will make ``hg purge`` delete all unknown files in the
282 which will make ``hg purge`` delete all unknown files in the
283 repository in the same manner as the purge extension.
283 repository in the same manner as the purge extension.
284
284
285 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
286 expand to the command arguments. Unmatched arguments are
286 expand to the command arguments. Unmatched arguments are
287 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 removed. ``$0`` expands to the alias name and ``$@`` expands to all
288 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 arguments separated by a space. ``"$@"`` (with quotes) expands to all
289 arguments quoted individually and separated by a space. These expansions
289 arguments quoted individually and separated by a space. These expansions
290 happen before the command is passed to the shell.
290 happen before the command is passed to the shell.
291
291
292 Shell aliases are executed in an environment where ``$HG`` expands to
292 Shell aliases are executed in an environment where ``$HG`` expands to
293 the path of the Mercurial that was used to execute the alias. This is
293 the path of the Mercurial that was used to execute the alias. This is
294 useful when you want to call further Mercurial commands in a shell
294 useful when you want to call further Mercurial commands in a shell
295 alias, as was done above for the purge alias. In addition,
295 alias, as was done above for the purge alias. In addition,
296 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
297 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
298
298
299 .. note::
299 .. note::
300
300
301 Some global configuration options such as ``-R`` are
301 Some global configuration options such as ``-R`` are
302 processed before shell aliases and will thus not be passed to
302 processed before shell aliases and will thus not be passed to
303 aliases.
303 aliases.
304
304
305
305
306 ``annotate``
306 ``annotate``
307 ------------
307 ------------
308
308
309 Settings used when displaying file annotations. All values are
309 Settings used when displaying file annotations. All values are
310 Booleans and default to False. See :hg:`help config.diff` for
310 Booleans and default to False. See :hg:`help config.diff` for
311 related options for the diff command.
311 related options for the diff command.
312
312
313 ``ignorews``
313 ``ignorews``
314 Ignore white space when comparing lines.
314 Ignore white space when comparing lines.
315
315
316 ``ignorewseol``
316 ``ignorewseol``
317 Ignore white space at the end of a line when comparing lines.
317 Ignore white space at the end of a line when comparing lines.
318
318
319 ``ignorewsamount``
319 ``ignorewsamount``
320 Ignore changes in the amount of white space.
320 Ignore changes in the amount of white space.
321
321
322 ``ignoreblanklines``
322 ``ignoreblanklines``
323 Ignore changes whose lines are all blank.
323 Ignore changes whose lines are all blank.
324
324
325
325
326 ``auth``
326 ``auth``
327 --------
327 --------
328
328
329 Authentication credentials and other authentication-like configuration
329 Authentication credentials and other authentication-like configuration
330 for HTTP connections. This section allows you to store usernames and
330 for HTTP connections. This section allows you to store usernames and
331 passwords for use when logging *into* HTTP servers. See
331 passwords for use when logging *into* HTTP servers. See
332 :hg:`help config.web` if you want to configure *who* can login to
332 :hg:`help config.web` if you want to configure *who* can login to
333 your HTTP server.
333 your HTTP server.
334
334
335 The following options apply to all hosts.
335 The following options apply to all hosts.
336
336
337 ``cookiefile``
337 ``cookiefile``
338 Path to a file containing HTTP cookie lines. Cookies matching a
338 Path to a file containing HTTP cookie lines. Cookies matching a
339 host will be sent automatically.
339 host will be sent automatically.
340
340
341 The file format uses the Mozilla cookies.txt format, which defines cookies
341 The file format uses the Mozilla cookies.txt format, which defines cookies
342 on their own lines. Each line contains 7 fields delimited by the tab
342 on their own lines. Each line contains 7 fields delimited by the tab
343 character (domain, is_domain_cookie, path, is_secure, expires, name,
343 character (domain, is_domain_cookie, path, is_secure, expires, name,
344 value). For more info, do an Internet search for "Netscape cookies.txt
344 value). For more info, do an Internet search for "Netscape cookies.txt
345 format."
345 format."
346
346
347 Note: the cookies parser does not handle port numbers on domains. You
347 Note: the cookies parser does not handle port numbers on domains. You
348 will need to remove ports from the domain for the cookie to be recognized.
348 will need to remove ports from the domain for the cookie to be recognized.
349 This could result in a cookie being disclosed to an unwanted server.
349 This could result in a cookie being disclosed to an unwanted server.
350
350
351 The cookies file is read-only.
351 The cookies file is read-only.
352
352
353 Other options in this section are grouped by name and have the following
353 Other options in this section are grouped by name and have the following
354 format::
354 format::
355
355
356 <name>.<argument> = <value>
356 <name>.<argument> = <value>
357
357
358 where ``<name>`` is used to group arguments into authentication
358 where ``<name>`` is used to group arguments into authentication
359 entries. Example::
359 entries. Example::
360
360
361 foo.prefix = hg.intevation.de/mercurial
361 foo.prefix = hg.intevation.de/mercurial
362 foo.username = foo
362 foo.username = foo
363 foo.password = bar
363 foo.password = bar
364 foo.schemes = http https
364 foo.schemes = http https
365
365
366 bar.prefix = secure.example.org
366 bar.prefix = secure.example.org
367 bar.key = path/to/file.key
367 bar.key = path/to/file.key
368 bar.cert = path/to/file.cert
368 bar.cert = path/to/file.cert
369 bar.schemes = https
369 bar.schemes = https
370
370
371 Supported arguments:
371 Supported arguments:
372
372
373 ``prefix``
373 ``prefix``
374 Either ``*`` or a URI prefix with or without the scheme part.
374 Either ``*`` or a URI prefix with or without the scheme part.
375 The authentication entry with the longest matching prefix is used
375 The authentication entry with the longest matching prefix is used
376 (where ``*`` matches everything and counts as a match of length
376 (where ``*`` matches everything and counts as a match of length
377 1). If the prefix doesn't include a scheme, the match is performed
377 1). If the prefix doesn't include a scheme, the match is performed
378 against the URI with its scheme stripped as well, and the schemes
378 against the URI with its scheme stripped as well, and the schemes
379 argument, q.v., is then subsequently consulted.
379 argument, q.v., is then subsequently consulted.
380
380
381 ``username``
381 ``username``
382 Optional. Username to authenticate with. If not given, and the
382 Optional. Username to authenticate with. If not given, and the
383 remote site requires basic or digest authentication, the user will
383 remote site requires basic or digest authentication, the user will
384 be prompted for it. Environment variables are expanded in the
384 be prompted for it. Environment variables are expanded in the
385 username letting you do ``foo.username = $USER``. If the URI
385 username letting you do ``foo.username = $USER``. If the URI
386 includes a username, only ``[auth]`` entries with a matching
386 includes a username, only ``[auth]`` entries with a matching
387 username or without a username will be considered.
387 username or without a username will be considered.
388
388
389 ``password``
389 ``password``
390 Optional. Password to authenticate with. If not given, and the
390 Optional. Password to authenticate with. If not given, and the
391 remote site requires basic or digest authentication, the user
391 remote site requires basic or digest authentication, the user
392 will be prompted for it.
392 will be prompted for it.
393
393
394 ``key``
394 ``key``
395 Optional. PEM encoded client certificate key file. Environment
395 Optional. PEM encoded client certificate key file. Environment
396 variables are expanded in the filename.
396 variables are expanded in the filename.
397
397
398 ``cert``
398 ``cert``
399 Optional. PEM encoded client certificate chain file. Environment
399 Optional. PEM encoded client certificate chain file. Environment
400 variables are expanded in the filename.
400 variables are expanded in the filename.
401
401
402 ``schemes``
402 ``schemes``
403 Optional. Space separated list of URI schemes to use this
403 Optional. Space separated list of URI schemes to use this
404 authentication entry with. Only used if the prefix doesn't include
404 authentication entry with. Only used if the prefix doesn't include
405 a scheme. Supported schemes are http and https. They will match
405 a scheme. Supported schemes are http and https. They will match
406 static-http and static-https respectively, as well.
406 static-http and static-https respectively, as well.
407 (default: https)
407 (default: https)
408
408
409 If no suitable authentication entry is found, the user is prompted
409 If no suitable authentication entry is found, the user is prompted
410 for credentials as usual if required by the remote.
410 for credentials as usual if required by the remote.
411
411
412 ``color``
412 ``color``
413 ---------
413 ---------
414
414
415 Configure the Mercurial color mode. For details about how to define your custom
415 Configure the Mercurial color mode. For details about how to define your custom
416 effect and style see :hg:`help color`.
416 effect and style see :hg:`help color`.
417
417
418 ``mode``
418 ``mode``
419 String: control the method used to output color. One of ``auto``, ``ansi``,
419 String: control the method used to output color. One of ``auto``, ``ansi``,
420 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
420 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
421 use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
421 use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
422 terminal. Any invalid value will disable color.
422 terminal. Any invalid value will disable color.
423
423
424 ``pagermode``
424 ``pagermode``
425 String: optional override of ``color.mode`` used with pager.
425 String: optional override of ``color.mode`` used with pager.
426
426
427 On some systems, terminfo mode may cause problems when using
427 On some systems, terminfo mode may cause problems when using
428 color with ``less -R`` as a pager program. less with the -R option
428 color with ``less -R`` as a pager program. less with the -R option
429 will only display ECMA-48 color codes, and terminfo mode may sometimes
429 will only display ECMA-48 color codes, and terminfo mode may sometimes
430 emit codes that less doesn't understand. You can work around this by
430 emit codes that less doesn't understand. You can work around this by
431 either using ansi mode (or auto mode), or by using less -r (which will
431 either using ansi mode (or auto mode), or by using less -r (which will
432 pass through all terminal control codes, not just color control
432 pass through all terminal control codes, not just color control
433 codes).
433 codes).
434
434
435 On some systems (such as MSYS in Windows), the terminal may support
435 On some systems (such as MSYS in Windows), the terminal may support
436 a different color mode than the pager program.
436 a different color mode than the pager program.
437
437
438 ``commands``
438 ``commands``
439 ------------
439 ------------
440
440
441 ``resolve.confirm``
441 ``resolve.confirm``
442 Confirm before performing action if no filename is passed.
442 Confirm before performing action if no filename is passed.
443 (default: False)
443 (default: False)
444
444
445 ``resolve.explicit-re-merge``
445 ``resolve.explicit-re-merge``
446 Require uses of ``hg resolve`` to specify which action it should perform,
446 Require uses of ``hg resolve`` to specify which action it should perform,
447 instead of re-merging files by default.
447 instead of re-merging files by default.
448 (default: False)
448 (default: False)
449
449
450 ``resolve.mark-check``
450 ``resolve.mark-check``
451 Determines what level of checking :hg:`resolve --mark` will perform before
451 Determines what level of checking :hg:`resolve --mark` will perform before
452 marking files as resolved. Valid values are ``none`, ``warn``, and
452 marking files as resolved. Valid values are ``none`, ``warn``, and
453 ``abort``. ``warn`` will output a warning listing the file(s) that still
453 ``abort``. ``warn`` will output a warning listing the file(s) that still
454 have conflict markers in them, but will still mark everything resolved.
454 have conflict markers in them, but will still mark everything resolved.
455 ``abort`` will output the same warning but will not mark things as resolved.
455 ``abort`` will output the same warning but will not mark things as resolved.
456 If --all is passed and this is set to ``abort``, only a warning will be
456 If --all is passed and this is set to ``abort``, only a warning will be
457 shown (an error will not be raised).
457 shown (an error will not be raised).
458 (default: ``none``)
458 (default: ``none``)
459
459
460 ``status.relative``
460 ``status.relative``
461 Make paths in :hg:`status` output relative to the current directory.
461 Make paths in :hg:`status` output relative to the current directory.
462 (default: False)
462 (default: False)
463
463
464 ``status.terse``
464 ``status.terse``
465 Default value for the --terse flag, which condenes status output.
465 Default value for the --terse flag, which condenes status output.
466 (default: empty)
466 (default: empty)
467
467
468 ``update.check``
468 ``update.check``
469 Determines what level of checking :hg:`update` will perform before moving
469 Determines what level of checking :hg:`update` will perform before moving
470 to a destination revision. Valid values are ``abort``, ``none``,
470 to a destination revision. Valid values are ``abort``, ``none``,
471 ``linear``, and ``noconflict``. ``abort`` always fails if the working
471 ``linear``, and ``noconflict``. ``abort`` always fails if the working
472 directory has uncommitted changes. ``none`` performs no checking, and may
472 directory has uncommitted changes. ``none`` performs no checking, and may
473 result in a merge with uncommitted changes. ``linear`` allows any update
473 result in a merge with uncommitted changes. ``linear`` allows any update
474 as long as it follows a straight line in the revision history, and may
474 as long as it follows a straight line in the revision history, and may
475 trigger a merge with uncommitted changes. ``noconflict`` will allow any
475 trigger a merge with uncommitted changes. ``noconflict`` will allow any
476 update which would not trigger a merge with uncommitted changes, if any
476 update which would not trigger a merge with uncommitted changes, if any
477 are present.
477 are present.
478 (default: ``linear``)
478 (default: ``linear``)
479
479
480 ``update.requiredest``
480 ``update.requiredest``
481 Require that the user pass a destination when running :hg:`update`.
481 Require that the user pass a destination when running :hg:`update`.
482 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
482 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
483 will be disallowed.
483 will be disallowed.
484 (default: False)
484 (default: False)
485
485
486 ``committemplate``
486 ``committemplate``
487 ------------------
487 ------------------
488
488
489 ``changeset``
489 ``changeset``
490 String: configuration in this section is used as the template to
490 String: configuration in this section is used as the template to
491 customize the text shown in the editor when committing.
491 customize the text shown in the editor when committing.
492
492
493 In addition to pre-defined template keywords, commit log specific one
493 In addition to pre-defined template keywords, commit log specific one
494 below can be used for customization:
494 below can be used for customization:
495
495
496 ``extramsg``
496 ``extramsg``
497 String: Extra message (typically 'Leave message empty to abort
497 String: Extra message (typically 'Leave message empty to abort
498 commit.'). This may be changed by some commands or extensions.
498 commit.'). This may be changed by some commands or extensions.
499
499
500 For example, the template configuration below shows as same text as
500 For example, the template configuration below shows as same text as
501 one shown by default::
501 one shown by default::
502
502
503 [committemplate]
503 [committemplate]
504 changeset = {desc}\n\n
504 changeset = {desc}\n\n
505 HG: Enter commit message. Lines beginning with 'HG:' are removed.
505 HG: Enter commit message. Lines beginning with 'HG:' are removed.
506 HG: {extramsg}
506 HG: {extramsg}
507 HG: --
507 HG: --
508 HG: user: {author}\n{ifeq(p2rev, "-1", "",
508 HG: user: {author}\n{ifeq(p2rev, "-1", "",
509 "HG: branch merge\n")
509 "HG: branch merge\n")
510 }HG: branch '{branch}'\n{if(activebookmark,
510 }HG: branch '{branch}'\n{if(activebookmark,
511 "HG: bookmark '{activebookmark}'\n") }{subrepos %
511 "HG: bookmark '{activebookmark}'\n") }{subrepos %
512 "HG: subrepo {subrepo}\n" }{file_adds %
512 "HG: subrepo {subrepo}\n" }{file_adds %
513 "HG: added {file}\n" }{file_mods %
513 "HG: added {file}\n" }{file_mods %
514 "HG: changed {file}\n" }{file_dels %
514 "HG: changed {file}\n" }{file_dels %
515 "HG: removed {file}\n" }{if(files, "",
515 "HG: removed {file}\n" }{if(files, "",
516 "HG: no files changed\n")}
516 "HG: no files changed\n")}
517
517
518 ``diff()``
518 ``diff()``
519 String: show the diff (see :hg:`help templates` for detail)
519 String: show the diff (see :hg:`help templates` for detail)
520
520
521 Sometimes it is helpful to show the diff of the changeset in the editor without
521 Sometimes it is helpful to show the diff of the changeset in the editor without
522 having to prefix 'HG: ' to each line so that highlighting works correctly. For
522 having to prefix 'HG: ' to each line so that highlighting works correctly. For
523 this, Mercurial provides a special string which will ignore everything below
523 this, Mercurial provides a special string which will ignore everything below
524 it::
524 it::
525
525
526 HG: ------------------------ >8 ------------------------
526 HG: ------------------------ >8 ------------------------
527
527
528 For example, the template configuration below will show the diff below the
528 For example, the template configuration below will show the diff below the
529 extra message::
529 extra message::
530
530
531 [committemplate]
531 [committemplate]
532 changeset = {desc}\n\n
532 changeset = {desc}\n\n
533 HG: Enter commit message. Lines beginning with 'HG:' are removed.
533 HG: Enter commit message. Lines beginning with 'HG:' are removed.
534 HG: {extramsg}
534 HG: {extramsg}
535 HG: ------------------------ >8 ------------------------
535 HG: ------------------------ >8 ------------------------
536 HG: Do not touch the line above.
536 HG: Do not touch the line above.
537 HG: Everything below will be removed.
537 HG: Everything below will be removed.
538 {diff()}
538 {diff()}
539
539
540 .. note::
540 .. note::
541
541
542 For some problematic encodings (see :hg:`help win32mbcs` for
542 For some problematic encodings (see :hg:`help win32mbcs` for
543 detail), this customization should be configured carefully, to
543 detail), this customization should be configured carefully, to
544 avoid showing broken characters.
544 avoid showing broken characters.
545
545
546 For example, if a multibyte character ending with backslash (0x5c) is
546 For example, if a multibyte character ending with backslash (0x5c) is
547 followed by the ASCII character 'n' in the customized template,
547 followed by the ASCII character 'n' in the customized template,
548 the sequence of backslash and 'n' is treated as line-feed unexpectedly
548 the sequence of backslash and 'n' is treated as line-feed unexpectedly
549 (and the multibyte character is broken, too).
549 (and the multibyte character is broken, too).
550
550
551 Customized template is used for commands below (``--edit`` may be
551 Customized template is used for commands below (``--edit`` may be
552 required):
552 required):
553
553
554 - :hg:`backout`
554 - :hg:`backout`
555 - :hg:`commit`
555 - :hg:`commit`
556 - :hg:`fetch` (for merge commit only)
556 - :hg:`fetch` (for merge commit only)
557 - :hg:`graft`
557 - :hg:`graft`
558 - :hg:`histedit`
558 - :hg:`histedit`
559 - :hg:`import`
559 - :hg:`import`
560 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
560 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
561 - :hg:`rebase`
561 - :hg:`rebase`
562 - :hg:`shelve`
562 - :hg:`shelve`
563 - :hg:`sign`
563 - :hg:`sign`
564 - :hg:`tag`
564 - :hg:`tag`
565 - :hg:`transplant`
565 - :hg:`transplant`
566
566
567 Configuring items below instead of ``changeset`` allows showing
567 Configuring items below instead of ``changeset`` allows showing
568 customized message only for specific actions, or showing different
568 customized message only for specific actions, or showing different
569 messages for each action.
569 messages for each action.
570
570
571 - ``changeset.backout`` for :hg:`backout`
571 - ``changeset.backout`` for :hg:`backout`
572 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
572 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
573 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
573 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
574 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
574 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
575 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
575 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
576 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
576 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
577 - ``changeset.gpg.sign`` for :hg:`sign`
577 - ``changeset.gpg.sign`` for :hg:`sign`
578 - ``changeset.graft`` for :hg:`graft`
578 - ``changeset.graft`` for :hg:`graft`
579 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
579 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
580 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
580 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
581 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
581 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
582 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
582 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
583 - ``changeset.import.bypass`` for :hg:`import --bypass`
583 - ``changeset.import.bypass`` for :hg:`import --bypass`
584 - ``changeset.import.normal.merge`` for :hg:`import` on merges
584 - ``changeset.import.normal.merge`` for :hg:`import` on merges
585 - ``changeset.import.normal.normal`` for :hg:`import` on other
585 - ``changeset.import.normal.normal`` for :hg:`import` on other
586 - ``changeset.mq.qnew`` for :hg:`qnew`
586 - ``changeset.mq.qnew`` for :hg:`qnew`
587 - ``changeset.mq.qfold`` for :hg:`qfold`
587 - ``changeset.mq.qfold`` for :hg:`qfold`
588 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
588 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
589 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
589 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
590 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
590 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
591 - ``changeset.rebase.normal`` for :hg:`rebase` on other
591 - ``changeset.rebase.normal`` for :hg:`rebase` on other
592 - ``changeset.shelve.shelve`` for :hg:`shelve`
592 - ``changeset.shelve.shelve`` for :hg:`shelve`
593 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
593 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
594 - ``changeset.tag.remove`` for :hg:`tag --remove`
594 - ``changeset.tag.remove`` for :hg:`tag --remove`
595 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
595 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
596 - ``changeset.transplant.normal`` for :hg:`transplant` on other
596 - ``changeset.transplant.normal`` for :hg:`transplant` on other
597
597
598 These dot-separated lists of names are treated as hierarchical ones.
598 These dot-separated lists of names are treated as hierarchical ones.
599 For example, ``changeset.tag.remove`` customizes the commit message
599 For example, ``changeset.tag.remove`` customizes the commit message
600 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
600 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
601 commit message for :hg:`tag` regardless of ``--remove`` option.
601 commit message for :hg:`tag` regardless of ``--remove`` option.
602
602
603 When the external editor is invoked for a commit, the corresponding
603 When the external editor is invoked for a commit, the corresponding
604 dot-separated list of names without the ``changeset.`` prefix
604 dot-separated list of names without the ``changeset.`` prefix
605 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
605 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
606 variable.
606 variable.
607
607
608 In this section, items other than ``changeset`` can be referred from
608 In this section, items other than ``changeset`` can be referred from
609 others. For example, the configuration to list committed files up
609 others. For example, the configuration to list committed files up
610 below can be referred as ``{listupfiles}``::
610 below can be referred as ``{listupfiles}``::
611
611
612 [committemplate]
612 [committemplate]
613 listupfiles = {file_adds %
613 listupfiles = {file_adds %
614 "HG: added {file}\n" }{file_mods %
614 "HG: added {file}\n" }{file_mods %
615 "HG: changed {file}\n" }{file_dels %
615 "HG: changed {file}\n" }{file_dels %
616 "HG: removed {file}\n" }{if(files, "",
616 "HG: removed {file}\n" }{if(files, "",
617 "HG: no files changed\n")}
617 "HG: no files changed\n")}
618
618
619 ``decode/encode``
619 ``decode/encode``
620 -----------------
620 -----------------
621
621
622 Filters for transforming files on checkout/checkin. This would
622 Filters for transforming files on checkout/checkin. This would
623 typically be used for newline processing or other
623 typically be used for newline processing or other
624 localization/canonicalization of files.
624 localization/canonicalization of files.
625
625
626 Filters consist of a filter pattern followed by a filter command.
626 Filters consist of a filter pattern followed by a filter command.
627 Filter patterns are globs by default, rooted at the repository root.
627 Filter patterns are globs by default, rooted at the repository root.
628 For example, to match any file ending in ``.txt`` in the root
628 For example, to match any file ending in ``.txt`` in the root
629 directory only, use the pattern ``*.txt``. To match any file ending
629 directory only, use the pattern ``*.txt``. To match any file ending
630 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
630 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
631 For each file only the first matching filter applies.
631 For each file only the first matching filter applies.
632
632
633 The filter command can start with a specifier, either ``pipe:`` or
633 The filter command can start with a specifier, either ``pipe:`` or
634 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
634 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
635
635
636 A ``pipe:`` command must accept data on stdin and return the transformed
636 A ``pipe:`` command must accept data on stdin and return the transformed
637 data on stdout.
637 data on stdout.
638
638
639 Pipe example::
639 Pipe example::
640
640
641 [encode]
641 [encode]
642 # uncompress gzip files on checkin to improve delta compression
642 # uncompress gzip files on checkin to improve delta compression
643 # note: not necessarily a good idea, just an example
643 # note: not necessarily a good idea, just an example
644 *.gz = pipe: gunzip
644 *.gz = pipe: gunzip
645
645
646 [decode]
646 [decode]
647 # recompress gzip files when writing them to the working dir (we
647 # recompress gzip files when writing them to the working dir (we
648 # can safely omit "pipe:", because it's the default)
648 # can safely omit "pipe:", because it's the default)
649 *.gz = gzip
649 *.gz = gzip
650
650
651 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
651 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
652 with the name of a temporary file that contains the data to be
652 with the name of a temporary file that contains the data to be
653 filtered by the command. The string ``OUTFILE`` is replaced with the name
653 filtered by the command. The string ``OUTFILE`` is replaced with the name
654 of an empty temporary file, where the filtered data must be written by
654 of an empty temporary file, where the filtered data must be written by
655 the command.
655 the command.
656
656
657 .. container:: windows
657 .. container:: windows
658
658
659 .. note::
659 .. note::
660
660
661 The tempfile mechanism is recommended for Windows systems,
661 The tempfile mechanism is recommended for Windows systems,
662 where the standard shell I/O redirection operators often have
662 where the standard shell I/O redirection operators often have
663 strange effects and may corrupt the contents of your files.
663 strange effects and may corrupt the contents of your files.
664
664
665 This filter mechanism is used internally by the ``eol`` extension to
665 This filter mechanism is used internally by the ``eol`` extension to
666 translate line ending characters between Windows (CRLF) and Unix (LF)
666 translate line ending characters between Windows (CRLF) and Unix (LF)
667 format. We suggest you use the ``eol`` extension for convenience.
667 format. We suggest you use the ``eol`` extension for convenience.
668
668
669
669
670 ``defaults``
670 ``defaults``
671 ------------
671 ------------
672
672
673 (defaults are deprecated. Don't use them. Use aliases instead.)
673 (defaults are deprecated. Don't use them. Use aliases instead.)
674
674
675 Use the ``[defaults]`` section to define command defaults, i.e. the
675 Use the ``[defaults]`` section to define command defaults, i.e. the
676 default options/arguments to pass to the specified commands.
676 default options/arguments to pass to the specified commands.
677
677
678 The following example makes :hg:`log` run in verbose mode, and
678 The following example makes :hg:`log` run in verbose mode, and
679 :hg:`status` show only the modified files, by default::
679 :hg:`status` show only the modified files, by default::
680
680
681 [defaults]
681 [defaults]
682 log = -v
682 log = -v
683 status = -m
683 status = -m
684
684
685 The actual commands, instead of their aliases, must be used when
685 The actual commands, instead of their aliases, must be used when
686 defining command defaults. The command defaults will also be applied
686 defining command defaults. The command defaults will also be applied
687 to the aliases of the commands defined.
687 to the aliases of the commands defined.
688
688
689
689
690 ``diff``
690 ``diff``
691 --------
691 --------
692
692
693 Settings used when displaying diffs. Everything except for ``unified``
693 Settings used when displaying diffs. Everything except for ``unified``
694 is a Boolean and defaults to False. See :hg:`help config.annotate`
694 is a Boolean and defaults to False. See :hg:`help config.annotate`
695 for related options for the annotate command.
695 for related options for the annotate command.
696
696
697 ``git``
697 ``git``
698 Use git extended diff format.
698 Use git extended diff format.
699
699
700 ``nobinary``
700 ``nobinary``
701 Omit git binary patches.
701 Omit git binary patches.
702
702
703 ``nodates``
703 ``nodates``
704 Don't include dates in diff headers.
704 Don't include dates in diff headers.
705
705
706 ``noprefix``
706 ``noprefix``
707 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
707 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
708
708
709 ``showfunc``
709 ``showfunc``
710 Show which function each change is in.
710 Show which function each change is in.
711
711
712 ``ignorews``
712 ``ignorews``
713 Ignore white space when comparing lines.
713 Ignore white space when comparing lines.
714
714
715 ``ignorewsamount``
715 ``ignorewsamount``
716 Ignore changes in the amount of white space.
716 Ignore changes in the amount of white space.
717
717
718 ``ignoreblanklines``
718 ``ignoreblanklines``
719 Ignore changes whose lines are all blank.
719 Ignore changes whose lines are all blank.
720
720
721 ``unified``
721 ``unified``
722 Number of lines of context to show.
722 Number of lines of context to show.
723
723
724 ``word-diff``
724 ``word-diff``
725 Highlight changed words.
725 Highlight changed words.
726
726
727 ``email``
727 ``email``
728 ---------
728 ---------
729
729
730 Settings for extensions that send email messages.
730 Settings for extensions that send email messages.
731
731
732 ``from``
732 ``from``
733 Optional. Email address to use in "From" header and SMTP envelope
733 Optional. Email address to use in "From" header and SMTP envelope
734 of outgoing messages.
734 of outgoing messages.
735
735
736 ``to``
736 ``to``
737 Optional. Comma-separated list of recipients' email addresses.
737 Optional. Comma-separated list of recipients' email addresses.
738
738
739 ``cc``
739 ``cc``
740 Optional. Comma-separated list of carbon copy recipients'
740 Optional. Comma-separated list of carbon copy recipients'
741 email addresses.
741 email addresses.
742
742
743 ``bcc``
743 ``bcc``
744 Optional. Comma-separated list of blind carbon copy recipients'
744 Optional. Comma-separated list of blind carbon copy recipients'
745 email addresses.
745 email addresses.
746
746
747 ``method``
747 ``method``
748 Optional. Method to use to send email messages. If value is ``smtp``
748 Optional. Method to use to send email messages. If value is ``smtp``
749 (default), use SMTP (see the ``[smtp]`` section for configuration).
749 (default), use SMTP (see the ``[smtp]`` section for configuration).
750 Otherwise, use as name of program to run that acts like sendmail
750 Otherwise, use as name of program to run that acts like sendmail
751 (takes ``-f`` option for sender, list of recipients on command line,
751 (takes ``-f`` option for sender, list of recipients on command line,
752 message on stdin). Normally, setting this to ``sendmail`` or
752 message on stdin). Normally, setting this to ``sendmail`` or
753 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
753 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
754
754
755 ``charsets``
755 ``charsets``
756 Optional. Comma-separated list of character sets considered
756 Optional. Comma-separated list of character sets considered
757 convenient for recipients. Addresses, headers, and parts not
757 convenient for recipients. Addresses, headers, and parts not
758 containing patches of outgoing messages will be encoded in the
758 containing patches of outgoing messages will be encoded in the
759 first character set to which conversion from local encoding
759 first character set to which conversion from local encoding
760 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
760 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
761 conversion fails, the text in question is sent as is.
761 conversion fails, the text in question is sent as is.
762 (default: '')
762 (default: '')
763
763
764 Order of outgoing email character sets:
764 Order of outgoing email character sets:
765
765
766 1. ``us-ascii``: always first, regardless of settings
766 1. ``us-ascii``: always first, regardless of settings
767 2. ``email.charsets``: in order given by user
767 2. ``email.charsets``: in order given by user
768 3. ``ui.fallbackencoding``: if not in email.charsets
768 3. ``ui.fallbackencoding``: if not in email.charsets
769 4. ``$HGENCODING``: if not in email.charsets
769 4. ``$HGENCODING``: if not in email.charsets
770 5. ``utf-8``: always last, regardless of settings
770 5. ``utf-8``: always last, regardless of settings
771
771
772 Email example::
772 Email example::
773
773
774 [email]
774 [email]
775 from = Joseph User <joe.user@example.com>
775 from = Joseph User <joe.user@example.com>
776 method = /usr/sbin/sendmail
776 method = /usr/sbin/sendmail
777 # charsets for western Europeans
777 # charsets for western Europeans
778 # us-ascii, utf-8 omitted, as they are tried first and last
778 # us-ascii, utf-8 omitted, as they are tried first and last
779 charsets = iso-8859-1, iso-8859-15, windows-1252
779 charsets = iso-8859-1, iso-8859-15, windows-1252
780
780
781
781
782 ``extensions``
782 ``extensions``
783 --------------
783 --------------
784
784
785 Mercurial has an extension mechanism for adding new features. To
785 Mercurial has an extension mechanism for adding new features. To
786 enable an extension, create an entry for it in this section.
786 enable an extension, create an entry for it in this section.
787
787
788 If you know that the extension is already in Python's search path,
788 If you know that the extension is already in Python's search path,
789 you can give the name of the module, followed by ``=``, with nothing
789 you can give the name of the module, followed by ``=``, with nothing
790 after the ``=``.
790 after the ``=``.
791
791
792 Otherwise, give a name that you choose, followed by ``=``, followed by
792 Otherwise, give a name that you choose, followed by ``=``, followed by
793 the path to the ``.py`` file (including the file name extension) that
793 the path to the ``.py`` file (including the file name extension) that
794 defines the extension.
794 defines the extension.
795
795
796 To explicitly disable an extension that is enabled in an hgrc of
796 To explicitly disable an extension that is enabled in an hgrc of
797 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
797 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
798 or ``foo = !`` when path is not supplied.
798 or ``foo = !`` when path is not supplied.
799
799
800 Example for ``~/.hgrc``::
800 Example for ``~/.hgrc``::
801
801
802 [extensions]
802 [extensions]
803 # (the churn extension will get loaded from Mercurial's path)
803 # (the churn extension will get loaded from Mercurial's path)
804 churn =
804 churn =
805 # (this extension will get loaded from the file specified)
805 # (this extension will get loaded from the file specified)
806 myfeature = ~/.hgext/myfeature.py
806 myfeature = ~/.hgext/myfeature.py
807
807
808
808
809 ``format``
809 ``format``
810 ----------
810 ----------
811
811
812 Configuration that controls the repository format. Newer format options are more
812 Configuration that controls the repository format. Newer format options are more
813 powerful but incompatible with some older versions of Mercurial. Format options
813 powerful but incompatible with some older versions of Mercurial. Format options
814 are considered at repository initialization only. You need to make a new clone
814 are considered at repository initialization only. You need to make a new clone
815 for config change to be taken into account.
815 for config change to be taken into account.
816
816
817 For more details about repository format and version compatibility, see
817 For more details about repository format and version compatibility, see
818 https://www.mercurial-scm.org/wiki/MissingRequirement
818 https://www.mercurial-scm.org/wiki/MissingRequirement
819
819
820 ``usegeneraldelta``
820 ``usegeneraldelta``
821 Enable or disable the "generaldelta" repository format which improves
821 Enable or disable the "generaldelta" repository format which improves
822 repository compression by allowing "revlog" to store delta against arbitrary
822 repository compression by allowing "revlog" to store delta against arbitrary
823 revision instead of the previous stored one. This provides significant
823 revision instead of the previous stored one. This provides significant
824 improvement for repositories with branches.
824 improvement for repositories with branches.
825
825
826 Repositories with this on-disk format require Mercurial version 1.9.
826 Repositories with this on-disk format require Mercurial version 1.9.
827
827
828 Enabled by default.
828 Enabled by default.
829
829
830 ``dotencode``
830 ``dotencode``
831 Enable or disable the "dotencode" repository format which enhances
831 Enable or disable the "dotencode" repository format which enhances
832 the "fncache" repository format (which has to be enabled to use
832 the "fncache" repository format (which has to be enabled to use
833 dotencode) to avoid issues with filenames starting with ._ on
833 dotencode) to avoid issues with filenames starting with ._ on
834 Mac OS X and spaces on Windows.
834 Mac OS X and spaces on Windows.
835
835
836 Repositories with this on-disk format require Mercurial version 1.7.
836 Repositories with this on-disk format require Mercurial version 1.7.
837
837
838 Enabled by default.
838 Enabled by default.
839
839
840 ``usefncache``
840 ``usefncache``
841 Enable or disable the "fncache" repository format which enhances
841 Enable or disable the "fncache" repository format which enhances
842 the "store" repository format (which has to be enabled to use
842 the "store" repository format (which has to be enabled to use
843 fncache) to allow longer filenames and avoids using Windows
843 fncache) to allow longer filenames and avoids using Windows
844 reserved names, e.g. "nul".
844 reserved names, e.g. "nul".
845
845
846 Repositories with this on-disk format require Mercurial version 1.1.
846 Repositories with this on-disk format require Mercurial version 1.1.
847
847
848 Enabled by default.
848 Enabled by default.
849
849
850 ``usestore``
850 ``usestore``
851 Enable or disable the "store" repository format which improves
851 Enable or disable the "store" repository format which improves
852 compatibility with systems that fold case or otherwise mangle
852 compatibility with systems that fold case or otherwise mangle
853 filenames. Disabling this option will allow you to store longer filenames
853 filenames. Disabling this option will allow you to store longer filenames
854 in some situations at the expense of compatibility.
854 in some situations at the expense of compatibility.
855
855
856 Repositories with this on-disk format require Mercurial version 0.9.4.
856 Repositories with this on-disk format require Mercurial version 0.9.4.
857
857
858 Enabled by default.
858 Enabled by default.
859
859
860 ``graph``
860 ``graph``
861 ---------
861 ---------
862
862
863 Web graph view configuration. This section let you change graph
863 Web graph view configuration. This section let you change graph
864 elements display properties by branches, for instance to make the
864 elements display properties by branches, for instance to make the
865 ``default`` branch stand out.
865 ``default`` branch stand out.
866
866
867 Each line has the following format::
867 Each line has the following format::
868
868
869 <branch>.<argument> = <value>
869 <branch>.<argument> = <value>
870
870
871 where ``<branch>`` is the name of the branch being
871 where ``<branch>`` is the name of the branch being
872 customized. Example::
872 customized. Example::
873
873
874 [graph]
874 [graph]
875 # 2px width
875 # 2px width
876 default.width = 2
876 default.width = 2
877 # red color
877 # red color
878 default.color = FF0000
878 default.color = FF0000
879
879
880 Supported arguments:
880 Supported arguments:
881
881
882 ``width``
882 ``width``
883 Set branch edges width in pixels.
883 Set branch edges width in pixels.
884
884
885 ``color``
885 ``color``
886 Set branch edges color in hexadecimal RGB notation.
886 Set branch edges color in hexadecimal RGB notation.
887
887
888 ``hooks``
888 ``hooks``
889 ---------
889 ---------
890
890
891 Commands or Python functions that get automatically executed by
891 Commands or Python functions that get automatically executed by
892 various actions such as starting or finishing a commit. Multiple
892 various actions such as starting or finishing a commit. Multiple
893 hooks can be run for the same action by appending a suffix to the
893 hooks can be run for the same action by appending a suffix to the
894 action. Overriding a site-wide hook can be done by changing its
894 action. Overriding a site-wide hook can be done by changing its
895 value or setting it to an empty string. Hooks can be prioritized
895 value or setting it to an empty string. Hooks can be prioritized
896 by adding a prefix of ``priority.`` to the hook name on a new line
896 by adding a prefix of ``priority.`` to the hook name on a new line
897 and setting the priority. The default priority is 0.
897 and setting the priority. The default priority is 0.
898
898
899 Example ``.hg/hgrc``::
899 Example ``.hg/hgrc``::
900
900
901 [hooks]
901 [hooks]
902 # update working directory after adding changesets
902 # update working directory after adding changesets
903 changegroup.update = hg update
903 changegroup.update = hg update
904 # do not use the site-wide hook
904 # do not use the site-wide hook
905 incoming =
905 incoming =
906 incoming.email = /my/email/hook
906 incoming.email = /my/email/hook
907 incoming.autobuild = /my/build/hook
907 incoming.autobuild = /my/build/hook
908 # force autobuild hook to run before other incoming hooks
908 # force autobuild hook to run before other incoming hooks
909 priority.incoming.autobuild = 1
909 priority.incoming.autobuild = 1
910
910
911 Most hooks are run with environment variables set that give useful
911 Most hooks are run with environment variables set that give useful
912 additional information. For each hook below, the environment variables
912 additional information. For each hook below, the environment variables
913 it is passed are listed with names in the form ``$HG_foo``. The
913 it is passed are listed with names in the form ``$HG_foo``. The
914 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
914 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
915 They contain the type of hook which triggered the run and the full name
915 They contain the type of hook which triggered the run and the full name
916 of the hook in the config, respectively. In the example above, this will
916 of the hook in the config, respectively. In the example above, this will
917 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
917 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
918
918
919 .. container:: windows
919 .. container:: windows
920
920
921 Some basic Unix syntax can be enabled for portability, including ``$VAR``
921 Some basic Unix syntax can be enabled for portability, including ``$VAR``
922 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
922 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
923 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
923 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
924 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
924 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
925 slash or inside of a strong quote. Strong quotes will be replaced by
925 slash or inside of a strong quote. Strong quotes will be replaced by
926 double quotes after processing.
926 double quotes after processing.
927
927
928 This feature is enabled by adding a prefix of ``tonative.`` to the hook
928 This feature is enabled by adding a prefix of ``tonative.`` to the hook
929 name on a new line, and setting it to ``True``. For example::
929 name on a new line, and setting it to ``True``. For example::
930
930
931 [hooks]
931 [hooks]
932 incoming.autobuild = /my/build/hook
932 incoming.autobuild = /my/build/hook
933 # enable translation to cmd.exe syntax for autobuild hook
933 # enable translation to cmd.exe syntax for autobuild hook
934 tonative.incoming.autobuild = True
934 tonative.incoming.autobuild = True
935
935
936 ``changegroup``
936 ``changegroup``
937 Run after a changegroup has been added via push, pull or unbundle. The ID of
937 Run after a changegroup has been added via push, pull or unbundle. The ID of
938 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
938 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
939 The URL from which changes came is in ``$HG_URL``.
939 The URL from which changes came is in ``$HG_URL``.
940
940
941 ``commit``
941 ``commit``
942 Run after a changeset has been created in the local repository. The ID
942 Run after a changeset has been created in the local repository. The ID
943 of the newly created changeset is in ``$HG_NODE``. Parent changeset
943 of the newly created changeset is in ``$HG_NODE``. Parent changeset
944 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
944 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
945
945
946 ``incoming``
946 ``incoming``
947 Run after a changeset has been pulled, pushed, or unbundled into
947 Run after a changeset has been pulled, pushed, or unbundled into
948 the local repository. The ID of the newly arrived changeset is in
948 the local repository. The ID of the newly arrived changeset is in
949 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
949 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
950
950
951 ``outgoing``
951 ``outgoing``
952 Run after sending changes from the local repository to another. The ID of
952 Run after sending changes from the local repository to another. The ID of
953 first changeset sent is in ``$HG_NODE``. The source of operation is in
953 first changeset sent is in ``$HG_NODE``. The source of operation is in
954 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
954 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
955
955
956 ``post-<command>``
956 ``post-<command>``
957 Run after successful invocations of the associated command. The
957 Run after successful invocations of the associated command. The
958 contents of the command line are passed as ``$HG_ARGS`` and the result
958 contents of the command line are passed as ``$HG_ARGS`` and the result
959 code in ``$HG_RESULT``. Parsed command line arguments are passed as
959 code in ``$HG_RESULT``. Parsed command line arguments are passed as
960 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
960 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
961 the python data internally passed to <command>. ``$HG_OPTS`` is a
961 the python data internally passed to <command>. ``$HG_OPTS`` is a
962 dictionary of options (with unspecified options set to their defaults).
962 dictionary of options (with unspecified options set to their defaults).
963 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
963 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
964
964
965 ``fail-<command>``
965 ``fail-<command>``
966 Run after a failed invocation of an associated command. The contents
966 Run after a failed invocation of an associated command. The contents
967 of the command line are passed as ``$HG_ARGS``. Parsed command line
967 of the command line are passed as ``$HG_ARGS``. Parsed command line
968 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
968 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
969 string representations of the python data internally passed to
969 string representations of the python data internally passed to
970 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
970 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
971 options set to their defaults). ``$HG_PATS`` is a list of arguments.
971 options set to their defaults). ``$HG_PATS`` is a list of arguments.
972 Hook failure is ignored.
972 Hook failure is ignored.
973
973
974 ``pre-<command>``
974 ``pre-<command>``
975 Run before executing the associated command. The contents of the
975 Run before executing the associated command. The contents of the
976 command line are passed as ``$HG_ARGS``. Parsed command line arguments
976 command line are passed as ``$HG_ARGS``. Parsed command line arguments
977 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
977 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
978 representations of the data internally passed to <command>. ``$HG_OPTS``
978 representations of the data internally passed to <command>. ``$HG_OPTS``
979 is a dictionary of options (with unspecified options set to their
979 is a dictionary of options (with unspecified options set to their
980 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
980 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
981 failure, the command doesn't execute and Mercurial returns the failure
981 failure, the command doesn't execute and Mercurial returns the failure
982 code.
982 code.
983
983
984 ``prechangegroup``
984 ``prechangegroup``
985 Run before a changegroup is added via push, pull or unbundle. Exit
985 Run before a changegroup is added via push, pull or unbundle. Exit
986 status 0 allows the changegroup to proceed. A non-zero status will
986 status 0 allows the changegroup to proceed. A non-zero status will
987 cause the push, pull or unbundle to fail. The URL from which changes
987 cause the push, pull or unbundle to fail. The URL from which changes
988 will come is in ``$HG_URL``.
988 will come is in ``$HG_URL``.
989
989
990 ``precommit``
990 ``precommit``
991 Run before starting a local commit. Exit status 0 allows the
991 Run before starting a local commit. Exit status 0 allows the
992 commit to proceed. A non-zero status will cause the commit to fail.
992 commit to proceed. A non-zero status will cause the commit to fail.
993 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
993 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
994
994
995 ``prelistkeys``
995 ``prelistkeys``
996 Run before listing pushkeys (like bookmarks) in the
996 Run before listing pushkeys (like bookmarks) in the
997 repository. A non-zero status will cause failure. The key namespace is
997 repository. A non-zero status will cause failure. The key namespace is
998 in ``$HG_NAMESPACE``.
998 in ``$HG_NAMESPACE``.
999
999
1000 ``preoutgoing``
1000 ``preoutgoing``
1001 Run before collecting changes to send from the local repository to
1001 Run before collecting changes to send from the local repository to
1002 another. A non-zero status will cause failure. This lets you prevent
1002 another. A non-zero status will cause failure. This lets you prevent
1003 pull over HTTP or SSH. It can also prevent propagating commits (via
1003 pull over HTTP or SSH. It can also prevent propagating commits (via
1004 local pull, push (outbound) or bundle commands), but not completely,
1004 local pull, push (outbound) or bundle commands), but not completely,
1005 since you can just copy files instead. The source of operation is in
1005 since you can just copy files instead. The source of operation is in
1006 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1006 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1007 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1007 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1008 is happening on behalf of a repository on same system.
1008 is happening on behalf of a repository on same system.
1009
1009
1010 ``prepushkey``
1010 ``prepushkey``
1011 Run before a pushkey (like a bookmark) is added to the
1011 Run before a pushkey (like a bookmark) is added to the
1012 repository. A non-zero status will cause the key to be rejected. The
1012 repository. A non-zero status will cause the key to be rejected. The
1013 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1013 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1014 the old value (if any) is in ``$HG_OLD``, and the new value is in
1014 the old value (if any) is in ``$HG_OLD``, and the new value is in
1015 ``$HG_NEW``.
1015 ``$HG_NEW``.
1016
1016
1017 ``pretag``
1017 ``pretag``
1018 Run before creating a tag. Exit status 0 allows the tag to be
1018 Run before creating a tag. Exit status 0 allows the tag to be
1019 created. A non-zero status will cause the tag to fail. The ID of the
1019 created. A non-zero status will cause the tag to fail. The ID of the
1020 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1020 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1021 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1021 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1022
1022
1023 ``pretxnopen``
1023 ``pretxnopen``
1024 Run before any new repository transaction is open. The reason for the
1024 Run before any new repository transaction is open. The reason for the
1025 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1025 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1026 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
1026 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
1027 transaction from being opened.
1027 transaction from being opened.
1028
1028
1029 ``pretxnclose``
1029 ``pretxnclose``
1030 Run right before the transaction is actually finalized. Any repository change
1030 Run right before the transaction is actually finalized. Any repository change
1031 will be visible to the hook program. This lets you validate the transaction
1031 will be visible to the hook program. This lets you validate the transaction
1032 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1032 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1033 status will cause the transaction to be rolled back. The reason for the
1033 status will cause the transaction to be rolled back. The reason for the
1034 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1034 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1035 the transaction will be in ``HG_TXNID``. The rest of the available data will
1035 the transaction will be in ``HG_TXNID``. The rest of the available data will
1036 vary according the transaction type. New changesets will add ``$HG_NODE``
1036 vary according the transaction type. New changesets will add ``$HG_NODE``
1037 (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
1037 (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
1038 added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
1038 added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
1039 phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
1039 phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
1040 respectively, etc.
1040 respectively, etc.
1041
1041
1042 ``pretxnclose-bookmark``
1042 ``pretxnclose-bookmark``
1043 Run right before a bookmark change is actually finalized. Any repository
1043 Run right before a bookmark change is actually finalized. Any repository
1044 change will be visible to the hook program. This lets you validate the
1044 change will be visible to the hook program. This lets you validate the
1045 transaction content or change it. Exit status 0 allows the commit to
1045 transaction content or change it. Exit status 0 allows the commit to
1046 proceed. A non-zero status will cause the transaction to be rolled back.
1046 proceed. A non-zero status will cause the transaction to be rolled back.
1047 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1047 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1048 bookmark location will be available in ``$HG_NODE`` while the previous
1048 bookmark location will be available in ``$HG_NODE`` while the previous
1049 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1049 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1050 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1050 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1051 will be empty.
1051 will be empty.
1052 In addition, the reason for the transaction opening will be in
1052 In addition, the reason for the transaction opening will be in
1053 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1053 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1054 ``HG_TXNID``.
1054 ``HG_TXNID``.
1055
1055
1056 ``pretxnclose-phase``
1056 ``pretxnclose-phase``
1057 Run right before a phase change is actually finalized. Any repository change
1057 Run right before a phase change is actually finalized. Any repository change
1058 will be visible to the hook program. This lets you validate the transaction
1058 will be visible to the hook program. This lets you validate the transaction
1059 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1059 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1060 status will cause the transaction to be rolled back. The hook is called
1060 status will cause the transaction to be rolled back. The hook is called
1061 multiple times, once for each revision affected by a phase change.
1061 multiple times, once for each revision affected by a phase change.
1062 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1062 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1063 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1063 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1064 will be empty. In addition, the reason for the transaction opening will be in
1064 will be empty. In addition, the reason for the transaction opening will be in
1065 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1065 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1066 ``HG_TXNID``. The hook is also run for newly added revisions. In this case
1066 ``HG_TXNID``. The hook is also run for newly added revisions. In this case
1067 the ``$HG_OLDPHASE`` entry will be empty.
1067 the ``$HG_OLDPHASE`` entry will be empty.
1068
1068
1069 ``txnclose``
1069 ``txnclose``
1070 Run after any repository transaction has been committed. At this
1070 Run after any repository transaction has been committed. At this
1071 point, the transaction can no longer be rolled back. The hook will run
1071 point, the transaction can no longer be rolled back. The hook will run
1072 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1072 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1073 details about available variables.
1073 details about available variables.
1074
1074
1075 ``txnclose-bookmark``
1075 ``txnclose-bookmark``
1076 Run after any bookmark change has been committed. At this point, the
1076 Run after any bookmark change has been committed. At this point, the
1077 transaction can no longer be rolled back. The hook will run after the lock
1077 transaction can no longer be rolled back. The hook will run after the lock
1078 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1078 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1079 about available variables.
1079 about available variables.
1080
1080
1081 ``txnclose-phase``
1081 ``txnclose-phase``
1082 Run after any phase change has been committed. At this point, the
1082 Run after any phase change has been committed. At this point, the
1083 transaction can no longer be rolled back. The hook will run after the lock
1083 transaction can no longer be rolled back. The hook will run after the lock
1084 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1084 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1085 available variables.
1085 available variables.
1086
1086
1087 ``txnabort``
1087 ``txnabort``
1088 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1088 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1089 for details about available variables.
1089 for details about available variables.
1090
1090
1091 ``pretxnchangegroup``
1091 ``pretxnchangegroup``
1092 Run after a changegroup has been added via push, pull or unbundle, but before
1092 Run after a changegroup has been added via push, pull or unbundle, but before
1093 the transaction has been committed. The changegroup is visible to the hook
1093 the transaction has been committed. The changegroup is visible to the hook
1094 program. This allows validation of incoming changes before accepting them.
1094 program. This allows validation of incoming changes before accepting them.
1095 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1095 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1096 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1096 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1097 status will cause the transaction to be rolled back, and the push, pull or
1097 status will cause the transaction to be rolled back, and the push, pull or
1098 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1098 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1099
1099
1100 ``pretxncommit``
1100 ``pretxncommit``
1101 Run after a changeset has been created, but before the transaction is
1101 Run after a changeset has been created, but before the transaction is
1102 committed. The changeset is visible to the hook program. This allows
1102 committed. The changeset is visible to the hook program. This allows
1103 validation of the commit message and changes. Exit status 0 allows the
1103 validation of the commit message and changes. Exit status 0 allows the
1104 commit to proceed. A non-zero status will cause the transaction to
1104 commit to proceed. A non-zero status will cause the transaction to
1105 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1105 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1106 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1106 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1107
1107
1108 ``preupdate``
1108 ``preupdate``
1109 Run before updating the working directory. Exit status 0 allows
1109 Run before updating the working directory. Exit status 0 allows
1110 the update to proceed. A non-zero status will prevent the update.
1110 the update to proceed. A non-zero status will prevent the update.
1111 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1111 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1112 merge, the ID of second new parent is in ``$HG_PARENT2``.
1112 merge, the ID of second new parent is in ``$HG_PARENT2``.
1113
1113
1114 ``listkeys``
1114 ``listkeys``
1115 Run after listing pushkeys (like bookmarks) in the repository. The
1115 Run after listing pushkeys (like bookmarks) in the repository. The
1116 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1116 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1117 dictionary containing the keys and values.
1117 dictionary containing the keys and values.
1118
1118
1119 ``pushkey``
1119 ``pushkey``
1120 Run after a pushkey (like a bookmark) is added to the
1120 Run after a pushkey (like a bookmark) is added to the
1121 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1121 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1122 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1122 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1123 value is in ``$HG_NEW``.
1123 value is in ``$HG_NEW``.
1124
1124
1125 ``tag``
1125 ``tag``
1126 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1126 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1127 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1127 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1128 the repository if ``$HG_LOCAL=0``.
1128 the repository if ``$HG_LOCAL=0``.
1129
1129
1130 ``update``
1130 ``update``
1131 Run after updating the working directory. The changeset ID of first
1131 Run after updating the working directory. The changeset ID of first
1132 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1132 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1133 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1133 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1134 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1134 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1135
1135
1136 .. note::
1136 .. note::
1137
1137
1138 It is generally better to use standard hooks rather than the
1138 It is generally better to use standard hooks rather than the
1139 generic pre- and post- command hooks, as they are guaranteed to be
1139 generic pre- and post- command hooks, as they are guaranteed to be
1140 called in the appropriate contexts for influencing transactions.
1140 called in the appropriate contexts for influencing transactions.
1141 Also, hooks like "commit" will be called in all contexts that
1141 Also, hooks like "commit" will be called in all contexts that
1142 generate a commit (e.g. tag) and not just the commit command.
1142 generate a commit (e.g. tag) and not just the commit command.
1143
1143
1144 .. note::
1144 .. note::
1145
1145
1146 Environment variables with empty values may not be passed to
1146 Environment variables with empty values may not be passed to
1147 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1147 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1148 will have an empty value under Unix-like platforms for non-merge
1148 will have an empty value under Unix-like platforms for non-merge
1149 changesets, while it will not be available at all under Windows.
1149 changesets, while it will not be available at all under Windows.
1150
1150
1151 The syntax for Python hooks is as follows::
1151 The syntax for Python hooks is as follows::
1152
1152
1153 hookname = python:modulename.submodule.callable
1153 hookname = python:modulename.submodule.callable
1154 hookname = python:/path/to/python/module.py:callable
1154 hookname = python:/path/to/python/module.py:callable
1155
1155
1156 Python hooks are run within the Mercurial process. Each hook is
1156 Python hooks are run within the Mercurial process. Each hook is
1157 called with at least three keyword arguments: a ui object (keyword
1157 called with at least three keyword arguments: a ui object (keyword
1158 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1158 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1159 keyword that tells what kind of hook is used. Arguments listed as
1159 keyword that tells what kind of hook is used. Arguments listed as
1160 environment variables above are passed as keyword arguments, with no
1160 environment variables above are passed as keyword arguments, with no
1161 ``HG_`` prefix, and names in lower case.
1161 ``HG_`` prefix, and names in lower case.
1162
1162
1163 If a Python hook returns a "true" value or raises an exception, this
1163 If a Python hook returns a "true" value or raises an exception, this
1164 is treated as a failure.
1164 is treated as a failure.
1165
1165
1166
1166
1167 ``hostfingerprints``
1167 ``hostfingerprints``
1168 --------------------
1168 --------------------
1169
1169
1170 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1170 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1171
1171
1172 Fingerprints of the certificates of known HTTPS servers.
1172 Fingerprints of the certificates of known HTTPS servers.
1173
1173
1174 A HTTPS connection to a server with a fingerprint configured here will
1174 A HTTPS connection to a server with a fingerprint configured here will
1175 only succeed if the servers certificate matches the fingerprint.
1175 only succeed if the servers certificate matches the fingerprint.
1176 This is very similar to how ssh known hosts works.
1176 This is very similar to how ssh known hosts works.
1177
1177
1178 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1178 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1179 Multiple values can be specified (separated by spaces or commas). This can
1179 Multiple values can be specified (separated by spaces or commas). This can
1180 be used to define both old and new fingerprints while a host transitions
1180 be used to define both old and new fingerprints while a host transitions
1181 to a new certificate.
1181 to a new certificate.
1182
1182
1183 The CA chain and web.cacerts is not used for servers with a fingerprint.
1183 The CA chain and web.cacerts is not used for servers with a fingerprint.
1184
1184
1185 For example::
1185 For example::
1186
1186
1187 [hostfingerprints]
1187 [hostfingerprints]
1188 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1188 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1189 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1189 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1190
1190
1191 ``hostsecurity``
1191 ``hostsecurity``
1192 ----------------
1192 ----------------
1193
1193
1194 Used to specify global and per-host security settings for connecting to
1194 Used to specify global and per-host security settings for connecting to
1195 other machines.
1195 other machines.
1196
1196
1197 The following options control default behavior for all hosts.
1197 The following options control default behavior for all hosts.
1198
1198
1199 ``ciphers``
1199 ``ciphers``
1200 Defines the cryptographic ciphers to use for connections.
1200 Defines the cryptographic ciphers to use for connections.
1201
1201
1202 Value must be a valid OpenSSL Cipher List Format as documented at
1202 Value must be a valid OpenSSL Cipher List Format as documented at
1203 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1203 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1204
1204
1205 This setting is for advanced users only. Setting to incorrect values
1205 This setting is for advanced users only. Setting to incorrect values
1206 can significantly lower connection security or decrease performance.
1206 can significantly lower connection security or decrease performance.
1207 You have been warned.
1207 You have been warned.
1208
1208
1209 This option requires Python 2.7.
1209 This option requires Python 2.7.
1210
1210
1211 ``minimumprotocol``
1211 ``minimumprotocol``
1212 Defines the minimum channel encryption protocol to use.
1212 Defines the minimum channel encryption protocol to use.
1213
1213
1214 By default, the highest version of TLS supported by both client and server
1214 By default, the highest version of TLS supported by both client and server
1215 is used.
1215 is used.
1216
1216
1217 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1217 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1218
1218
1219 When running on an old Python version, only ``tls1.0`` is allowed since
1219 When running on an old Python version, only ``tls1.0`` is allowed since
1220 old versions of Python only support up to TLS 1.0.
1220 old versions of Python only support up to TLS 1.0.
1221
1221
1222 When running a Python that supports modern TLS versions, the default is
1222 When running a Python that supports modern TLS versions, the default is
1223 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1223 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1224 weakens security and should only be used as a feature of last resort if
1224 weakens security and should only be used as a feature of last resort if
1225 a server does not support TLS 1.1+.
1225 a server does not support TLS 1.1+.
1226
1226
1227 Options in the ``[hostsecurity]`` section can have the form
1227 Options in the ``[hostsecurity]`` section can have the form
1228 ``hostname``:``setting``. This allows multiple settings to be defined on a
1228 ``hostname``:``setting``. This allows multiple settings to be defined on a
1229 per-host basis.
1229 per-host basis.
1230
1230
1231 The following per-host settings can be defined.
1231 The following per-host settings can be defined.
1232
1232
1233 ``ciphers``
1233 ``ciphers``
1234 This behaves like ``ciphers`` as described above except it only applies
1234 This behaves like ``ciphers`` as described above except it only applies
1235 to the host on which it is defined.
1235 to the host on which it is defined.
1236
1236
1237 ``fingerprints``
1237 ``fingerprints``
1238 A list of hashes of the DER encoded peer/remote certificate. Values have
1238 A list of hashes of the DER encoded peer/remote certificate. Values have
1239 the form ``algorithm``:``fingerprint``. e.g.
1239 the form ``algorithm``:``fingerprint``. e.g.
1240 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1240 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1241 In addition, colons (``:``) can appear in the fingerprint part.
1241 In addition, colons (``:``) can appear in the fingerprint part.
1242
1242
1243 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1243 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1244 ``sha512``.
1244 ``sha512``.
1245
1245
1246 Use of ``sha256`` or ``sha512`` is preferred.
1246 Use of ``sha256`` or ``sha512`` is preferred.
1247
1247
1248 If a fingerprint is specified, the CA chain is not validated for this
1248 If a fingerprint is specified, the CA chain is not validated for this
1249 host and Mercurial will require the remote certificate to match one
1249 host and Mercurial will require the remote certificate to match one
1250 of the fingerprints specified. This means if the server updates its
1250 of the fingerprints specified. This means if the server updates its
1251 certificate, Mercurial will abort until a new fingerprint is defined.
1251 certificate, Mercurial will abort until a new fingerprint is defined.
1252 This can provide stronger security than traditional CA-based validation
1252 This can provide stronger security than traditional CA-based validation
1253 at the expense of convenience.
1253 at the expense of convenience.
1254
1254
1255 This option takes precedence over ``verifycertsfile``.
1255 This option takes precedence over ``verifycertsfile``.
1256
1256
1257 ``minimumprotocol``
1257 ``minimumprotocol``
1258 This behaves like ``minimumprotocol`` as described above except it
1258 This behaves like ``minimumprotocol`` as described above except it
1259 only applies to the host on which it is defined.
1259 only applies to the host on which it is defined.
1260
1260
1261 ``verifycertsfile``
1261 ``verifycertsfile``
1262 Path to file a containing a list of PEM encoded certificates used to
1262 Path to file a containing a list of PEM encoded certificates used to
1263 verify the server certificate. Environment variables and ``~user``
1263 verify the server certificate. Environment variables and ``~user``
1264 constructs are expanded in the filename.
1264 constructs are expanded in the filename.
1265
1265
1266 The server certificate or the certificate's certificate authority (CA)
1266 The server certificate or the certificate's certificate authority (CA)
1267 must match a certificate from this file or certificate verification
1267 must match a certificate from this file or certificate verification
1268 will fail and connections to the server will be refused.
1268 will fail and connections to the server will be refused.
1269
1269
1270 If defined, only certificates provided by this file will be used:
1270 If defined, only certificates provided by this file will be used:
1271 ``web.cacerts`` and any system/default certificates will not be
1271 ``web.cacerts`` and any system/default certificates will not be
1272 used.
1272 used.
1273
1273
1274 This option has no effect if the per-host ``fingerprints`` option
1274 This option has no effect if the per-host ``fingerprints`` option
1275 is set.
1275 is set.
1276
1276
1277 The format of the file is as follows::
1277 The format of the file is as follows::
1278
1278
1279 -----BEGIN CERTIFICATE-----
1279 -----BEGIN CERTIFICATE-----
1280 ... (certificate in base64 PEM encoding) ...
1280 ... (certificate in base64 PEM encoding) ...
1281 -----END CERTIFICATE-----
1281 -----END CERTIFICATE-----
1282 -----BEGIN CERTIFICATE-----
1282 -----BEGIN CERTIFICATE-----
1283 ... (certificate in base64 PEM encoding) ...
1283 ... (certificate in base64 PEM encoding) ...
1284 -----END CERTIFICATE-----
1284 -----END CERTIFICATE-----
1285
1285
1286 For example::
1286 For example::
1287
1287
1288 [hostsecurity]
1288 [hostsecurity]
1289 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1289 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1290 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
1290 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
1291 hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
1291 hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
1292 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1292 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1293
1293
1294 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1294 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1295 when connecting to ``hg.example.com``::
1295 when connecting to ``hg.example.com``::
1296
1296
1297 [hostsecurity]
1297 [hostsecurity]
1298 minimumprotocol = tls1.2
1298 minimumprotocol = tls1.2
1299 hg.example.com:minimumprotocol = tls1.1
1299 hg.example.com:minimumprotocol = tls1.1
1300
1300
1301 ``http_proxy``
1301 ``http_proxy``
1302 --------------
1302 --------------
1303
1303
1304 Used to access web-based Mercurial repositories through a HTTP
1304 Used to access web-based Mercurial repositories through a HTTP
1305 proxy.
1305 proxy.
1306
1306
1307 ``host``
1307 ``host``
1308 Host name and (optional) port of the proxy server, for example
1308 Host name and (optional) port of the proxy server, for example
1309 "myproxy:8000".
1309 "myproxy:8000".
1310
1310
1311 ``no``
1311 ``no``
1312 Optional. Comma-separated list of host names that should bypass
1312 Optional. Comma-separated list of host names that should bypass
1313 the proxy.
1313 the proxy.
1314
1314
1315 ``passwd``
1315 ``passwd``
1316 Optional. Password to authenticate with at the proxy server.
1316 Optional. Password to authenticate with at the proxy server.
1317
1317
1318 ``user``
1318 ``user``
1319 Optional. User name to authenticate with at the proxy server.
1319 Optional. User name to authenticate with at the proxy server.
1320
1320
1321 ``always``
1321 ``always``
1322 Optional. Always use the proxy, even for localhost and any entries
1322 Optional. Always use the proxy, even for localhost and any entries
1323 in ``http_proxy.no``. (default: False)
1323 in ``http_proxy.no``. (default: False)
1324
1324
1325 ``http``
1325 ``http``
1326 ----------
1326 ----------
1327
1327
1328 Used to configure access to Mercurial repositories via HTTP.
1328 Used to configure access to Mercurial repositories via HTTP.
1329
1329
1330 ``timeout``
1330 ``timeout``
1331 If set, blocking operations will timeout after that many seconds.
1331 If set, blocking operations will timeout after that many seconds.
1332 (default: None)
1332 (default: None)
1333
1333
1334 ``merge``
1334 ``merge``
1335 ---------
1335 ---------
1336
1336
1337 This section specifies behavior during merges and updates.
1337 This section specifies behavior during merges and updates.
1338
1338
1339 ``checkignored``
1339 ``checkignored``
1340 Controls behavior when an ignored file on disk has the same name as a tracked
1340 Controls behavior when an ignored file on disk has the same name as a tracked
1341 file in the changeset being merged or updated to, and has different
1341 file in the changeset being merged or updated to, and has different
1342 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1342 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1343 abort on such files. With ``warn``, warn on such files and back them up as
1343 abort on such files. With ``warn``, warn on such files and back them up as
1344 ``.orig``. With ``ignore``, don't print a warning and back them up as
1344 ``.orig``. With ``ignore``, don't print a warning and back them up as
1345 ``.orig``. (default: ``abort``)
1345 ``.orig``. (default: ``abort``)
1346
1346
1347 ``checkunknown``
1347 ``checkunknown``
1348 Controls behavior when an unknown file that isn't ignored has the same name
1348 Controls behavior when an unknown file that isn't ignored has the same name
1349 as a tracked file in the changeset being merged or updated to, and has
1349 as a tracked file in the changeset being merged or updated to, and has
1350 different contents. Similar to ``merge.checkignored``, except for files that
1350 different contents. Similar to ``merge.checkignored``, except for files that
1351 are not ignored. (default: ``abort``)
1351 are not ignored. (default: ``abort``)
1352
1352
1353 ``on-failure``
1353 ``on-failure``
1354 When set to ``continue`` (the default), the merge process attempts to
1354 When set to ``continue`` (the default), the merge process attempts to
1355 merge all unresolved files using the merge chosen tool, regardless of
1355 merge all unresolved files using the merge chosen tool, regardless of
1356 whether previous file merge attempts during the process succeeded or not.
1356 whether previous file merge attempts during the process succeeded or not.
1357 Setting this to ``prompt`` will prompt after any merge failure continue
1357 Setting this to ``prompt`` will prompt after any merge failure continue
1358 or halt the merge process. Setting this to ``halt`` will automatically
1358 or halt the merge process. Setting this to ``halt`` will automatically
1359 halt the merge process on any merge tool failure. The merge process
1359 halt the merge process on any merge tool failure. The merge process
1360 can be restarted by using the ``resolve`` command. When a merge is
1360 can be restarted by using the ``resolve`` command. When a merge is
1361 halted, the repository is left in a normal ``unresolved`` merge state.
1361 halted, the repository is left in a normal ``unresolved`` merge state.
1362 (default: ``continue``)
1362 (default: ``continue``)
1363
1363
1364 ``strict-capability-check``
1364 ``strict-capability-check``
1365 Whether capabilities of internal merge tools are checked strictly
1365 Whether capabilities of internal merge tools are checked strictly
1366 or not, while examining rules to decide merge tool to be used.
1366 or not, while examining rules to decide merge tool to be used.
1367 (default: False)
1367 (default: False)
1368
1368
1369 ``merge-patterns``
1369 ``merge-patterns``
1370 ------------------
1370 ------------------
1371
1371
1372 This section specifies merge tools to associate with particular file
1372 This section specifies merge tools to associate with particular file
1373 patterns. Tools matched here will take precedence over the default
1373 patterns. Tools matched here will take precedence over the default
1374 merge tool. Patterns are globs by default, rooted at the repository
1374 merge tool. Patterns are globs by default, rooted at the repository
1375 root.
1375 root.
1376
1376
1377 Example::
1377 Example::
1378
1378
1379 [merge-patterns]
1379 [merge-patterns]
1380 **.c = kdiff3
1380 **.c = kdiff3
1381 **.jpg = myimgmerge
1381 **.jpg = myimgmerge
1382
1382
1383 ``merge-tools``
1383 ``merge-tools``
1384 ---------------
1384 ---------------
1385
1385
1386 This section configures external merge tools to use for file-level
1386 This section configures external merge tools to use for file-level
1387 merges. This section has likely been preconfigured at install time.
1387 merges. This section has likely been preconfigured at install time.
1388 Use :hg:`config merge-tools` to check the existing configuration.
1388 Use :hg:`config merge-tools` to check the existing configuration.
1389 Also see :hg:`help merge-tools` for more details.
1389 Also see :hg:`help merge-tools` for more details.
1390
1390
1391 Example ``~/.hgrc``::
1391 Example ``~/.hgrc``::
1392
1392
1393 [merge-tools]
1393 [merge-tools]
1394 # Override stock tool location
1394 # Override stock tool location
1395 kdiff3.executable = ~/bin/kdiff3
1395 kdiff3.executable = ~/bin/kdiff3
1396 # Specify command line
1396 # Specify command line
1397 kdiff3.args = $base $local $other -o $output
1397 kdiff3.args = $base $local $other -o $output
1398 # Give higher priority
1398 # Give higher priority
1399 kdiff3.priority = 1
1399 kdiff3.priority = 1
1400
1400
1401 # Changing the priority of preconfigured tool
1401 # Changing the priority of preconfigured tool
1402 meld.priority = 0
1402 meld.priority = 0
1403
1403
1404 # Disable a preconfigured tool
1404 # Disable a preconfigured tool
1405 vimdiff.disabled = yes
1405 vimdiff.disabled = yes
1406
1406
1407 # Define new tool
1407 # Define new tool
1408 myHtmlTool.args = -m $local $other $base $output
1408 myHtmlTool.args = -m $local $other $base $output
1409 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1409 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1410 myHtmlTool.priority = 1
1410 myHtmlTool.priority = 1
1411
1411
1412 Supported arguments:
1412 Supported arguments:
1413
1413
1414 ``priority``
1414 ``priority``
1415 The priority in which to evaluate this tool.
1415 The priority in which to evaluate this tool.
1416 (default: 0)
1416 (default: 0)
1417
1417
1418 ``executable``
1418 ``executable``
1419 Either just the name of the executable or its pathname.
1419 Either just the name of the executable or its pathname.
1420
1420
1421 .. container:: windows
1421 .. container:: windows
1422
1422
1423 On Windows, the path can use environment variables with ${ProgramFiles}
1423 On Windows, the path can use environment variables with ${ProgramFiles}
1424 syntax.
1424 syntax.
1425
1425
1426 (default: the tool name)
1426 (default: the tool name)
1427
1427
1428 ``args``
1428 ``args``
1429 The arguments to pass to the tool executable. You can refer to the
1429 The arguments to pass to the tool executable. You can refer to the
1430 files being merged as well as the output file through these
1430 files being merged as well as the output file through these
1431 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1431 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1432
1432
1433 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1433 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1434 being performed. During an update or merge, ``$local`` represents the original
1434 being performed. During an update or merge, ``$local`` represents the original
1435 state of the file, while ``$other`` represents the commit you are updating to or
1435 state of the file, while ``$other`` represents the commit you are updating to or
1436 the commit you are merging with. During a rebase, ``$local`` represents the
1436 the commit you are merging with. During a rebase, ``$local`` represents the
1437 destination of the rebase, and ``$other`` represents the commit being rebased.
1437 destination of the rebase, and ``$other`` represents the commit being rebased.
1438
1438
1439 Some operations define custom labels to assist with identifying the revisions,
1439 Some operations define custom labels to assist with identifying the revisions,
1440 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1440 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1441 labels are not available, these will be ``local``, ``other``, and ``base``,
1441 labels are not available, these will be ``local``, ``other``, and ``base``,
1442 respectively.
1442 respectively.
1443 (default: ``$local $base $other``)
1443 (default: ``$local $base $other``)
1444
1444
1445 ``premerge``
1445 ``premerge``
1446 Attempt to run internal non-interactive 3-way merge tool before
1446 Attempt to run internal non-interactive 3-way merge tool before
1447 launching external tool. Options are ``true``, ``false``, ``keep`` or
1447 launching external tool. Options are ``true``, ``false``, ``keep`` or
1448 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1448 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1449 premerge fails. The ``keep-merge3`` will do the same but include information
1449 premerge fails. The ``keep-merge3`` will do the same but include information
1450 about the base of the merge in the marker (see internal :merge3 in
1450 about the base of the merge in the marker (see internal :merge3 in
1451 :hg:`help merge-tools`).
1451 :hg:`help merge-tools`).
1452 (default: True)
1452 (default: True)
1453
1453
1454 ``binary``
1454 ``binary``
1455 This tool can merge binary files. (default: False, unless tool
1455 This tool can merge binary files. (default: False, unless tool
1456 was selected by file pattern match)
1456 was selected by file pattern match)
1457
1457
1458 ``symlink``
1458 ``symlink``
1459 This tool can merge symlinks. (default: False)
1459 This tool can merge symlinks. (default: False)
1460
1460
1461 ``check``
1461 ``check``
1462 A list of merge success-checking options:
1462 A list of merge success-checking options:
1463
1463
1464 ``changed``
1464 ``changed``
1465 Ask whether merge was successful when the merged file shows no changes.
1465 Ask whether merge was successful when the merged file shows no changes.
1466 ``conflicts``
1466 ``conflicts``
1467 Check whether there are conflicts even though the tool reported success.
1467 Check whether there are conflicts even though the tool reported success.
1468 ``prompt``
1468 ``prompt``
1469 Always prompt for merge success, regardless of success reported by tool.
1469 Always prompt for merge success, regardless of success reported by tool.
1470
1470
1471 ``fixeol``
1471 ``fixeol``
1472 Attempt to fix up EOL changes caused by the merge tool.
1472 Attempt to fix up EOL changes caused by the merge tool.
1473 (default: False)
1473 (default: False)
1474
1474
1475 ``gui``
1475 ``gui``
1476 This tool requires a graphical interface to run. (default: False)
1476 This tool requires a graphical interface to run. (default: False)
1477
1477
1478 ``mergemarkers``
1478 ``mergemarkers``
1479 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1479 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1480 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1480 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1481 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1481 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1482 markers generated during premerge will be ``detailed`` if either this option or
1482 markers generated during premerge will be ``detailed`` if either this option or
1483 the corresponding option in the ``[ui]`` section is ``detailed``.
1483 the corresponding option in the ``[ui]`` section is ``detailed``.
1484 (default: ``basic``)
1484 (default: ``basic``)
1485
1485
1486 ``mergemarkertemplate``
1486 ``mergemarkertemplate``
1487 This setting can be used to override ``mergemarkertemplate`` from the ``[ui]``
1487 This setting can be used to override ``mergemarkertemplate`` from the ``[ui]``
1488 section on a per-tool basis; this applies to the ``$label``-prefixed variables
1488 section on a per-tool basis; this applies to the ``$label``-prefixed variables
1489 and to the conflict markers that are generated if ``premerge`` is ``keep` or
1489 and to the conflict markers that are generated if ``premerge`` is ``keep` or
1490 ``keep-merge3``. See the corresponding variable in ``[ui]`` for more
1490 ``keep-merge3``. See the corresponding variable in ``[ui]`` for more
1491 information.
1491 information.
1492
1492
1493 .. container:: windows
1493 .. container:: windows
1494
1494
1495 ``regkey``
1495 ``regkey``
1496 Windows registry key which describes install location of this
1496 Windows registry key which describes install location of this
1497 tool. Mercurial will search for this key first under
1497 tool. Mercurial will search for this key first under
1498 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1498 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1499 (default: None)
1499 (default: None)
1500
1500
1501 ``regkeyalt``
1501 ``regkeyalt``
1502 An alternate Windows registry key to try if the first key is not
1502 An alternate Windows registry key to try if the first key is not
1503 found. The alternate key uses the same ``regname`` and ``regappend``
1503 found. The alternate key uses the same ``regname`` and ``regappend``
1504 semantics of the primary key. The most common use for this key
1504 semantics of the primary key. The most common use for this key
1505 is to search for 32bit applications on 64bit operating systems.
1505 is to search for 32bit applications on 64bit operating systems.
1506 (default: None)
1506 (default: None)
1507
1507
1508 ``regname``
1508 ``regname``
1509 Name of value to read from specified registry key.
1509 Name of value to read from specified registry key.
1510 (default: the unnamed (default) value)
1510 (default: the unnamed (default) value)
1511
1511
1512 ``regappend``
1512 ``regappend``
1513 String to append to the value read from the registry, typically
1513 String to append to the value read from the registry, typically
1514 the executable name of the tool.
1514 the executable name of the tool.
1515 (default: None)
1515 (default: None)
1516
1516
1517 ``pager``
1517 ``pager``
1518 ---------
1518 ---------
1519
1519
1520 Setting used to control when to paginate and with what external tool. See
1520 Setting used to control when to paginate and with what external tool. See
1521 :hg:`help pager` for details.
1521 :hg:`help pager` for details.
1522
1522
1523 ``pager``
1523 ``pager``
1524 Define the external tool used as pager.
1524 Define the external tool used as pager.
1525
1525
1526 If no pager is set, Mercurial uses the environment variable $PAGER.
1526 If no pager is set, Mercurial uses the environment variable $PAGER.
1527 If neither pager.pager, nor $PAGER is set, a default pager will be
1527 If neither pager.pager, nor $PAGER is set, a default pager will be
1528 used, typically `less` on Unix and `more` on Windows. Example::
1528 used, typically `less` on Unix and `more` on Windows. Example::
1529
1529
1530 [pager]
1530 [pager]
1531 pager = less -FRX
1531 pager = less -FRX
1532
1532
1533 ``ignore``
1533 ``ignore``
1534 List of commands to disable the pager for. Example::
1534 List of commands to disable the pager for. Example::
1535
1535
1536 [pager]
1536 [pager]
1537 ignore = version, help, update
1537 ignore = version, help, update
1538
1538
1539 ``patch``
1539 ``patch``
1540 ---------
1540 ---------
1541
1541
1542 Settings used when applying patches, for instance through the 'import'
1542 Settings used when applying patches, for instance through the 'import'
1543 command or with Mercurial Queues extension.
1543 command or with Mercurial Queues extension.
1544
1544
1545 ``eol``
1545 ``eol``
1546 When set to 'strict' patch content and patched files end of lines
1546 When set to 'strict' patch content and patched files end of lines
1547 are preserved. When set to ``lf`` or ``crlf``, both files end of
1547 are preserved. When set to ``lf`` or ``crlf``, both files end of
1548 lines are ignored when patching and the result line endings are
1548 lines are ignored when patching and the result line endings are
1549 normalized to either LF (Unix) or CRLF (Windows). When set to
1549 normalized to either LF (Unix) or CRLF (Windows). When set to
1550 ``auto``, end of lines are again ignored while patching but line
1550 ``auto``, end of lines are again ignored while patching but line
1551 endings in patched files are normalized to their original setting
1551 endings in patched files are normalized to their original setting
1552 on a per-file basis. If target file does not exist or has no end
1552 on a per-file basis. If target file does not exist or has no end
1553 of line, patch line endings are preserved.
1553 of line, patch line endings are preserved.
1554 (default: strict)
1554 (default: strict)
1555
1555
1556 ``fuzz``
1556 ``fuzz``
1557 The number of lines of 'fuzz' to allow when applying patches. This
1557 The number of lines of 'fuzz' to allow when applying patches. This
1558 controls how much context the patcher is allowed to ignore when
1558 controls how much context the patcher is allowed to ignore when
1559 trying to apply a patch.
1559 trying to apply a patch.
1560 (default: 2)
1560 (default: 2)
1561
1561
1562 ``paths``
1562 ``paths``
1563 ---------
1563 ---------
1564
1564
1565 Assigns symbolic names and behavior to repositories.
1565 Assigns symbolic names and behavior to repositories.
1566
1566
1567 Options are symbolic names defining the URL or directory that is the
1567 Options are symbolic names defining the URL or directory that is the
1568 location of the repository. Example::
1568 location of the repository. Example::
1569
1569
1570 [paths]
1570 [paths]
1571 my_server = https://example.com/my_repo
1571 my_server = https://example.com/my_repo
1572 local_path = /home/me/repo
1572 local_path = /home/me/repo
1573
1573
1574 These symbolic names can be used from the command line. To pull
1574 These symbolic names can be used from the command line. To pull
1575 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1575 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1576 :hg:`push local_path`.
1576 :hg:`push local_path`.
1577
1577
1578 Options containing colons (``:``) denote sub-options that can influence
1578 Options containing colons (``:``) denote sub-options that can influence
1579 behavior for that specific path. Example::
1579 behavior for that specific path. Example::
1580
1580
1581 [paths]
1581 [paths]
1582 my_server = https://example.com/my_path
1582 my_server = https://example.com/my_path
1583 my_server:pushurl = ssh://example.com/my_path
1583 my_server:pushurl = ssh://example.com/my_path
1584
1584
1585 The following sub-options can be defined:
1585 The following sub-options can be defined:
1586
1586
1587 ``pushurl``
1587 ``pushurl``
1588 The URL to use for push operations. If not defined, the location
1588 The URL to use for push operations. If not defined, the location
1589 defined by the path's main entry is used.
1589 defined by the path's main entry is used.
1590
1590
1591 ``pushrev``
1591 ``pushrev``
1592 A revset defining which revisions to push by default.
1592 A revset defining which revisions to push by default.
1593
1593
1594 When :hg:`push` is executed without a ``-r`` argument, the revset
1594 When :hg:`push` is executed without a ``-r`` argument, the revset
1595 defined by this sub-option is evaluated to determine what to push.
1595 defined by this sub-option is evaluated to determine what to push.
1596
1596
1597 For example, a value of ``.`` will push the working directory's
1597 For example, a value of ``.`` will push the working directory's
1598 revision by default.
1598 revision by default.
1599
1599
1600 Revsets specifying bookmarks will not result in the bookmark being
1600 Revsets specifying bookmarks will not result in the bookmark being
1601 pushed.
1601 pushed.
1602
1602
1603 The following special named paths exist:
1603 The following special named paths exist:
1604
1604
1605 ``default``
1605 ``default``
1606 The URL or directory to use when no source or remote is specified.
1606 The URL or directory to use when no source or remote is specified.
1607
1607
1608 :hg:`clone` will automatically define this path to the location the
1608 :hg:`clone` will automatically define this path to the location the
1609 repository was cloned from.
1609 repository was cloned from.
1610
1610
1611 ``default-push``
1611 ``default-push``
1612 (deprecated) The URL or directory for the default :hg:`push` location.
1612 (deprecated) The URL or directory for the default :hg:`push` location.
1613 ``default:pushurl`` should be used instead.
1613 ``default:pushurl`` should be used instead.
1614
1614
1615 ``phases``
1615 ``phases``
1616 ----------
1616 ----------
1617
1617
1618 Specifies default handling of phases. See :hg:`help phases` for more
1618 Specifies default handling of phases. See :hg:`help phases` for more
1619 information about working with phases.
1619 information about working with phases.
1620
1620
1621 ``publish``
1621 ``publish``
1622 Controls draft phase behavior when working as a server. When true,
1622 Controls draft phase behavior when working as a server. When true,
1623 pushed changesets are set to public in both client and server and
1623 pushed changesets are set to public in both client and server and
1624 pulled or cloned changesets are set to public in the client.
1624 pulled or cloned changesets are set to public in the client.
1625 (default: True)
1625 (default: True)
1626
1626
1627 ``new-commit``
1627 ``new-commit``
1628 Phase of newly-created commits.
1628 Phase of newly-created commits.
1629 (default: draft)
1629 (default: draft)
1630
1630
1631 ``checksubrepos``
1631 ``checksubrepos``
1632 Check the phase of the current revision of each subrepository. Allowed
1632 Check the phase of the current revision of each subrepository. Allowed
1633 values are "ignore", "follow" and "abort". For settings other than
1633 values are "ignore", "follow" and "abort". For settings other than
1634 "ignore", the phase of the current revision of each subrepository is
1634 "ignore", the phase of the current revision of each subrepository is
1635 checked before committing the parent repository. If any of those phases is
1635 checked before committing the parent repository. If any of those phases is
1636 greater than the phase of the parent repository (e.g. if a subrepo is in a
1636 greater than the phase of the parent repository (e.g. if a subrepo is in a
1637 "secret" phase while the parent repo is in "draft" phase), the commit is
1637 "secret" phase while the parent repo is in "draft" phase), the commit is
1638 either aborted (if checksubrepos is set to "abort") or the higher phase is
1638 either aborted (if checksubrepos is set to "abort") or the higher phase is
1639 used for the parent repository commit (if set to "follow").
1639 used for the parent repository commit (if set to "follow").
1640 (default: follow)
1640 (default: follow)
1641
1641
1642
1642
1643 ``profiling``
1643 ``profiling``
1644 -------------
1644 -------------
1645
1645
1646 Specifies profiling type, format, and file output. Two profilers are
1646 Specifies profiling type, format, and file output. Two profilers are
1647 supported: an instrumenting profiler (named ``ls``), and a sampling
1647 supported: an instrumenting profiler (named ``ls``), and a sampling
1648 profiler (named ``stat``).
1648 profiler (named ``stat``).
1649
1649
1650 In this section description, 'profiling data' stands for the raw data
1650 In this section description, 'profiling data' stands for the raw data
1651 collected during profiling, while 'profiling report' stands for a
1651 collected during profiling, while 'profiling report' stands for a
1652 statistical text report generated from the profiling data.
1652 statistical text report generated from the profiling data.
1653
1653
1654 ``enabled``
1654 ``enabled``
1655 Enable the profiler.
1655 Enable the profiler.
1656 (default: false)
1656 (default: false)
1657
1657
1658 This is equivalent to passing ``--profile`` on the command line.
1658 This is equivalent to passing ``--profile`` on the command line.
1659
1659
1660 ``type``
1660 ``type``
1661 The type of profiler to use.
1661 The type of profiler to use.
1662 (default: stat)
1662 (default: stat)
1663
1663
1664 ``ls``
1664 ``ls``
1665 Use Python's built-in instrumenting profiler. This profiler
1665 Use Python's built-in instrumenting profiler. This profiler
1666 works on all platforms, but each line number it reports is the
1666 works on all platforms, but each line number it reports is the
1667 first line of a function. This restriction makes it difficult to
1667 first line of a function. This restriction makes it difficult to
1668 identify the expensive parts of a non-trivial function.
1668 identify the expensive parts of a non-trivial function.
1669 ``stat``
1669 ``stat``
1670 Use a statistical profiler, statprof. This profiler is most
1670 Use a statistical profiler, statprof. This profiler is most
1671 useful for profiling commands that run for longer than about 0.1
1671 useful for profiling commands that run for longer than about 0.1
1672 seconds.
1672 seconds.
1673
1673
1674 ``format``
1674 ``format``
1675 Profiling format. Specific to the ``ls`` instrumenting profiler.
1675 Profiling format. Specific to the ``ls`` instrumenting profiler.
1676 (default: text)
1676 (default: text)
1677
1677
1678 ``text``
1678 ``text``
1679 Generate a profiling report. When saving to a file, it should be
1679 Generate a profiling report. When saving to a file, it should be
1680 noted that only the report is saved, and the profiling data is
1680 noted that only the report is saved, and the profiling data is
1681 not kept.
1681 not kept.
1682 ``kcachegrind``
1682 ``kcachegrind``
1683 Format profiling data for kcachegrind use: when saving to a
1683 Format profiling data for kcachegrind use: when saving to a
1684 file, the generated file can directly be loaded into
1684 file, the generated file can directly be loaded into
1685 kcachegrind.
1685 kcachegrind.
1686
1686
1687 ``statformat``
1687 ``statformat``
1688 Profiling format for the ``stat`` profiler.
1688 Profiling format for the ``stat`` profiler.
1689 (default: hotpath)
1689 (default: hotpath)
1690
1690
1691 ``hotpath``
1691 ``hotpath``
1692 Show a tree-based display containing the hot path of execution (where
1692 Show a tree-based display containing the hot path of execution (where
1693 most time was spent).
1693 most time was spent).
1694 ``bymethod``
1694 ``bymethod``
1695 Show a table of methods ordered by how frequently they are active.
1695 Show a table of methods ordered by how frequently they are active.
1696 ``byline``
1696 ``byline``
1697 Show a table of lines in files ordered by how frequently they are active.
1697 Show a table of lines in files ordered by how frequently they are active.
1698 ``json``
1698 ``json``
1699 Render profiling data as JSON.
1699 Render profiling data as JSON.
1700
1700
1701 ``frequency``
1701 ``frequency``
1702 Sampling frequency. Specific to the ``stat`` sampling profiler.
1702 Sampling frequency. Specific to the ``stat`` sampling profiler.
1703 (default: 1000)
1703 (default: 1000)
1704
1704
1705 ``output``
1705 ``output``
1706 File path where profiling data or report should be saved. If the
1706 File path where profiling data or report should be saved. If the
1707 file exists, it is replaced. (default: None, data is printed on
1707 file exists, it is replaced. (default: None, data is printed on
1708 stderr)
1708 stderr)
1709
1709
1710 ``sort``
1710 ``sort``
1711 Sort field. Specific to the ``ls`` instrumenting profiler.
1711 Sort field. Specific to the ``ls`` instrumenting profiler.
1712 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1712 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1713 ``inlinetime``.
1713 ``inlinetime``.
1714 (default: inlinetime)
1714 (default: inlinetime)
1715
1715
1716 ``time-track``
1716 ``time-track``
1717 Control if the stat profiler track ``cpu`` or ``real`` time.
1717 Control if the stat profiler track ``cpu`` or ``real`` time.
1718 (default: ``cpu`` on Windows, otherwise ``real``)
1718 (default: ``cpu`` on Windows, otherwise ``real``)
1719
1719
1720 ``limit``
1720 ``limit``
1721 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1721 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1722 (default: 30)
1722 (default: 30)
1723
1723
1724 ``nested``
1724 ``nested``
1725 Show at most this number of lines of drill-down info after each main entry.
1725 Show at most this number of lines of drill-down info after each main entry.
1726 This can help explain the difference between Total and Inline.
1726 This can help explain the difference between Total and Inline.
1727 Specific to the ``ls`` instrumenting profiler.
1727 Specific to the ``ls`` instrumenting profiler.
1728 (default: 0)
1728 (default: 0)
1729
1729
1730 ``showmin``
1730 ``showmin``
1731 Minimum fraction of samples an entry must have for it to be displayed.
1731 Minimum fraction of samples an entry must have for it to be displayed.
1732 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1732 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1733 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1733 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1734
1734
1735 Only used by the ``stat`` profiler.
1735 Only used by the ``stat`` profiler.
1736
1736
1737 For the ``hotpath`` format, default is ``0.05``.
1737 For the ``hotpath`` format, default is ``0.05``.
1738 For the ``chrome`` format, default is ``0.005``.
1738 For the ``chrome`` format, default is ``0.005``.
1739
1739
1740 The option is unused on other formats.
1740 The option is unused on other formats.
1741
1741
1742 ``showmax``
1742 ``showmax``
1743 Maximum fraction of samples an entry can have before it is ignored in
1743 Maximum fraction of samples an entry can have before it is ignored in
1744 display. Values format is the same as ``showmin``.
1744 display. Values format is the same as ``showmin``.
1745
1745
1746 Only used by the ``stat`` profiler.
1746 Only used by the ``stat`` profiler.
1747
1747
1748 For the ``chrome`` format, default is ``0.999``.
1748 For the ``chrome`` format, default is ``0.999``.
1749
1749
1750 The option is unused on other formats.
1750 The option is unused on other formats.
1751
1751
1752 ``progress``
1752 ``progress``
1753 ------------
1753 ------------
1754
1754
1755 Mercurial commands can draw progress bars that are as informative as
1755 Mercurial commands can draw progress bars that are as informative as
1756 possible. Some progress bars only offer indeterminate information, while others
1756 possible. Some progress bars only offer indeterminate information, while others
1757 have a definite end point.
1757 have a definite end point.
1758
1758
1759 ``delay``
1759 ``delay``
1760 Number of seconds (float) before showing the progress bar. (default: 3)
1760 Number of seconds (float) before showing the progress bar. (default: 3)
1761
1761
1762 ``changedelay``
1762 ``changedelay``
1763 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1763 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1764 that value will be used instead. (default: 1)
1764 that value will be used instead. (default: 1)
1765
1765
1766 ``estimateinterval``
1766 ``estimateinterval``
1767 Maximum sampling interval in seconds for speed and estimated time
1767 Maximum sampling interval in seconds for speed and estimated time
1768 calculation. (default: 60)
1768 calculation. (default: 60)
1769
1769
1770 ``refresh``
1770 ``refresh``
1771 Time in seconds between refreshes of the progress bar. (default: 0.1)
1771 Time in seconds between refreshes of the progress bar. (default: 0.1)
1772
1772
1773 ``format``
1773 ``format``
1774 Format of the progress bar.
1774 Format of the progress bar.
1775
1775
1776 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1776 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1777 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1777 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1778 last 20 characters of the item, but this can be changed by adding either
1778 last 20 characters of the item, but this can be changed by adding either
1779 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1779 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1780 first num characters.
1780 first num characters.
1781
1781
1782 (default: topic bar number estimate)
1782 (default: topic bar number estimate)
1783
1783
1784 ``width``
1784 ``width``
1785 If set, the maximum width of the progress information (that is, min(width,
1785 If set, the maximum width of the progress information (that is, min(width,
1786 term width) will be used).
1786 term width) will be used).
1787
1787
1788 ``clear-complete``
1788 ``clear-complete``
1789 Clear the progress bar after it's done. (default: True)
1789 Clear the progress bar after it's done. (default: True)
1790
1790
1791 ``disable``
1791 ``disable``
1792 If true, don't show a progress bar.
1792 If true, don't show a progress bar.
1793
1793
1794 ``assume-tty``
1794 ``assume-tty``
1795 If true, ALWAYS show a progress bar, unless disable is given.
1795 If true, ALWAYS show a progress bar, unless disable is given.
1796
1796
1797 ``rebase``
1797 ``rebase``
1798 ----------
1798 ----------
1799
1799
1800 ``evolution.allowdivergence``
1800 ``evolution.allowdivergence``
1801 Default to False, when True allow creating divergence when performing
1801 Default to False, when True allow creating divergence when performing
1802 rebase of obsolete changesets.
1802 rebase of obsolete changesets.
1803
1803
1804 ``revsetalias``
1804 ``revsetalias``
1805 ---------------
1805 ---------------
1806
1806
1807 Alias definitions for revsets. See :hg:`help revsets` for details.
1807 Alias definitions for revsets. See :hg:`help revsets` for details.
1808
1808
1809 ``storage``
1809 ``storage``
1810 -----------
1810 -----------
1811
1811
1812 Control the strategy Mercurial uses internally to store history. Options in this
1812 Control the strategy Mercurial uses internally to store history. Options in this
1813 category impact performance and repository size.
1813 category impact performance and repository size.
1814
1814
1815 ``revlog.optimize-delta-parent-choice``
1815 ``revlog.optimize-delta-parent-choice``
1816 When storing a merge revision, both parents will be equally considered as
1816 When storing a merge revision, both parents will be equally considered as
1817 a possible delta base. This results in better delta selection and improved
1817 a possible delta base. This results in better delta selection and improved
1818 revlog compression. This option is enabled by default.
1818 revlog compression. This option is enabled by default.
1819
1819
1820 Turning this option off can result in large increase of repository size for
1820 Turning this option off can result in large increase of repository size for
1821 repository with many merges.
1821 repository with many merges.
1822
1822
1823 ``server``
1823 ``server``
1824 ----------
1824 ----------
1825
1825
1826 Controls generic server settings.
1826 Controls generic server settings.
1827
1827
1828 ``bookmarks-pushkey-compat``
1828 ``bookmarks-pushkey-compat``
1829 Trigger pushkey hook when being pushed bookmark updates. This config exist
1829 Trigger pushkey hook when being pushed bookmark updates. This config exist
1830 for compatibility purpose (default to True)
1830 for compatibility purpose (default to True)
1831
1831
1832 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
1832 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
1833 movement we recommend you migrate them to ``txnclose-bookmark`` and
1833 movement we recommend you migrate them to ``txnclose-bookmark`` and
1834 ``pretxnclose-bookmark``.
1834 ``pretxnclose-bookmark``.
1835
1835
1836 ``compressionengines``
1836 ``compressionengines``
1837 List of compression engines and their relative priority to advertise
1837 List of compression engines and their relative priority to advertise
1838 to clients.
1838 to clients.
1839
1839
1840 The order of compression engines determines their priority, the first
1840 The order of compression engines determines their priority, the first
1841 having the highest priority. If a compression engine is not listed
1841 having the highest priority. If a compression engine is not listed
1842 here, it won't be advertised to clients.
1842 here, it won't be advertised to clients.
1843
1843
1844 If not set (the default), built-in defaults are used. Run
1844 If not set (the default), built-in defaults are used. Run
1845 :hg:`debuginstall` to list available compression engines and their
1845 :hg:`debuginstall` to list available compression engines and their
1846 default wire protocol priority.
1846 default wire protocol priority.
1847
1847
1848 Older Mercurial clients only support zlib compression and this setting
1848 Older Mercurial clients only support zlib compression and this setting
1849 has no effect for legacy clients.
1849 has no effect for legacy clients.
1850
1850
1851 ``uncompressed``
1851 ``uncompressed``
1852 Whether to allow clients to clone a repository using the
1852 Whether to allow clients to clone a repository using the
1853 uncompressed streaming protocol. This transfers about 40% more
1853 uncompressed streaming protocol. This transfers about 40% more
1854 data than a regular clone, but uses less memory and CPU on both
1854 data than a regular clone, but uses less memory and CPU on both
1855 server and client. Over a LAN (100 Mbps or better) or a very fast
1855 server and client. Over a LAN (100 Mbps or better) or a very fast
1856 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1856 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1857 regular clone. Over most WAN connections (anything slower than
1857 regular clone. Over most WAN connections (anything slower than
1858 about 6 Mbps), uncompressed streaming is slower, because of the
1858 about 6 Mbps), uncompressed streaming is slower, because of the
1859 extra data transfer overhead. This mode will also temporarily hold
1859 extra data transfer overhead. This mode will also temporarily hold
1860 the write lock while determining what data to transfer.
1860 the write lock while determining what data to transfer.
1861 (default: True)
1861 (default: True)
1862
1862
1863 ``uncompressedallowsecret``
1863 ``uncompressedallowsecret``
1864 Whether to allow stream clones when the repository contains secret
1864 Whether to allow stream clones when the repository contains secret
1865 changesets. (default: False)
1865 changesets. (default: False)
1866
1866
1867 ``preferuncompressed``
1867 ``preferuncompressed``
1868 When set, clients will try to use the uncompressed streaming
1868 When set, clients will try to use the uncompressed streaming
1869 protocol. (default: False)
1869 protocol. (default: False)
1870
1870
1871 ``disablefullbundle``
1871 ``disablefullbundle``
1872 When set, servers will refuse attempts to do pull-based clones.
1872 When set, servers will refuse attempts to do pull-based clones.
1873 If this option is set, ``preferuncompressed`` and/or clone bundles
1873 If this option is set, ``preferuncompressed`` and/or clone bundles
1874 are highly recommended. Partial clones will still be allowed.
1874 are highly recommended. Partial clones will still be allowed.
1875 (default: False)
1875 (default: False)
1876
1876
1877 ``streamunbundle``
1877 ``streamunbundle``
1878 When set, servers will apply data sent from the client directly,
1878 When set, servers will apply data sent from the client directly,
1879 otherwise it will be written to a temporary file first. This option
1879 otherwise it will be written to a temporary file first. This option
1880 effectively prevents concurrent pushes.
1880 effectively prevents concurrent pushes.
1881
1881
1882 ``pullbundle``
1882 ``pullbundle``
1883 When set, the server will check pullbundle.manifest for bundles
1883 When set, the server will check pullbundle.manifest for bundles
1884 covering the requested heads and common nodes. The first matching
1884 covering the requested heads and common nodes. The first matching
1885 entry will be streamed to the client.
1885 entry will be streamed to the client.
1886
1886
1887 For HTTP transport, the stream will still use zlib compression
1887 For HTTP transport, the stream will still use zlib compression
1888 for older clients.
1888 for older clients.
1889
1889
1890 ``concurrent-push-mode``
1890 ``concurrent-push-mode``
1891 Level of allowed race condition between two pushing clients.
1891 Level of allowed race condition between two pushing clients.
1892
1892
1893 - 'strict': push is abort if another client touched the repository
1893 - 'strict': push is abort if another client touched the repository
1894 while the push was preparing. (default)
1894 while the push was preparing. (default)
1895 - 'check-related': push is only aborted if it affects head that got also
1895 - 'check-related': push is only aborted if it affects head that got also
1896 affected while the push was preparing.
1896 affected while the push was preparing.
1897
1897
1898 This requires compatible client (version 4.3 and later). Old client will
1898 This requires compatible client (version 4.3 and later). Old client will
1899 use 'strict'.
1899 use 'strict'.
1900
1900
1901 ``validate``
1901 ``validate``
1902 Whether to validate the completeness of pushed changesets by
1902 Whether to validate the completeness of pushed changesets by
1903 checking that all new file revisions specified in manifests are
1903 checking that all new file revisions specified in manifests are
1904 present. (default: False)
1904 present. (default: False)
1905
1905
1906 ``maxhttpheaderlen``
1906 ``maxhttpheaderlen``
1907 Instruct HTTP clients not to send request headers longer than this
1907 Instruct HTTP clients not to send request headers longer than this
1908 many bytes. (default: 1024)
1908 many bytes. (default: 1024)
1909
1909
1910 ``bundle1``
1910 ``bundle1``
1911 Whether to allow clients to push and pull using the legacy bundle1
1911 Whether to allow clients to push and pull using the legacy bundle1
1912 exchange format. (default: True)
1912 exchange format. (default: True)
1913
1913
1914 ``bundle1gd``
1914 ``bundle1gd``
1915 Like ``bundle1`` but only used if the repository is using the
1915 Like ``bundle1`` but only used if the repository is using the
1916 *generaldelta* storage format. (default: True)
1916 *generaldelta* storage format. (default: True)
1917
1917
1918 ``bundle1.push``
1918 ``bundle1.push``
1919 Whether to allow clients to push using the legacy bundle1 exchange
1919 Whether to allow clients to push using the legacy bundle1 exchange
1920 format. (default: True)
1920 format. (default: True)
1921
1921
1922 ``bundle1gd.push``
1922 ``bundle1gd.push``
1923 Like ``bundle1.push`` but only used if the repository is using the
1923 Like ``bundle1.push`` but only used if the repository is using the
1924 *generaldelta* storage format. (default: True)
1924 *generaldelta* storage format. (default: True)
1925
1925
1926 ``bundle1.pull``
1926 ``bundle1.pull``
1927 Whether to allow clients to pull using the legacy bundle1 exchange
1927 Whether to allow clients to pull using the legacy bundle1 exchange
1928 format. (default: True)
1928 format. (default: True)
1929
1929
1930 ``bundle1gd.pull``
1930 ``bundle1gd.pull``
1931 Like ``bundle1.pull`` but only used if the repository is using the
1931 Like ``bundle1.pull`` but only used if the repository is using the
1932 *generaldelta* storage format. (default: True)
1932 *generaldelta* storage format. (default: True)
1933
1933
1934 Large repositories using the *generaldelta* storage format should
1934 Large repositories using the *generaldelta* storage format should
1935 consider setting this option because converting *generaldelta*
1935 consider setting this option because converting *generaldelta*
1936 repositories to the exchange format required by the bundle1 data
1936 repositories to the exchange format required by the bundle1 data
1937 format can consume a lot of CPU.
1937 format can consume a lot of CPU.
1938
1938
1939 ``bundle2.stream``
1939 ``bundle2.stream``
1940 Whether to allow clients to pull using the bundle2 streaming protocol.
1940 Whether to allow clients to pull using the bundle2 streaming protocol.
1941 (default: True)
1941 (default: True)
1942
1942
1943 ``zliblevel``
1943 ``zliblevel``
1944 Integer between ``-1`` and ``9`` that controls the zlib compression level
1944 Integer between ``-1`` and ``9`` that controls the zlib compression level
1945 for wire protocol commands that send zlib compressed output (notably the
1945 for wire protocol commands that send zlib compressed output (notably the
1946 commands that send repository history data).
1946 commands that send repository history data).
1947
1947
1948 The default (``-1``) uses the default zlib compression level, which is
1948 The default (``-1``) uses the default zlib compression level, which is
1949 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1949 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1950 maximum compression.
1950 maximum compression.
1951
1951
1952 Setting this option allows server operators to make trade-offs between
1952 Setting this option allows server operators to make trade-offs between
1953 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1953 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1954 but sends more bytes to clients.
1954 but sends more bytes to clients.
1955
1955
1956 This option only impacts the HTTP server.
1956 This option only impacts the HTTP server.
1957
1957
1958 ``zstdlevel``
1958 ``zstdlevel``
1959 Integer between ``1`` and ``22`` that controls the zstd compression level
1959 Integer between ``1`` and ``22`` that controls the zstd compression level
1960 for wire protocol commands. ``1`` is the minimal amount of compression and
1960 for wire protocol commands. ``1`` is the minimal amount of compression and
1961 ``22`` is the highest amount of compression.
1961 ``22`` is the highest amount of compression.
1962
1962
1963 The default (``3``) should be significantly faster than zlib while likely
1963 The default (``3``) should be significantly faster than zlib while likely
1964 delivering better compression ratios.
1964 delivering better compression ratios.
1965
1965
1966 This option only impacts the HTTP server.
1966 This option only impacts the HTTP server.
1967
1967
1968 See also ``server.zliblevel``.
1968 See also ``server.zliblevel``.
1969
1969
1970 ``smtp``
1970 ``smtp``
1971 --------
1971 --------
1972
1972
1973 Configuration for extensions that need to send email messages.
1973 Configuration for extensions that need to send email messages.
1974
1974
1975 ``host``
1975 ``host``
1976 Host name of mail server, e.g. "mail.example.com".
1976 Host name of mail server, e.g. "mail.example.com".
1977
1977
1978 ``port``
1978 ``port``
1979 Optional. Port to connect to on mail server. (default: 465 if
1979 Optional. Port to connect to on mail server. (default: 465 if
1980 ``tls`` is smtps; 25 otherwise)
1980 ``tls`` is smtps; 25 otherwise)
1981
1981
1982 ``tls``
1982 ``tls``
1983 Optional. Method to enable TLS when connecting to mail server: starttls,
1983 Optional. Method to enable TLS when connecting to mail server: starttls,
1984 smtps or none. (default: none)
1984 smtps or none. (default: none)
1985
1985
1986 ``username``
1986 ``username``
1987 Optional. User name for authenticating with the SMTP server.
1987 Optional. User name for authenticating with the SMTP server.
1988 (default: None)
1988 (default: None)
1989
1989
1990 ``password``
1990 ``password``
1991 Optional. Password for authenticating with the SMTP server. If not
1991 Optional. Password for authenticating with the SMTP server. If not
1992 specified, interactive sessions will prompt the user for a
1992 specified, interactive sessions will prompt the user for a
1993 password; non-interactive sessions will fail. (default: None)
1993 password; non-interactive sessions will fail. (default: None)
1994
1994
1995 ``local_hostname``
1995 ``local_hostname``
1996 Optional. The hostname that the sender can use to identify
1996 Optional. The hostname that the sender can use to identify
1997 itself to the MTA.
1997 itself to the MTA.
1998
1998
1999
1999
2000 ``subpaths``
2000 ``subpaths``
2001 ------------
2001 ------------
2002
2002
2003 Subrepository source URLs can go stale if a remote server changes name
2003 Subrepository source URLs can go stale if a remote server changes name
2004 or becomes temporarily unavailable. This section lets you define
2004 or becomes temporarily unavailable. This section lets you define
2005 rewrite rules of the form::
2005 rewrite rules of the form::
2006
2006
2007 <pattern> = <replacement>
2007 <pattern> = <replacement>
2008
2008
2009 where ``pattern`` is a regular expression matching a subrepository
2009 where ``pattern`` is a regular expression matching a subrepository
2010 source URL and ``replacement`` is the replacement string used to
2010 source URL and ``replacement`` is the replacement string used to
2011 rewrite it. Groups can be matched in ``pattern`` and referenced in
2011 rewrite it. Groups can be matched in ``pattern`` and referenced in
2012 ``replacements``. For instance::
2012 ``replacements``. For instance::
2013
2013
2014 http://server/(.*)-hg/ = http://hg.server/\1/
2014 http://server/(.*)-hg/ = http://hg.server/\1/
2015
2015
2016 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2016 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2017
2017
2018 Relative subrepository paths are first made absolute, and the
2018 Relative subrepository paths are first made absolute, and the
2019 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2019 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2020 doesn't match the full path, an attempt is made to apply it on the
2020 doesn't match the full path, an attempt is made to apply it on the
2021 relative path alone. The rules are applied in definition order.
2021 relative path alone. The rules are applied in definition order.
2022
2022
2023 ``subrepos``
2023 ``subrepos``
2024 ------------
2024 ------------
2025
2025
2026 This section contains options that control the behavior of the
2026 This section contains options that control the behavior of the
2027 subrepositories feature. See also :hg:`help subrepos`.
2027 subrepositories feature. See also :hg:`help subrepos`.
2028
2028
2029 Security note: auditing in Mercurial is known to be insufficient to
2029 Security note: auditing in Mercurial is known to be insufficient to
2030 prevent clone-time code execution with carefully constructed Git
2030 prevent clone-time code execution with carefully constructed Git
2031 subrepos. It is unknown if a similar detect is present in Subversion
2031 subrepos. It is unknown if a similar detect is present in Subversion
2032 subrepos. Both Git and Subversion subrepos are disabled by default
2032 subrepos. Both Git and Subversion subrepos are disabled by default
2033 out of security concerns. These subrepo types can be enabled using
2033 out of security concerns. These subrepo types can be enabled using
2034 the respective options below.
2034 the respective options below.
2035
2035
2036 ``allowed``
2036 ``allowed``
2037 Whether subrepositories are allowed in the working directory.
2037 Whether subrepositories are allowed in the working directory.
2038
2038
2039 When false, commands involving subrepositories (like :hg:`update`)
2039 When false, commands involving subrepositories (like :hg:`update`)
2040 will fail for all subrepository types.
2040 will fail for all subrepository types.
2041 (default: true)
2041 (default: true)
2042
2042
2043 ``hg:allowed``
2043 ``hg:allowed``
2044 Whether Mercurial subrepositories are allowed in the working
2044 Whether Mercurial subrepositories are allowed in the working
2045 directory. This option only has an effect if ``subrepos.allowed``
2045 directory. This option only has an effect if ``subrepos.allowed``
2046 is true.
2046 is true.
2047 (default: true)
2047 (default: true)
2048
2048
2049 ``git:allowed``
2049 ``git:allowed``
2050 Whether Git subrepositories are allowed in the working directory.
2050 Whether Git subrepositories are allowed in the working directory.
2051 This option only has an effect if ``subrepos.allowed`` is true.
2051 This option only has an effect if ``subrepos.allowed`` is true.
2052
2052
2053 See the security note above before enabling Git subrepos.
2053 See the security note above before enabling Git subrepos.
2054 (default: false)
2054 (default: false)
2055
2055
2056 ``svn:allowed``
2056 ``svn:allowed``
2057 Whether Subversion subrepositories are allowed in the working
2057 Whether Subversion subrepositories are allowed in the working
2058 directory. This option only has an effect if ``subrepos.allowed``
2058 directory. This option only has an effect if ``subrepos.allowed``
2059 is true.
2059 is true.
2060
2060
2061 See the security note above before enabling Subversion subrepos.
2061 See the security note above before enabling Subversion subrepos.
2062 (default: false)
2062 (default: false)
2063
2063
2064 ``templatealias``
2064 ``templatealias``
2065 -----------------
2065 -----------------
2066
2066
2067 Alias definitions for templates. See :hg:`help templates` for details.
2067 Alias definitions for templates. See :hg:`help templates` for details.
2068
2068
2069 ``templates``
2069 ``templates``
2070 -------------
2070 -------------
2071
2071
2072 Use the ``[templates]`` section to define template strings.
2072 Use the ``[templates]`` section to define template strings.
2073 See :hg:`help templates` for details.
2073 See :hg:`help templates` for details.
2074
2074
2075 ``trusted``
2075 ``trusted``
2076 -----------
2076 -----------
2077
2077
2078 Mercurial will not use the settings in the
2078 Mercurial will not use the settings in the
2079 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2079 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2080 user or to a trusted group, as various hgrc features allow arbitrary
2080 user or to a trusted group, as various hgrc features allow arbitrary
2081 commands to be run. This issue is often encountered when configuring
2081 commands to be run. This issue is often encountered when configuring
2082 hooks or extensions for shared repositories or servers. However,
2082 hooks or extensions for shared repositories or servers. However,
2083 the web interface will use some safe settings from the ``[web]``
2083 the web interface will use some safe settings from the ``[web]``
2084 section.
2084 section.
2085
2085
2086 This section specifies what users and groups are trusted. The
2086 This section specifies what users and groups are trusted. The
2087 current user is always trusted. To trust everybody, list a user or a
2087 current user is always trusted. To trust everybody, list a user or a
2088 group with name ``*``. These settings must be placed in an
2088 group with name ``*``. These settings must be placed in an
2089 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2089 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2090 user or service running Mercurial.
2090 user or service running Mercurial.
2091
2091
2092 ``users``
2092 ``users``
2093 Comma-separated list of trusted users.
2093 Comma-separated list of trusted users.
2094
2094
2095 ``groups``
2095 ``groups``
2096 Comma-separated list of trusted groups.
2096 Comma-separated list of trusted groups.
2097
2097
2098
2098
2099 ``ui``
2099 ``ui``
2100 ------
2100 ------
2101
2101
2102 User interface controls.
2102 User interface controls.
2103
2103
2104 ``archivemeta``
2104 ``archivemeta``
2105 Whether to include the .hg_archival.txt file containing meta data
2105 Whether to include the .hg_archival.txt file containing meta data
2106 (hashes for the repository base and for tip) in archives created
2106 (hashes for the repository base and for tip) in archives created
2107 by the :hg:`archive` command or downloaded via hgweb.
2107 by the :hg:`archive` command or downloaded via hgweb.
2108 (default: True)
2108 (default: True)
2109
2109
2110 ``askusername``
2110 ``askusername``
2111 Whether to prompt for a username when committing. If True, and
2111 Whether to prompt for a username when committing. If True, and
2112 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2112 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2113 be prompted to enter a username. If no username is entered, the
2113 be prompted to enter a username. If no username is entered, the
2114 default ``USER@HOST`` is used instead.
2114 default ``USER@HOST`` is used instead.
2115 (default: False)
2115 (default: False)
2116
2116
2117 ``clonebundles``
2117 ``clonebundles``
2118 Whether the "clone bundles" feature is enabled.
2118 Whether the "clone bundles" feature is enabled.
2119
2119
2120 When enabled, :hg:`clone` may download and apply a server-advertised
2120 When enabled, :hg:`clone` may download and apply a server-advertised
2121 bundle file from a URL instead of using the normal exchange mechanism.
2121 bundle file from a URL instead of using the normal exchange mechanism.
2122
2122
2123 This can likely result in faster and more reliable clones.
2123 This can likely result in faster and more reliable clones.
2124
2124
2125 (default: True)
2125 (default: True)
2126
2126
2127 ``clonebundlefallback``
2127 ``clonebundlefallback``
2128 Whether failure to apply an advertised "clone bundle" from a server
2128 Whether failure to apply an advertised "clone bundle" from a server
2129 should result in fallback to a regular clone.
2129 should result in fallback to a regular clone.
2130
2130
2131 This is disabled by default because servers advertising "clone
2131 This is disabled by default because servers advertising "clone
2132 bundles" often do so to reduce server load. If advertised bundles
2132 bundles" often do so to reduce server load. If advertised bundles
2133 start mass failing and clients automatically fall back to a regular
2133 start mass failing and clients automatically fall back to a regular
2134 clone, this would add significant and unexpected load to the server
2134 clone, this would add significant and unexpected load to the server
2135 since the server is expecting clone operations to be offloaded to
2135 since the server is expecting clone operations to be offloaded to
2136 pre-generated bundles. Failing fast (the default behavior) ensures
2136 pre-generated bundles. Failing fast (the default behavior) ensures
2137 clients don't overwhelm the server when "clone bundle" application
2137 clients don't overwhelm the server when "clone bundle" application
2138 fails.
2138 fails.
2139
2139
2140 (default: False)
2140 (default: False)
2141
2141
2142 ``clonebundleprefers``
2142 ``clonebundleprefers``
2143 Defines preferences for which "clone bundles" to use.
2143 Defines preferences for which "clone bundles" to use.
2144
2144
2145 Servers advertising "clone bundles" may advertise multiple available
2145 Servers advertising "clone bundles" may advertise multiple available
2146 bundles. Each bundle may have different attributes, such as the bundle
2146 bundles. Each bundle may have different attributes, such as the bundle
2147 type and compression format. This option is used to prefer a particular
2147 type and compression format. This option is used to prefer a particular
2148 bundle over another.
2148 bundle over another.
2149
2149
2150 The following keys are defined by Mercurial:
2150 The following keys are defined by Mercurial:
2151
2151
2152 BUNDLESPEC
2152 BUNDLESPEC
2153 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2153 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2154 e.g. ``gzip-v2`` or ``bzip2-v1``.
2154 e.g. ``gzip-v2`` or ``bzip2-v1``.
2155
2155
2156 COMPRESSION
2156 COMPRESSION
2157 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2157 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2158
2158
2159 Server operators may define custom keys.
2159 Server operators may define custom keys.
2160
2160
2161 Example values: ``COMPRESSION=bzip2``,
2161 Example values: ``COMPRESSION=bzip2``,
2162 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2162 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2163
2163
2164 By default, the first bundle advertised by the server is used.
2164 By default, the first bundle advertised by the server is used.
2165
2165
2166 ``color``
2166 ``color``
2167 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2167 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2168 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2168 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2169 seems possible. See :hg:`help color` for details.
2169 seems possible. See :hg:`help color` for details.
2170
2170
2171 ``commitsubrepos``
2171 ``commitsubrepos``
2172 Whether to commit modified subrepositories when committing the
2172 Whether to commit modified subrepositories when committing the
2173 parent repository. If False and one subrepository has uncommitted
2173 parent repository. If False and one subrepository has uncommitted
2174 changes, abort the commit.
2174 changes, abort the commit.
2175 (default: False)
2175 (default: False)
2176
2176
2177 ``debug``
2177 ``debug``
2178 Print debugging information. (default: False)
2178 Print debugging information. (default: False)
2179
2179
2180 ``editor``
2180 ``editor``
2181 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2181 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2182
2182
2183 ``fallbackencoding``
2183 ``fallbackencoding``
2184 Encoding to try if it's not possible to decode the changelog using
2184 Encoding to try if it's not possible to decode the changelog using
2185 UTF-8. (default: ISO-8859-1)
2185 UTF-8. (default: ISO-8859-1)
2186
2186
2187 ``graphnodetemplate``
2187 ``graphnodetemplate``
2188 The template used to print changeset nodes in an ASCII revision graph.
2188 The template used to print changeset nodes in an ASCII revision graph.
2189 (default: ``{graphnode}``)
2189 (default: ``{graphnode}``)
2190
2190
2191 ``ignore``
2191 ``ignore``
2192 A file to read per-user ignore patterns from. This file should be
2192 A file to read per-user ignore patterns from. This file should be
2193 in the same format as a repository-wide .hgignore file. Filenames
2193 in the same format as a repository-wide .hgignore file. Filenames
2194 are relative to the repository root. This option supports hook syntax,
2194 are relative to the repository root. This option supports hook syntax,
2195 so if you want to specify multiple ignore files, you can do so by
2195 so if you want to specify multiple ignore files, you can do so by
2196 setting something like ``ignore.other = ~/.hgignore2``. For details
2196 setting something like ``ignore.other = ~/.hgignore2``. For details
2197 of the ignore file format, see the ``hgignore(5)`` man page.
2197 of the ignore file format, see the ``hgignore(5)`` man page.
2198
2198
2199 ``interactive``
2199 ``interactive``
2200 Allow to prompt the user. (default: True)
2200 Allow to prompt the user. (default: True)
2201
2201
2202 ``interface``
2202 ``interface``
2203 Select the default interface for interactive features (default: text).
2203 Select the default interface for interactive features (default: text).
2204 Possible values are 'text' and 'curses'.
2204 Possible values are 'text' and 'curses'.
2205
2205
2206 ``interface.chunkselector``
2206 ``interface.chunkselector``
2207 Select the interface for change recording (e.g. :hg:`commit -i`).
2207 Select the interface for change recording (e.g. :hg:`commit -i`).
2208 Possible values are 'text' and 'curses'.
2208 Possible values are 'text' and 'curses'.
2209 This config overrides the interface specified by ui.interface.
2209 This config overrides the interface specified by ui.interface.
2210
2210
2211 ``large-file-limit``
2211 ``large-file-limit``
2212 Largest file size that gives no memory use warning.
2212 Largest file size that gives no memory use warning.
2213 Possible values are integers or 0 to disable the check.
2213 Possible values are integers or 0 to disable the check.
2214 (default: 10000000)
2214 (default: 10000000)
2215
2215
2216 ``logtemplate``
2216 ``logtemplate``
2217 Template string for commands that print changesets.
2217 Template string for commands that print changesets.
2218
2218
2219 ``merge``
2219 ``merge``
2220 The conflict resolution program to use during a manual merge.
2220 The conflict resolution program to use during a manual merge.
2221 For more information on merge tools see :hg:`help merge-tools`.
2221 For more information on merge tools see :hg:`help merge-tools`.
2222 For configuring merge tools see the ``[merge-tools]`` section.
2222 For configuring merge tools see the ``[merge-tools]`` section.
2223
2223
2224 ``mergemarkers``
2224 ``mergemarkers``
2225 Sets the merge conflict marker label styling. The ``detailed``
2225 Sets the merge conflict marker label styling. The ``detailed``
2226 style uses the ``mergemarkertemplate`` setting to style the labels.
2226 style uses the ``mergemarkertemplate`` setting to style the labels.
2227 The ``basic`` style just uses 'local' and 'other' as the marker label.
2227 The ``basic`` style just uses 'local' and 'other' as the marker label.
2228 One of ``basic`` or ``detailed``.
2228 One of ``basic`` or ``detailed``.
2229 (default: ``basic``)
2229 (default: ``basic``)
2230
2230
2231 ``mergemarkertemplate``
2231 ``mergemarkertemplate``
2232 The template used to print the commit description next to each conflict
2232 The template used to print the commit description next to each conflict
2233 marker during merge conflicts. See :hg:`help templates` for the template
2233 marker during merge conflicts. See :hg:`help templates` for the template
2234 format.
2234 format.
2235
2235
2236 Defaults to showing the hash, tags, branches, bookmarks, author, and
2236 Defaults to showing the hash, tags, branches, bookmarks, author, and
2237 the first line of the commit description.
2237 the first line of the commit description.
2238
2238
2239 If you use non-ASCII characters in names for tags, branches, bookmarks,
2239 If you use non-ASCII characters in names for tags, branches, bookmarks,
2240 authors, and/or commit descriptions, you must pay attention to encodings of
2240 authors, and/or commit descriptions, you must pay attention to encodings of
2241 managed files. At template expansion, non-ASCII characters use the encoding
2241 managed files. At template expansion, non-ASCII characters use the encoding
2242 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2242 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2243 environment variables that govern your locale. If the encoding of the merge
2243 environment variables that govern your locale. If the encoding of the merge
2244 markers is different from the encoding of the merged files,
2244 markers is different from the encoding of the merged files,
2245 serious problems may occur.
2245 serious problems may occur.
2246
2246
2247 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2247 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2248
2248
2249 ``message-output``
2250 Where to write status and error messages. (default: ``stdio``)
2251
2252 ``stderr``
2253 Everything to stderr.
2254 ``stdio``
2255 Status to stdout, and error to stderr.
2256
2249 ``origbackuppath``
2257 ``origbackuppath``
2250 The path to a directory used to store generated .orig files. If the path is
2258 The path to a directory used to store generated .orig files. If the path is
2251 not a directory, one will be created. If set, files stored in this
2259 not a directory, one will be created. If set, files stored in this
2252 directory have the same name as the original file and do not have a .orig
2260 directory have the same name as the original file and do not have a .orig
2253 suffix.
2261 suffix.
2254
2262
2255 ``paginate``
2263 ``paginate``
2256 Control the pagination of command output (default: True). See :hg:`help pager`
2264 Control the pagination of command output (default: True). See :hg:`help pager`
2257 for details.
2265 for details.
2258
2266
2259 ``patch``
2267 ``patch``
2260 An optional external tool that ``hg import`` and some extensions
2268 An optional external tool that ``hg import`` and some extensions
2261 will use for applying patches. By default Mercurial uses an
2269 will use for applying patches. By default Mercurial uses an
2262 internal patch utility. The external tool must work as the common
2270 internal patch utility. The external tool must work as the common
2263 Unix ``patch`` program. In particular, it must accept a ``-p``
2271 Unix ``patch`` program. In particular, it must accept a ``-p``
2264 argument to strip patch headers, a ``-d`` argument to specify the
2272 argument to strip patch headers, a ``-d`` argument to specify the
2265 current directory, a file name to patch, and a patch file to take
2273 current directory, a file name to patch, and a patch file to take
2266 from stdin.
2274 from stdin.
2267
2275
2268 It is possible to specify a patch tool together with extra
2276 It is possible to specify a patch tool together with extra
2269 arguments. For example, setting this option to ``patch --merge``
2277 arguments. For example, setting this option to ``patch --merge``
2270 will use the ``patch`` program with its 2-way merge option.
2278 will use the ``patch`` program with its 2-way merge option.
2271
2279
2272 ``portablefilenames``
2280 ``portablefilenames``
2273 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2281 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2274 (default: ``warn``)
2282 (default: ``warn``)
2275
2283
2276 ``warn``
2284 ``warn``
2277 Print a warning message on POSIX platforms, if a file with a non-portable
2285 Print a warning message on POSIX platforms, if a file with a non-portable
2278 filename is added (e.g. a file with a name that can't be created on
2286 filename is added (e.g. a file with a name that can't be created on
2279 Windows because it contains reserved parts like ``AUX``, reserved
2287 Windows because it contains reserved parts like ``AUX``, reserved
2280 characters like ``:``, or would cause a case collision with an existing
2288 characters like ``:``, or would cause a case collision with an existing
2281 file).
2289 file).
2282
2290
2283 ``ignore``
2291 ``ignore``
2284 Don't print a warning.
2292 Don't print a warning.
2285
2293
2286 ``abort``
2294 ``abort``
2287 The command is aborted.
2295 The command is aborted.
2288
2296
2289 ``true``
2297 ``true``
2290 Alias for ``warn``.
2298 Alias for ``warn``.
2291
2299
2292 ``false``
2300 ``false``
2293 Alias for ``ignore``.
2301 Alias for ``ignore``.
2294
2302
2295 .. container:: windows
2303 .. container:: windows
2296
2304
2297 On Windows, this configuration option is ignored and the command aborted.
2305 On Windows, this configuration option is ignored and the command aborted.
2298
2306
2299 ``pre-merge-tool-output-template``
2307 ``pre-merge-tool-output-template``
2300 A template that is printed before executing an external merge tool. This can
2308 A template that is printed before executing an external merge tool. This can
2301 be used to print out additional context that might be useful to have during
2309 be used to print out additional context that might be useful to have during
2302 the conflict resolution, such as the description of the various commits
2310 the conflict resolution, such as the description of the various commits
2303 involved or bookmarks/tags.
2311 involved or bookmarks/tags.
2304
2312
2305 Additional information is available in the ``local`, ``base``, and ``other``
2313 Additional information is available in the ``local`, ``base``, and ``other``
2306 dicts. For example: ``{local.label}``, ``{base.name}``, or
2314 dicts. For example: ``{local.label}``, ``{base.name}``, or
2307 ``{other.islink}``.
2315 ``{other.islink}``.
2308
2316
2309 ``quiet``
2317 ``quiet``
2310 Reduce the amount of output printed.
2318 Reduce the amount of output printed.
2311 (default: False)
2319 (default: False)
2312
2320
2313 ``remotecmd``
2321 ``remotecmd``
2314 Remote command to use for clone/push/pull operations.
2322 Remote command to use for clone/push/pull operations.
2315 (default: ``hg``)
2323 (default: ``hg``)
2316
2324
2317 ``report_untrusted``
2325 ``report_untrusted``
2318 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2326 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2319 trusted user or group.
2327 trusted user or group.
2320 (default: True)
2328 (default: True)
2321
2329
2322 ``slash``
2330 ``slash``
2323 (Deprecated. Use ``slashpath`` template filter instead.)
2331 (Deprecated. Use ``slashpath`` template filter instead.)
2324
2332
2325 Display paths using a slash (``/``) as the path separator. This
2333 Display paths using a slash (``/``) as the path separator. This
2326 only makes a difference on systems where the default path
2334 only makes a difference on systems where the default path
2327 separator is not the slash character (e.g. Windows uses the
2335 separator is not the slash character (e.g. Windows uses the
2328 backslash character (``\``)).
2336 backslash character (``\``)).
2329 (default: False)
2337 (default: False)
2330
2338
2331 ``statuscopies``
2339 ``statuscopies``
2332 Display copies in the status command.
2340 Display copies in the status command.
2333
2341
2334 ``ssh``
2342 ``ssh``
2335 Command to use for SSH connections. (default: ``ssh``)
2343 Command to use for SSH connections. (default: ``ssh``)
2336
2344
2337 ``ssherrorhint``
2345 ``ssherrorhint``
2338 A hint shown to the user in the case of SSH error (e.g.
2346 A hint shown to the user in the case of SSH error (e.g.
2339 ``Please see http://company/internalwiki/ssh.html``)
2347 ``Please see http://company/internalwiki/ssh.html``)
2340
2348
2341 ``strict``
2349 ``strict``
2342 Require exact command names, instead of allowing unambiguous
2350 Require exact command names, instead of allowing unambiguous
2343 abbreviations. (default: False)
2351 abbreviations. (default: False)
2344
2352
2345 ``style``
2353 ``style``
2346 Name of style to use for command output.
2354 Name of style to use for command output.
2347
2355
2348 ``supportcontact``
2356 ``supportcontact``
2349 A URL where users should report a Mercurial traceback. Use this if you are a
2357 A URL where users should report a Mercurial traceback. Use this if you are a
2350 large organisation with its own Mercurial deployment process and crash
2358 large organisation with its own Mercurial deployment process and crash
2351 reports should be addressed to your internal support.
2359 reports should be addressed to your internal support.
2352
2360
2353 ``textwidth``
2361 ``textwidth``
2354 Maximum width of help text. A longer line generated by ``hg help`` or
2362 Maximum width of help text. A longer line generated by ``hg help`` or
2355 ``hg subcommand --help`` will be broken after white space to get this
2363 ``hg subcommand --help`` will be broken after white space to get this
2356 width or the terminal width, whichever comes first.
2364 width or the terminal width, whichever comes first.
2357 A non-positive value will disable this and the terminal width will be
2365 A non-positive value will disable this and the terminal width will be
2358 used. (default: 78)
2366 used. (default: 78)
2359
2367
2360 ``timeout``
2368 ``timeout``
2361 The timeout used when a lock is held (in seconds), a negative value
2369 The timeout used when a lock is held (in seconds), a negative value
2362 means no timeout. (default: 600)
2370 means no timeout. (default: 600)
2363
2371
2364 ``timeout.warn``
2372 ``timeout.warn``
2365 Time (in seconds) before a warning is printed about held lock. A negative
2373 Time (in seconds) before a warning is printed about held lock. A negative
2366 value means no warning. (default: 0)
2374 value means no warning. (default: 0)
2367
2375
2368 ``traceback``
2376 ``traceback``
2369 Mercurial always prints a traceback when an unknown exception
2377 Mercurial always prints a traceback when an unknown exception
2370 occurs. Setting this to True will make Mercurial print a traceback
2378 occurs. Setting this to True will make Mercurial print a traceback
2371 on all exceptions, even those recognized by Mercurial (such as
2379 on all exceptions, even those recognized by Mercurial (such as
2372 IOError or MemoryError). (default: False)
2380 IOError or MemoryError). (default: False)
2373
2381
2374 ``tweakdefaults``
2382 ``tweakdefaults``
2375
2383
2376 By default Mercurial's behavior changes very little from release
2384 By default Mercurial's behavior changes very little from release
2377 to release, but over time the recommended config settings
2385 to release, but over time the recommended config settings
2378 shift. Enable this config to opt in to get automatic tweaks to
2386 shift. Enable this config to opt in to get automatic tweaks to
2379 Mercurial's behavior over time. This config setting will have no
2387 Mercurial's behavior over time. This config setting will have no
2380 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2388 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2381 not include ``tweakdefaults``. (default: False)
2389 not include ``tweakdefaults``. (default: False)
2382
2390
2383 It currently means::
2391 It currently means::
2384
2392
2385 .. tweakdefaultsmarker
2393 .. tweakdefaultsmarker
2386
2394
2387 ``username``
2395 ``username``
2388 The committer of a changeset created when running "commit".
2396 The committer of a changeset created when running "commit".
2389 Typically a person's name and email address, e.g. ``Fred Widget
2397 Typically a person's name and email address, e.g. ``Fred Widget
2390 <fred@example.com>``. Environment variables in the
2398 <fred@example.com>``. Environment variables in the
2391 username are expanded.
2399 username are expanded.
2392
2400
2393 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2401 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2394 hgrc is empty, e.g. if the system admin set ``username =`` in the
2402 hgrc is empty, e.g. if the system admin set ``username =`` in the
2395 system hgrc, it has to be specified manually or in a different
2403 system hgrc, it has to be specified manually or in a different
2396 hgrc file)
2404 hgrc file)
2397
2405
2398 ``verbose``
2406 ``verbose``
2399 Increase the amount of output printed. (default: False)
2407 Increase the amount of output printed. (default: False)
2400
2408
2401
2409
2402 ``web``
2410 ``web``
2403 -------
2411 -------
2404
2412
2405 Web interface configuration. The settings in this section apply to
2413 Web interface configuration. The settings in this section apply to
2406 both the builtin webserver (started by :hg:`serve`) and the script you
2414 both the builtin webserver (started by :hg:`serve`) and the script you
2407 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2415 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2408 and WSGI).
2416 and WSGI).
2409
2417
2410 The Mercurial webserver does no authentication (it does not prompt for
2418 The Mercurial webserver does no authentication (it does not prompt for
2411 usernames and passwords to validate *who* users are), but it does do
2419 usernames and passwords to validate *who* users are), but it does do
2412 authorization (it grants or denies access for *authenticated users*
2420 authorization (it grants or denies access for *authenticated users*
2413 based on settings in this section). You must either configure your
2421 based on settings in this section). You must either configure your
2414 webserver to do authentication for you, or disable the authorization
2422 webserver to do authentication for you, or disable the authorization
2415 checks.
2423 checks.
2416
2424
2417 For a quick setup in a trusted environment, e.g., a private LAN, where
2425 For a quick setup in a trusted environment, e.g., a private LAN, where
2418 you want it to accept pushes from anybody, you can use the following
2426 you want it to accept pushes from anybody, you can use the following
2419 command line::
2427 command line::
2420
2428
2421 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2429 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2422
2430
2423 Note that this will allow anybody to push anything to the server and
2431 Note that this will allow anybody to push anything to the server and
2424 that this should not be used for public servers.
2432 that this should not be used for public servers.
2425
2433
2426 The full set of options is:
2434 The full set of options is:
2427
2435
2428 ``accesslog``
2436 ``accesslog``
2429 Where to output the access log. (default: stdout)
2437 Where to output the access log. (default: stdout)
2430
2438
2431 ``address``
2439 ``address``
2432 Interface address to bind to. (default: all)
2440 Interface address to bind to. (default: all)
2433
2441
2434 ``allow-archive``
2442 ``allow-archive``
2435 List of archive format (bz2, gz, zip) allowed for downloading.
2443 List of archive format (bz2, gz, zip) allowed for downloading.
2436 (default: empty)
2444 (default: empty)
2437
2445
2438 ``allowbz2``
2446 ``allowbz2``
2439 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2447 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2440 revisions.
2448 revisions.
2441 (default: False)
2449 (default: False)
2442
2450
2443 ``allowgz``
2451 ``allowgz``
2444 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2452 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2445 revisions.
2453 revisions.
2446 (default: False)
2454 (default: False)
2447
2455
2448 ``allow-pull``
2456 ``allow-pull``
2449 Whether to allow pulling from the repository. (default: True)
2457 Whether to allow pulling from the repository. (default: True)
2450
2458
2451 ``allow-push``
2459 ``allow-push``
2452 Whether to allow pushing to the repository. If empty or not set,
2460 Whether to allow pushing to the repository. If empty or not set,
2453 pushing is not allowed. If the special value ``*``, any remote
2461 pushing is not allowed. If the special value ``*``, any remote
2454 user can push, including unauthenticated users. Otherwise, the
2462 user can push, including unauthenticated users. Otherwise, the
2455 remote user must have been authenticated, and the authenticated
2463 remote user must have been authenticated, and the authenticated
2456 user name must be present in this list. The contents of the
2464 user name must be present in this list. The contents of the
2457 allow-push list are examined after the deny_push list.
2465 allow-push list are examined after the deny_push list.
2458
2466
2459 ``allow_read``
2467 ``allow_read``
2460 If the user has not already been denied repository access due to
2468 If the user has not already been denied repository access due to
2461 the contents of deny_read, this list determines whether to grant
2469 the contents of deny_read, this list determines whether to grant
2462 repository access to the user. If this list is not empty, and the
2470 repository access to the user. If this list is not empty, and the
2463 user is unauthenticated or not present in the list, then access is
2471 user is unauthenticated or not present in the list, then access is
2464 denied for the user. If the list is empty or not set, then access
2472 denied for the user. If the list is empty or not set, then access
2465 is permitted to all users by default. Setting allow_read to the
2473 is permitted to all users by default. Setting allow_read to the
2466 special value ``*`` is equivalent to it not being set (i.e. access
2474 special value ``*`` is equivalent to it not being set (i.e. access
2467 is permitted to all users). The contents of the allow_read list are
2475 is permitted to all users). The contents of the allow_read list are
2468 examined after the deny_read list.
2476 examined after the deny_read list.
2469
2477
2470 ``allowzip``
2478 ``allowzip``
2471 (DEPRECATED) Whether to allow .zip downloading of repository
2479 (DEPRECATED) Whether to allow .zip downloading of repository
2472 revisions. This feature creates temporary files.
2480 revisions. This feature creates temporary files.
2473 (default: False)
2481 (default: False)
2474
2482
2475 ``archivesubrepos``
2483 ``archivesubrepos``
2476 Whether to recurse into subrepositories when archiving.
2484 Whether to recurse into subrepositories when archiving.
2477 (default: False)
2485 (default: False)
2478
2486
2479 ``baseurl``
2487 ``baseurl``
2480 Base URL to use when publishing URLs in other locations, so
2488 Base URL to use when publishing URLs in other locations, so
2481 third-party tools like email notification hooks can construct
2489 third-party tools like email notification hooks can construct
2482 URLs. Example: ``http://hgserver/repos/``.
2490 URLs. Example: ``http://hgserver/repos/``.
2483
2491
2484 ``cacerts``
2492 ``cacerts``
2485 Path to file containing a list of PEM encoded certificate
2493 Path to file containing a list of PEM encoded certificate
2486 authority certificates. Environment variables and ``~user``
2494 authority certificates. Environment variables and ``~user``
2487 constructs are expanded in the filename. If specified on the
2495 constructs are expanded in the filename. If specified on the
2488 client, then it will verify the identity of remote HTTPS servers
2496 client, then it will verify the identity of remote HTTPS servers
2489 with these certificates.
2497 with these certificates.
2490
2498
2491 To disable SSL verification temporarily, specify ``--insecure`` from
2499 To disable SSL verification temporarily, specify ``--insecure`` from
2492 command line.
2500 command line.
2493
2501
2494 You can use OpenSSL's CA certificate file if your platform has
2502 You can use OpenSSL's CA certificate file if your platform has
2495 one. On most Linux systems this will be
2503 one. On most Linux systems this will be
2496 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2504 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2497 generate this file manually. The form must be as follows::
2505 generate this file manually. The form must be as follows::
2498
2506
2499 -----BEGIN CERTIFICATE-----
2507 -----BEGIN CERTIFICATE-----
2500 ... (certificate in base64 PEM encoding) ...
2508 ... (certificate in base64 PEM encoding) ...
2501 -----END CERTIFICATE-----
2509 -----END CERTIFICATE-----
2502 -----BEGIN CERTIFICATE-----
2510 -----BEGIN CERTIFICATE-----
2503 ... (certificate in base64 PEM encoding) ...
2511 ... (certificate in base64 PEM encoding) ...
2504 -----END CERTIFICATE-----
2512 -----END CERTIFICATE-----
2505
2513
2506 ``cache``
2514 ``cache``
2507 Whether to support caching in hgweb. (default: True)
2515 Whether to support caching in hgweb. (default: True)
2508
2516
2509 ``certificate``
2517 ``certificate``
2510 Certificate to use when running :hg:`serve`.
2518 Certificate to use when running :hg:`serve`.
2511
2519
2512 ``collapse``
2520 ``collapse``
2513 With ``descend`` enabled, repositories in subdirectories are shown at
2521 With ``descend`` enabled, repositories in subdirectories are shown at
2514 a single level alongside repositories in the current path. With
2522 a single level alongside repositories in the current path. With
2515 ``collapse`` also enabled, repositories residing at a deeper level than
2523 ``collapse`` also enabled, repositories residing at a deeper level than
2516 the current path are grouped behind navigable directory entries that
2524 the current path are grouped behind navigable directory entries that
2517 lead to the locations of these repositories. In effect, this setting
2525 lead to the locations of these repositories. In effect, this setting
2518 collapses each collection of repositories found within a subdirectory
2526 collapses each collection of repositories found within a subdirectory
2519 into a single entry for that subdirectory. (default: False)
2527 into a single entry for that subdirectory. (default: False)
2520
2528
2521 ``comparisoncontext``
2529 ``comparisoncontext``
2522 Number of lines of context to show in side-by-side file comparison. If
2530 Number of lines of context to show in side-by-side file comparison. If
2523 negative or the value ``full``, whole files are shown. (default: 5)
2531 negative or the value ``full``, whole files are shown. (default: 5)
2524
2532
2525 This setting can be overridden by a ``context`` request parameter to the
2533 This setting can be overridden by a ``context`` request parameter to the
2526 ``comparison`` command, taking the same values.
2534 ``comparison`` command, taking the same values.
2527
2535
2528 ``contact``
2536 ``contact``
2529 Name or email address of the person in charge of the repository.
2537 Name or email address of the person in charge of the repository.
2530 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2538 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2531
2539
2532 ``csp``
2540 ``csp``
2533 Send a ``Content-Security-Policy`` HTTP header with this value.
2541 Send a ``Content-Security-Policy`` HTTP header with this value.
2534
2542
2535 The value may contain a special string ``%nonce%``, which will be replaced
2543 The value may contain a special string ``%nonce%``, which will be replaced
2536 by a randomly-generated one-time use value. If the value contains
2544 by a randomly-generated one-time use value. If the value contains
2537 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2545 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2538 one-time property of the nonce. This nonce will also be inserted into
2546 one-time property of the nonce. This nonce will also be inserted into
2539 ``<script>`` elements containing inline JavaScript.
2547 ``<script>`` elements containing inline JavaScript.
2540
2548
2541 Note: lots of HTML content sent by the server is derived from repository
2549 Note: lots of HTML content sent by the server is derived from repository
2542 data. Please consider the potential for malicious repository data to
2550 data. Please consider the potential for malicious repository data to
2543 "inject" itself into generated HTML content as part of your security
2551 "inject" itself into generated HTML content as part of your security
2544 threat model.
2552 threat model.
2545
2553
2546 ``deny_push``
2554 ``deny_push``
2547 Whether to deny pushing to the repository. If empty or not set,
2555 Whether to deny pushing to the repository. If empty or not set,
2548 push is not denied. If the special value ``*``, all remote users are
2556 push is not denied. If the special value ``*``, all remote users are
2549 denied push. Otherwise, unauthenticated users are all denied, and
2557 denied push. Otherwise, unauthenticated users are all denied, and
2550 any authenticated user name present in this list is also denied. The
2558 any authenticated user name present in this list is also denied. The
2551 contents of the deny_push list are examined before the allow-push list.
2559 contents of the deny_push list are examined before the allow-push list.
2552
2560
2553 ``deny_read``
2561 ``deny_read``
2554 Whether to deny reading/viewing of the repository. If this list is
2562 Whether to deny reading/viewing of the repository. If this list is
2555 not empty, unauthenticated users are all denied, and any
2563 not empty, unauthenticated users are all denied, and any
2556 authenticated user name present in this list is also denied access to
2564 authenticated user name present in this list is also denied access to
2557 the repository. If set to the special value ``*``, all remote users
2565 the repository. If set to the special value ``*``, all remote users
2558 are denied access (rarely needed ;). If deny_read is empty or not set,
2566 are denied access (rarely needed ;). If deny_read is empty or not set,
2559 the determination of repository access depends on the presence and
2567 the determination of repository access depends on the presence and
2560 content of the allow_read list (see description). If both
2568 content of the allow_read list (see description). If both
2561 deny_read and allow_read are empty or not set, then access is
2569 deny_read and allow_read are empty or not set, then access is
2562 permitted to all users by default. If the repository is being
2570 permitted to all users by default. If the repository is being
2563 served via hgwebdir, denied users will not be able to see it in
2571 served via hgwebdir, denied users will not be able to see it in
2564 the list of repositories. The contents of the deny_read list have
2572 the list of repositories. The contents of the deny_read list have
2565 priority over (are examined before) the contents of the allow_read
2573 priority over (are examined before) the contents of the allow_read
2566 list.
2574 list.
2567
2575
2568 ``descend``
2576 ``descend``
2569 hgwebdir indexes will not descend into subdirectories. Only repositories
2577 hgwebdir indexes will not descend into subdirectories. Only repositories
2570 directly in the current path will be shown (other repositories are still
2578 directly in the current path will be shown (other repositories are still
2571 available from the index corresponding to their containing path).
2579 available from the index corresponding to their containing path).
2572
2580
2573 ``description``
2581 ``description``
2574 Textual description of the repository's purpose or contents.
2582 Textual description of the repository's purpose or contents.
2575 (default: "unknown")
2583 (default: "unknown")
2576
2584
2577 ``encoding``
2585 ``encoding``
2578 Character encoding name. (default: the current locale charset)
2586 Character encoding name. (default: the current locale charset)
2579 Example: "UTF-8".
2587 Example: "UTF-8".
2580
2588
2581 ``errorlog``
2589 ``errorlog``
2582 Where to output the error log. (default: stderr)
2590 Where to output the error log. (default: stderr)
2583
2591
2584 ``guessmime``
2592 ``guessmime``
2585 Control MIME types for raw download of file content.
2593 Control MIME types for raw download of file content.
2586 Set to True to let hgweb guess the content type from the file
2594 Set to True to let hgweb guess the content type from the file
2587 extension. This will serve HTML files as ``text/html`` and might
2595 extension. This will serve HTML files as ``text/html`` and might
2588 allow cross-site scripting attacks when serving untrusted
2596 allow cross-site scripting attacks when serving untrusted
2589 repositories. (default: False)
2597 repositories. (default: False)
2590
2598
2591 ``hidden``
2599 ``hidden``
2592 Whether to hide the repository in the hgwebdir index.
2600 Whether to hide the repository in the hgwebdir index.
2593 (default: False)
2601 (default: False)
2594
2602
2595 ``ipv6``
2603 ``ipv6``
2596 Whether to use IPv6. (default: False)
2604 Whether to use IPv6. (default: False)
2597
2605
2598 ``labels``
2606 ``labels``
2599 List of string *labels* associated with the repository.
2607 List of string *labels* associated with the repository.
2600
2608
2601 Labels are exposed as a template keyword and can be used to customize
2609 Labels are exposed as a template keyword and can be used to customize
2602 output. e.g. the ``index`` template can group or filter repositories
2610 output. e.g. the ``index`` template can group or filter repositories
2603 by labels and the ``summary`` template can display additional content
2611 by labels and the ``summary`` template can display additional content
2604 if a specific label is present.
2612 if a specific label is present.
2605
2613
2606 ``logoimg``
2614 ``logoimg``
2607 File name of the logo image that some templates display on each page.
2615 File name of the logo image that some templates display on each page.
2608 The file name is relative to ``staticurl``. That is, the full path to
2616 The file name is relative to ``staticurl``. That is, the full path to
2609 the logo image is "staticurl/logoimg".
2617 the logo image is "staticurl/logoimg".
2610 If unset, ``hglogo.png`` will be used.
2618 If unset, ``hglogo.png`` will be used.
2611
2619
2612 ``logourl``
2620 ``logourl``
2613 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2621 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2614 will be used.
2622 will be used.
2615
2623
2616 ``maxchanges``
2624 ``maxchanges``
2617 Maximum number of changes to list on the changelog. (default: 10)
2625 Maximum number of changes to list on the changelog. (default: 10)
2618
2626
2619 ``maxfiles``
2627 ``maxfiles``
2620 Maximum number of files to list per changeset. (default: 10)
2628 Maximum number of files to list per changeset. (default: 10)
2621
2629
2622 ``maxshortchanges``
2630 ``maxshortchanges``
2623 Maximum number of changes to list on the shortlog, graph or filelog
2631 Maximum number of changes to list on the shortlog, graph or filelog
2624 pages. (default: 60)
2632 pages. (default: 60)
2625
2633
2626 ``name``
2634 ``name``
2627 Repository name to use in the web interface.
2635 Repository name to use in the web interface.
2628 (default: current working directory)
2636 (default: current working directory)
2629
2637
2630 ``port``
2638 ``port``
2631 Port to listen on. (default: 8000)
2639 Port to listen on. (default: 8000)
2632
2640
2633 ``prefix``
2641 ``prefix``
2634 Prefix path to serve from. (default: '' (server root))
2642 Prefix path to serve from. (default: '' (server root))
2635
2643
2636 ``push_ssl``
2644 ``push_ssl``
2637 Whether to require that inbound pushes be transported over SSL to
2645 Whether to require that inbound pushes be transported over SSL to
2638 prevent password sniffing. (default: True)
2646 prevent password sniffing. (default: True)
2639
2647
2640 ``refreshinterval``
2648 ``refreshinterval``
2641 How frequently directory listings re-scan the filesystem for new
2649 How frequently directory listings re-scan the filesystem for new
2642 repositories, in seconds. This is relevant when wildcards are used
2650 repositories, in seconds. This is relevant when wildcards are used
2643 to define paths. Depending on how much filesystem traversal is
2651 to define paths. Depending on how much filesystem traversal is
2644 required, refreshing may negatively impact performance.
2652 required, refreshing may negatively impact performance.
2645
2653
2646 Values less than or equal to 0 always refresh.
2654 Values less than or equal to 0 always refresh.
2647 (default: 20)
2655 (default: 20)
2648
2656
2649 ``server-header``
2657 ``server-header``
2650 Value for HTTP ``Server`` response header.
2658 Value for HTTP ``Server`` response header.
2651
2659
2652 ``static``
2660 ``static``
2653 Directory where static files are served from.
2661 Directory where static files are served from.
2654
2662
2655 ``staticurl``
2663 ``staticurl``
2656 Base URL to use for static files. If unset, static files (e.g. the
2664 Base URL to use for static files. If unset, static files (e.g. the
2657 hgicon.png favicon) will be served by the CGI script itself. Use
2665 hgicon.png favicon) will be served by the CGI script itself. Use
2658 this setting to serve them directly with the HTTP server.
2666 this setting to serve them directly with the HTTP server.
2659 Example: ``http://hgserver/static/``.
2667 Example: ``http://hgserver/static/``.
2660
2668
2661 ``stripes``
2669 ``stripes``
2662 How many lines a "zebra stripe" should span in multi-line output.
2670 How many lines a "zebra stripe" should span in multi-line output.
2663 Set to 0 to disable. (default: 1)
2671 Set to 0 to disable. (default: 1)
2664
2672
2665 ``style``
2673 ``style``
2666 Which template map style to use. The available options are the names of
2674 Which template map style to use. The available options are the names of
2667 subdirectories in the HTML templates path. (default: ``paper``)
2675 subdirectories in the HTML templates path. (default: ``paper``)
2668 Example: ``monoblue``.
2676 Example: ``monoblue``.
2669
2677
2670 ``templates``
2678 ``templates``
2671 Where to find the HTML templates. The default path to the HTML templates
2679 Where to find the HTML templates. The default path to the HTML templates
2672 can be obtained from ``hg debuginstall``.
2680 can be obtained from ``hg debuginstall``.
2673
2681
2674 ``websub``
2682 ``websub``
2675 ----------
2683 ----------
2676
2684
2677 Web substitution filter definition. You can use this section to
2685 Web substitution filter definition. You can use this section to
2678 define a set of regular expression substitution patterns which
2686 define a set of regular expression substitution patterns which
2679 let you automatically modify the hgweb server output.
2687 let you automatically modify the hgweb server output.
2680
2688
2681 The default hgweb templates only apply these substitution patterns
2689 The default hgweb templates only apply these substitution patterns
2682 on the revision description fields. You can apply them anywhere
2690 on the revision description fields. You can apply them anywhere
2683 you want when you create your own templates by adding calls to the
2691 you want when you create your own templates by adding calls to the
2684 "websub" filter (usually after calling the "escape" filter).
2692 "websub" filter (usually after calling the "escape" filter).
2685
2693
2686 This can be used, for example, to convert issue references to links
2694 This can be used, for example, to convert issue references to links
2687 to your issue tracker, or to convert "markdown-like" syntax into
2695 to your issue tracker, or to convert "markdown-like" syntax into
2688 HTML (see the examples below).
2696 HTML (see the examples below).
2689
2697
2690 Each entry in this section names a substitution filter.
2698 Each entry in this section names a substitution filter.
2691 The value of each entry defines the substitution expression itself.
2699 The value of each entry defines the substitution expression itself.
2692 The websub expressions follow the old interhg extension syntax,
2700 The websub expressions follow the old interhg extension syntax,
2693 which in turn imitates the Unix sed replacement syntax::
2701 which in turn imitates the Unix sed replacement syntax::
2694
2702
2695 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2703 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2696
2704
2697 You can use any separator other than "/". The final "i" is optional
2705 You can use any separator other than "/". The final "i" is optional
2698 and indicates that the search must be case insensitive.
2706 and indicates that the search must be case insensitive.
2699
2707
2700 Examples::
2708 Examples::
2701
2709
2702 [websub]
2710 [websub]
2703 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2711 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2704 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2712 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2705 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2713 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2706
2714
2707 ``worker``
2715 ``worker``
2708 ----------
2716 ----------
2709
2717
2710 Parallel master/worker configuration. We currently perform working
2718 Parallel master/worker configuration. We currently perform working
2711 directory updates in parallel on Unix-like systems, which greatly
2719 directory updates in parallel on Unix-like systems, which greatly
2712 helps performance.
2720 helps performance.
2713
2721
2714 ``enabled``
2722 ``enabled``
2715 Whether to enable workers code to be used.
2723 Whether to enable workers code to be used.
2716 (default: true)
2724 (default: true)
2717
2725
2718 ``numcpus``
2726 ``numcpus``
2719 Number of CPUs to use for parallel operations. A zero or
2727 Number of CPUs to use for parallel operations. A zero or
2720 negative value is treated as ``use the default``.
2728 negative value is treated as ``use the default``.
2721 (default: 4 or the number of CPUs on the system, whichever is larger)
2729 (default: 4 or the number of CPUs on the system, whichever is larger)
2722
2730
2723 ``backgroundclose``
2731 ``backgroundclose``
2724 Whether to enable closing file handles on background threads during certain
2732 Whether to enable closing file handles on background threads during certain
2725 operations. Some platforms aren't very efficient at closing file
2733 operations. Some platforms aren't very efficient at closing file
2726 handles that have been written or appended to. By performing file closing
2734 handles that have been written or appended to. By performing file closing
2727 on background threads, file write rate can increase substantially.
2735 on background threads, file write rate can increase substantially.
2728 (default: true on Windows, false elsewhere)
2736 (default: true on Windows, false elsewhere)
2729
2737
2730 ``backgroundcloseminfilecount``
2738 ``backgroundcloseminfilecount``
2731 Minimum number of files required to trigger background file closing.
2739 Minimum number of files required to trigger background file closing.
2732 Operations not writing this many files won't start background close
2740 Operations not writing this many files won't start background close
2733 threads.
2741 threads.
2734 (default: 2048)
2742 (default: 2048)
2735
2743
2736 ``backgroundclosemaxqueue``
2744 ``backgroundclosemaxqueue``
2737 The maximum number of opened file handles waiting to be closed in the
2745 The maximum number of opened file handles waiting to be closed in the
2738 background. This option only has an effect if ``backgroundclose`` is
2746 background. This option only has an effect if ``backgroundclose`` is
2739 enabled.
2747 enabled.
2740 (default: 384)
2748 (default: 384)
2741
2749
2742 ``backgroundclosethreadcount``
2750 ``backgroundclosethreadcount``
2743 Number of threads to process background file closes. Only relevant if
2751 Number of threads to process background file closes. Only relevant if
2744 ``backgroundclose`` is enabled.
2752 ``backgroundclose`` is enabled.
2745 (default: 4)
2753 (default: 4)
@@ -1,1941 +1,1959 b''
1 # ui.py - user interface bits for mercurial
1 # ui.py - user interface bits for mercurial
2 #
2 #
3 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
3 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7
7
8 from __future__ import absolute_import
8 from __future__ import absolute_import
9
9
10 import collections
10 import collections
11 import contextlib
11 import contextlib
12 import errno
12 import errno
13 import getpass
13 import getpass
14 import inspect
14 import inspect
15 import os
15 import os
16 import re
16 import re
17 import signal
17 import signal
18 import socket
18 import socket
19 import subprocess
19 import subprocess
20 import sys
20 import sys
21 import traceback
21 import traceback
22
22
23 from .i18n import _
23 from .i18n import _
24 from .node import hex
24 from .node import hex
25
25
26 from . import (
26 from . import (
27 color,
27 color,
28 config,
28 config,
29 configitems,
29 configitems,
30 encoding,
30 encoding,
31 error,
31 error,
32 formatter,
32 formatter,
33 progress,
33 progress,
34 pycompat,
34 pycompat,
35 rcutil,
35 rcutil,
36 scmutil,
36 scmutil,
37 util,
37 util,
38 )
38 )
39 from .utils import (
39 from .utils import (
40 dateutil,
40 dateutil,
41 procutil,
41 procutil,
42 stringutil,
42 stringutil,
43 )
43 )
44
44
45 urlreq = util.urlreq
45 urlreq = util.urlreq
46
46
47 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
47 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
48 _keepalnum = ''.join(c for c in map(pycompat.bytechr, range(256))
48 _keepalnum = ''.join(c for c in map(pycompat.bytechr, range(256))
49 if not c.isalnum())
49 if not c.isalnum())
50
50
51 # The config knobs that will be altered (if unset) by ui.tweakdefaults.
51 # The config knobs that will be altered (if unset) by ui.tweakdefaults.
52 tweakrc = b"""
52 tweakrc = b"""
53 [ui]
53 [ui]
54 # The rollback command is dangerous. As a rule, don't use it.
54 # The rollback command is dangerous. As a rule, don't use it.
55 rollback = False
55 rollback = False
56 # Make `hg status` report copy information
56 # Make `hg status` report copy information
57 statuscopies = yes
57 statuscopies = yes
58 # Prefer curses UIs when available. Revert to plain-text with `text`.
58 # Prefer curses UIs when available. Revert to plain-text with `text`.
59 interface = curses
59 interface = curses
60
60
61 [commands]
61 [commands]
62 # Grep working directory by default.
62 # Grep working directory by default.
63 grep.all-files = True
63 grep.all-files = True
64 # Make `hg status` emit cwd-relative paths by default.
64 # Make `hg status` emit cwd-relative paths by default.
65 status.relative = yes
65 status.relative = yes
66 # Refuse to perform an `hg update` that would cause a file content merge
66 # Refuse to perform an `hg update` that would cause a file content merge
67 update.check = noconflict
67 update.check = noconflict
68 # Show conflicts information in `hg status`
68 # Show conflicts information in `hg status`
69 status.verbose = True
69 status.verbose = True
70 # Refuse to perform `hg resolve --mark` on files that still have conflict
70 # Refuse to perform `hg resolve --mark` on files that still have conflict
71 # markers
71 # markers
72 resolve.mark-check = abort
72 resolve.mark-check = abort
73
73
74 [diff]
74 [diff]
75 git = 1
75 git = 1
76 showfunc = 1
76 showfunc = 1
77 word-diff = 1
77 word-diff = 1
78 """
78 """
79
79
80 samplehgrcs = {
80 samplehgrcs = {
81 'user':
81 'user':
82 b"""# example user config (see 'hg help config' for more info)
82 b"""# example user config (see 'hg help config' for more info)
83 [ui]
83 [ui]
84 # name and email, e.g.
84 # name and email, e.g.
85 # username = Jane Doe <jdoe@example.com>
85 # username = Jane Doe <jdoe@example.com>
86 username =
86 username =
87
87
88 # We recommend enabling tweakdefaults to get slight improvements to
88 # We recommend enabling tweakdefaults to get slight improvements to
89 # the UI over time. Make sure to set HGPLAIN in the environment when
89 # the UI over time. Make sure to set HGPLAIN in the environment when
90 # writing scripts!
90 # writing scripts!
91 # tweakdefaults = True
91 # tweakdefaults = True
92
92
93 # uncomment to disable color in command output
93 # uncomment to disable color in command output
94 # (see 'hg help color' for details)
94 # (see 'hg help color' for details)
95 # color = never
95 # color = never
96
96
97 # uncomment to disable command output pagination
97 # uncomment to disable command output pagination
98 # (see 'hg help pager' for details)
98 # (see 'hg help pager' for details)
99 # paginate = never
99 # paginate = never
100
100
101 [extensions]
101 [extensions]
102 # uncomment these lines to enable some popular extensions
102 # uncomment these lines to enable some popular extensions
103 # (see 'hg help extensions' for more info)
103 # (see 'hg help extensions' for more info)
104 #
104 #
105 # churn =
105 # churn =
106 """,
106 """,
107
107
108 'cloned':
108 'cloned':
109 b"""# example repository config (see 'hg help config' for more info)
109 b"""# example repository config (see 'hg help config' for more info)
110 [paths]
110 [paths]
111 default = %s
111 default = %s
112
112
113 # path aliases to other clones of this repo in URLs or filesystem paths
113 # path aliases to other clones of this repo in URLs or filesystem paths
114 # (see 'hg help config.paths' for more info)
114 # (see 'hg help config.paths' for more info)
115 #
115 #
116 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
116 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
117 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
117 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
118 # my-clone = /home/jdoe/jdoes-clone
118 # my-clone = /home/jdoe/jdoes-clone
119
119
120 [ui]
120 [ui]
121 # name and email (local to this repository, optional), e.g.
121 # name and email (local to this repository, optional), e.g.
122 # username = Jane Doe <jdoe@example.com>
122 # username = Jane Doe <jdoe@example.com>
123 """,
123 """,
124
124
125 'local':
125 'local':
126 b"""# example repository config (see 'hg help config' for more info)
126 b"""# example repository config (see 'hg help config' for more info)
127 [paths]
127 [paths]
128 # path aliases to other clones of this repo in URLs or filesystem paths
128 # path aliases to other clones of this repo in URLs or filesystem paths
129 # (see 'hg help config.paths' for more info)
129 # (see 'hg help config.paths' for more info)
130 #
130 #
131 # default = http://example.com/hg/example-repo
131 # default = http://example.com/hg/example-repo
132 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
132 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
133 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
133 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
134 # my-clone = /home/jdoe/jdoes-clone
134 # my-clone = /home/jdoe/jdoes-clone
135
135
136 [ui]
136 [ui]
137 # name and email (local to this repository, optional), e.g.
137 # name and email (local to this repository, optional), e.g.
138 # username = Jane Doe <jdoe@example.com>
138 # username = Jane Doe <jdoe@example.com>
139 """,
139 """,
140
140
141 'global':
141 'global':
142 b"""# example system-wide hg config (see 'hg help config' for more info)
142 b"""# example system-wide hg config (see 'hg help config' for more info)
143
143
144 [ui]
144 [ui]
145 # uncomment to disable color in command output
145 # uncomment to disable color in command output
146 # (see 'hg help color' for details)
146 # (see 'hg help color' for details)
147 # color = never
147 # color = never
148
148
149 # uncomment to disable command output pagination
149 # uncomment to disable command output pagination
150 # (see 'hg help pager' for details)
150 # (see 'hg help pager' for details)
151 # paginate = never
151 # paginate = never
152
152
153 [extensions]
153 [extensions]
154 # uncomment these lines to enable some popular extensions
154 # uncomment these lines to enable some popular extensions
155 # (see 'hg help extensions' for more info)
155 # (see 'hg help extensions' for more info)
156 #
156 #
157 # blackbox =
157 # blackbox =
158 # churn =
158 # churn =
159 """,
159 """,
160 }
160 }
161
161
162 def _maybestrurl(maybebytes):
162 def _maybestrurl(maybebytes):
163 return pycompat.rapply(pycompat.strurl, maybebytes)
163 return pycompat.rapply(pycompat.strurl, maybebytes)
164
164
165 def _maybebytesurl(maybestr):
165 def _maybebytesurl(maybestr):
166 return pycompat.rapply(pycompat.bytesurl, maybestr)
166 return pycompat.rapply(pycompat.bytesurl, maybestr)
167
167
168 class httppasswordmgrdbproxy(object):
168 class httppasswordmgrdbproxy(object):
169 """Delays loading urllib2 until it's needed."""
169 """Delays loading urllib2 until it's needed."""
170 def __init__(self):
170 def __init__(self):
171 self._mgr = None
171 self._mgr = None
172
172
173 def _get_mgr(self):
173 def _get_mgr(self):
174 if self._mgr is None:
174 if self._mgr is None:
175 self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
175 self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
176 return self._mgr
176 return self._mgr
177
177
178 def add_password(self, realm, uris, user, passwd):
178 def add_password(self, realm, uris, user, passwd):
179 return self._get_mgr().add_password(
179 return self._get_mgr().add_password(
180 _maybestrurl(realm), _maybestrurl(uris),
180 _maybestrurl(realm), _maybestrurl(uris),
181 _maybestrurl(user), _maybestrurl(passwd))
181 _maybestrurl(user), _maybestrurl(passwd))
182
182
183 def find_user_password(self, realm, uri):
183 def find_user_password(self, realm, uri):
184 mgr = self._get_mgr()
184 mgr = self._get_mgr()
185 return _maybebytesurl(mgr.find_user_password(_maybestrurl(realm),
185 return _maybebytesurl(mgr.find_user_password(_maybestrurl(realm),
186 _maybestrurl(uri)))
186 _maybestrurl(uri)))
187
187
188 def _catchterm(*args):
188 def _catchterm(*args):
189 raise error.SignalInterrupt
189 raise error.SignalInterrupt
190
190
191 # unique object used to detect no default value has been provided when
191 # unique object used to detect no default value has been provided when
192 # retrieving configuration value.
192 # retrieving configuration value.
193 _unset = object()
193 _unset = object()
194
194
195 # _reqexithandlers: callbacks run at the end of a request
195 # _reqexithandlers: callbacks run at the end of a request
196 _reqexithandlers = []
196 _reqexithandlers = []
197
197
198 class ui(object):
198 class ui(object):
199 def __init__(self, src=None):
199 def __init__(self, src=None):
200 """Create a fresh new ui object if no src given
200 """Create a fresh new ui object if no src given
201
201
202 Use uimod.ui.load() to create a ui which knows global and user configs.
202 Use uimod.ui.load() to create a ui which knows global and user configs.
203 In most cases, you should use ui.copy() to create a copy of an existing
203 In most cases, you should use ui.copy() to create a copy of an existing
204 ui object.
204 ui object.
205 """
205 """
206 # _buffers: used for temporary capture of output
206 # _buffers: used for temporary capture of output
207 self._buffers = []
207 self._buffers = []
208 # 3-tuple describing how each buffer in the stack behaves.
208 # 3-tuple describing how each buffer in the stack behaves.
209 # Values are (capture stderr, capture subprocesses, apply labels).
209 # Values are (capture stderr, capture subprocesses, apply labels).
210 self._bufferstates = []
210 self._bufferstates = []
211 # When a buffer is active, defines whether we are expanding labels.
211 # When a buffer is active, defines whether we are expanding labels.
212 # This exists to prevent an extra list lookup.
212 # This exists to prevent an extra list lookup.
213 self._bufferapplylabels = None
213 self._bufferapplylabels = None
214 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
214 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
215 self._reportuntrusted = True
215 self._reportuntrusted = True
216 self._knownconfig = configitems.coreitems
216 self._knownconfig = configitems.coreitems
217 self._ocfg = config.config() # overlay
217 self._ocfg = config.config() # overlay
218 self._tcfg = config.config() # trusted
218 self._tcfg = config.config() # trusted
219 self._ucfg = config.config() # untrusted
219 self._ucfg = config.config() # untrusted
220 self._trustusers = set()
220 self._trustusers = set()
221 self._trustgroups = set()
221 self._trustgroups = set()
222 self.callhooks = True
222 self.callhooks = True
223 # Insecure server connections requested.
223 # Insecure server connections requested.
224 self.insecureconnections = False
224 self.insecureconnections = False
225 # Blocked time
225 # Blocked time
226 self.logblockedtimes = False
226 self.logblockedtimes = False
227 # color mode: see mercurial/color.py for possible value
227 # color mode: see mercurial/color.py for possible value
228 self._colormode = None
228 self._colormode = None
229 self._terminfoparams = {}
229 self._terminfoparams = {}
230 self._styles = {}
230 self._styles = {}
231 self._uninterruptible = False
231 self._uninterruptible = False
232
232
233 if src:
233 if src:
234 self._fout = src._fout
234 self._fout = src._fout
235 self._ferr = src._ferr
235 self._ferr = src._ferr
236 self._fin = src._fin
236 self._fin = src._fin
237 self._fmsgout = src._fmsgout
238 self._fmsgerr = src._fmsgerr
237 self._finoutredirected = src._finoutredirected
239 self._finoutredirected = src._finoutredirected
238 self.pageractive = src.pageractive
240 self.pageractive = src.pageractive
239 self._disablepager = src._disablepager
241 self._disablepager = src._disablepager
240 self._tweaked = src._tweaked
242 self._tweaked = src._tweaked
241
243
242 self._tcfg = src._tcfg.copy()
244 self._tcfg = src._tcfg.copy()
243 self._ucfg = src._ucfg.copy()
245 self._ucfg = src._ucfg.copy()
244 self._ocfg = src._ocfg.copy()
246 self._ocfg = src._ocfg.copy()
245 self._trustusers = src._trustusers.copy()
247 self._trustusers = src._trustusers.copy()
246 self._trustgroups = src._trustgroups.copy()
248 self._trustgroups = src._trustgroups.copy()
247 self.environ = src.environ
249 self.environ = src.environ
248 self.callhooks = src.callhooks
250 self.callhooks = src.callhooks
249 self.insecureconnections = src.insecureconnections
251 self.insecureconnections = src.insecureconnections
250 self._colormode = src._colormode
252 self._colormode = src._colormode
251 self._terminfoparams = src._terminfoparams.copy()
253 self._terminfoparams = src._terminfoparams.copy()
252 self._styles = src._styles.copy()
254 self._styles = src._styles.copy()
253
255
254 self.fixconfig()
256 self.fixconfig()
255
257
256 self.httppasswordmgrdb = src.httppasswordmgrdb
258 self.httppasswordmgrdb = src.httppasswordmgrdb
257 self._blockedtimes = src._blockedtimes
259 self._blockedtimes = src._blockedtimes
258 else:
260 else:
259 self._fout = procutil.stdout
261 self._fout = procutil.stdout
260 self._ferr = procutil.stderr
262 self._ferr = procutil.stderr
261 self._fin = procutil.stdin
263 self._fin = procutil.stdin
264 self._fmsgout = self.fout # configurable
265 self._fmsgerr = self.ferr # configurable
262 self._finoutredirected = False
266 self._finoutredirected = False
263 self.pageractive = False
267 self.pageractive = False
264 self._disablepager = False
268 self._disablepager = False
265 self._tweaked = False
269 self._tweaked = False
266
270
267 # shared read-only environment
271 # shared read-only environment
268 self.environ = encoding.environ
272 self.environ = encoding.environ
269
273
270 self.httppasswordmgrdb = httppasswordmgrdbproxy()
274 self.httppasswordmgrdb = httppasswordmgrdbproxy()
271 self._blockedtimes = collections.defaultdict(int)
275 self._blockedtimes = collections.defaultdict(int)
272
276
273 allowed = self.configlist('experimental', 'exportableenviron')
277 allowed = self.configlist('experimental', 'exportableenviron')
274 if '*' in allowed:
278 if '*' in allowed:
275 self._exportableenviron = self.environ
279 self._exportableenviron = self.environ
276 else:
280 else:
277 self._exportableenviron = {}
281 self._exportableenviron = {}
278 for k in allowed:
282 for k in allowed:
279 if k in self.environ:
283 if k in self.environ:
280 self._exportableenviron[k] = self.environ[k]
284 self._exportableenviron[k] = self.environ[k]
281
285
282 @classmethod
286 @classmethod
283 def load(cls):
287 def load(cls):
284 """Create a ui and load global and user configs"""
288 """Create a ui and load global and user configs"""
285 u = cls()
289 u = cls()
286 # we always trust global config files and environment variables
290 # we always trust global config files and environment variables
287 for t, f in rcutil.rccomponents():
291 for t, f in rcutil.rccomponents():
288 if t == 'path':
292 if t == 'path':
289 u.readconfig(f, trust=True)
293 u.readconfig(f, trust=True)
290 elif t == 'items':
294 elif t == 'items':
291 sections = set()
295 sections = set()
292 for section, name, value, source in f:
296 for section, name, value, source in f:
293 # do not set u._ocfg
297 # do not set u._ocfg
294 # XXX clean this up once immutable config object is a thing
298 # XXX clean this up once immutable config object is a thing
295 u._tcfg.set(section, name, value, source)
299 u._tcfg.set(section, name, value, source)
296 u._ucfg.set(section, name, value, source)
300 u._ucfg.set(section, name, value, source)
297 sections.add(section)
301 sections.add(section)
298 for section in sections:
302 for section in sections:
299 u.fixconfig(section=section)
303 u.fixconfig(section=section)
300 else:
304 else:
301 raise error.ProgrammingError('unknown rctype: %s' % t)
305 raise error.ProgrammingError('unknown rctype: %s' % t)
302 u._maybetweakdefaults()
306 u._maybetweakdefaults()
303 return u
307 return u
304
308
305 def _maybetweakdefaults(self):
309 def _maybetweakdefaults(self):
306 if not self.configbool('ui', 'tweakdefaults'):
310 if not self.configbool('ui', 'tweakdefaults'):
307 return
311 return
308 if self._tweaked or self.plain('tweakdefaults'):
312 if self._tweaked or self.plain('tweakdefaults'):
309 return
313 return
310
314
311 # Note: it is SUPER IMPORTANT that you set self._tweaked to
315 # Note: it is SUPER IMPORTANT that you set self._tweaked to
312 # True *before* any calls to setconfig(), otherwise you'll get
316 # True *before* any calls to setconfig(), otherwise you'll get
313 # infinite recursion between setconfig and this method.
317 # infinite recursion between setconfig and this method.
314 #
318 #
315 # TODO: We should extract an inner method in setconfig() to
319 # TODO: We should extract an inner method in setconfig() to
316 # avoid this weirdness.
320 # avoid this weirdness.
317 self._tweaked = True
321 self._tweaked = True
318 tmpcfg = config.config()
322 tmpcfg = config.config()
319 tmpcfg.parse('<tweakdefaults>', tweakrc)
323 tmpcfg.parse('<tweakdefaults>', tweakrc)
320 for section in tmpcfg:
324 for section in tmpcfg:
321 for name, value in tmpcfg.items(section):
325 for name, value in tmpcfg.items(section):
322 if not self.hasconfig(section, name):
326 if not self.hasconfig(section, name):
323 self.setconfig(section, name, value, "<tweakdefaults>")
327 self.setconfig(section, name, value, "<tweakdefaults>")
324
328
325 def copy(self):
329 def copy(self):
326 return self.__class__(self)
330 return self.__class__(self)
327
331
328 def resetstate(self):
332 def resetstate(self):
329 """Clear internal state that shouldn't persist across commands"""
333 """Clear internal state that shouldn't persist across commands"""
330 if self._progbar:
334 if self._progbar:
331 self._progbar.resetstate() # reset last-print time of progress bar
335 self._progbar.resetstate() # reset last-print time of progress bar
332 self.httppasswordmgrdb = httppasswordmgrdbproxy()
336 self.httppasswordmgrdb = httppasswordmgrdbproxy()
333
337
334 @contextlib.contextmanager
338 @contextlib.contextmanager
335 def timeblockedsection(self, key):
339 def timeblockedsection(self, key):
336 # this is open-coded below - search for timeblockedsection to find them
340 # this is open-coded below - search for timeblockedsection to find them
337 starttime = util.timer()
341 starttime = util.timer()
338 try:
342 try:
339 yield
343 yield
340 finally:
344 finally:
341 self._blockedtimes[key + '_blocked'] += \
345 self._blockedtimes[key + '_blocked'] += \
342 (util.timer() - starttime) * 1000
346 (util.timer() - starttime) * 1000
343
347
344 @contextlib.contextmanager
348 @contextlib.contextmanager
345 def uninterruptable(self):
349 def uninterruptable(self):
346 """Mark an operation as unsafe.
350 """Mark an operation as unsafe.
347
351
348 Most operations on a repository are safe to interrupt, but a
352 Most operations on a repository are safe to interrupt, but a
349 few are risky (for example repair.strip). This context manager
353 few are risky (for example repair.strip). This context manager
350 lets you advise Mercurial that something risky is happening so
354 lets you advise Mercurial that something risky is happening so
351 that control-C etc can be blocked if desired.
355 that control-C etc can be blocked if desired.
352 """
356 """
353 enabled = self.configbool('experimental', 'nointerrupt')
357 enabled = self.configbool('experimental', 'nointerrupt')
354 if (enabled and
358 if (enabled and
355 self.configbool('experimental', 'nointerrupt-interactiveonly')):
359 self.configbool('experimental', 'nointerrupt-interactiveonly')):
356 enabled = self.interactive()
360 enabled = self.interactive()
357 if self._uninterruptible or not enabled:
361 if self._uninterruptible or not enabled:
358 # if nointerrupt support is turned off, the process isn't
362 # if nointerrupt support is turned off, the process isn't
359 # interactive, or we're already in an uninterruptable
363 # interactive, or we're already in an uninterruptable
360 # block, do nothing.
364 # block, do nothing.
361 yield
365 yield
362 return
366 return
363 def warn():
367 def warn():
364 self.warn(_("shutting down cleanly\n"))
368 self.warn(_("shutting down cleanly\n"))
365 self.warn(
369 self.warn(
366 _("press ^C again to terminate immediately (dangerous)\n"))
370 _("press ^C again to terminate immediately (dangerous)\n"))
367 return True
371 return True
368 with procutil.uninterruptable(warn):
372 with procutil.uninterruptable(warn):
369 try:
373 try:
370 self._uninterruptible = True
374 self._uninterruptible = True
371 yield
375 yield
372 finally:
376 finally:
373 self._uninterruptible = False
377 self._uninterruptible = False
374
378
375 def formatter(self, topic, opts):
379 def formatter(self, topic, opts):
376 return formatter.formatter(self, self, topic, opts)
380 return formatter.formatter(self, self, topic, opts)
377
381
378 def _trusted(self, fp, f):
382 def _trusted(self, fp, f):
379 st = util.fstat(fp)
383 st = util.fstat(fp)
380 if util.isowner(st):
384 if util.isowner(st):
381 return True
385 return True
382
386
383 tusers, tgroups = self._trustusers, self._trustgroups
387 tusers, tgroups = self._trustusers, self._trustgroups
384 if '*' in tusers or '*' in tgroups:
388 if '*' in tusers or '*' in tgroups:
385 return True
389 return True
386
390
387 user = util.username(st.st_uid)
391 user = util.username(st.st_uid)
388 group = util.groupname(st.st_gid)
392 group = util.groupname(st.st_gid)
389 if user in tusers or group in tgroups or user == util.username():
393 if user in tusers or group in tgroups or user == util.username():
390 return True
394 return True
391
395
392 if self._reportuntrusted:
396 if self._reportuntrusted:
393 self.warn(_('not trusting file %s from untrusted '
397 self.warn(_('not trusting file %s from untrusted '
394 'user %s, group %s\n') % (f, user, group))
398 'user %s, group %s\n') % (f, user, group))
395 return False
399 return False
396
400
397 def readconfig(self, filename, root=None, trust=False,
401 def readconfig(self, filename, root=None, trust=False,
398 sections=None, remap=None):
402 sections=None, remap=None):
399 try:
403 try:
400 fp = open(filename, r'rb')
404 fp = open(filename, r'rb')
401 except IOError:
405 except IOError:
402 if not sections: # ignore unless we were looking for something
406 if not sections: # ignore unless we were looking for something
403 return
407 return
404 raise
408 raise
405
409
406 cfg = config.config()
410 cfg = config.config()
407 trusted = sections or trust or self._trusted(fp, filename)
411 trusted = sections or trust or self._trusted(fp, filename)
408
412
409 try:
413 try:
410 cfg.read(filename, fp, sections=sections, remap=remap)
414 cfg.read(filename, fp, sections=sections, remap=remap)
411 fp.close()
415 fp.close()
412 except error.ConfigError as inst:
416 except error.ConfigError as inst:
413 if trusted:
417 if trusted:
414 raise
418 raise
415 self.warn(_("ignored: %s\n") % stringutil.forcebytestr(inst))
419 self.warn(_("ignored: %s\n") % stringutil.forcebytestr(inst))
416
420
417 if self.plain():
421 if self.plain():
418 for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
422 for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
419 'logtemplate', 'statuscopies', 'style',
423 'logtemplate', 'message-output', 'statuscopies', 'style',
420 'traceback', 'verbose'):
424 'traceback', 'verbose'):
421 if k in cfg['ui']:
425 if k in cfg['ui']:
422 del cfg['ui'][k]
426 del cfg['ui'][k]
423 for k, v in cfg.items('defaults'):
427 for k, v in cfg.items('defaults'):
424 del cfg['defaults'][k]
428 del cfg['defaults'][k]
425 for k, v in cfg.items('commands'):
429 for k, v in cfg.items('commands'):
426 del cfg['commands'][k]
430 del cfg['commands'][k]
427 # Don't remove aliases from the configuration if in the exceptionlist
431 # Don't remove aliases from the configuration if in the exceptionlist
428 if self.plain('alias'):
432 if self.plain('alias'):
429 for k, v in cfg.items('alias'):
433 for k, v in cfg.items('alias'):
430 del cfg['alias'][k]
434 del cfg['alias'][k]
431 if self.plain('revsetalias'):
435 if self.plain('revsetalias'):
432 for k, v in cfg.items('revsetalias'):
436 for k, v in cfg.items('revsetalias'):
433 del cfg['revsetalias'][k]
437 del cfg['revsetalias'][k]
434 if self.plain('templatealias'):
438 if self.plain('templatealias'):
435 for k, v in cfg.items('templatealias'):
439 for k, v in cfg.items('templatealias'):
436 del cfg['templatealias'][k]
440 del cfg['templatealias'][k]
437
441
438 if trusted:
442 if trusted:
439 self._tcfg.update(cfg)
443 self._tcfg.update(cfg)
440 self._tcfg.update(self._ocfg)
444 self._tcfg.update(self._ocfg)
441 self._ucfg.update(cfg)
445 self._ucfg.update(cfg)
442 self._ucfg.update(self._ocfg)
446 self._ucfg.update(self._ocfg)
443
447
444 if root is None:
448 if root is None:
445 root = os.path.expanduser('~')
449 root = os.path.expanduser('~')
446 self.fixconfig(root=root)
450 self.fixconfig(root=root)
447
451
448 def fixconfig(self, root=None, section=None):
452 def fixconfig(self, root=None, section=None):
449 if section in (None, 'paths'):
453 if section in (None, 'paths'):
450 # expand vars and ~
454 # expand vars and ~
451 # translate paths relative to root (or home) into absolute paths
455 # translate paths relative to root (or home) into absolute paths
452 root = root or encoding.getcwd()
456 root = root or encoding.getcwd()
453 for c in self._tcfg, self._ucfg, self._ocfg:
457 for c in self._tcfg, self._ucfg, self._ocfg:
454 for n, p in c.items('paths'):
458 for n, p in c.items('paths'):
455 # Ignore sub-options.
459 # Ignore sub-options.
456 if ':' in n:
460 if ':' in n:
457 continue
461 continue
458 if not p:
462 if not p:
459 continue
463 continue
460 if '%%' in p:
464 if '%%' in p:
461 s = self.configsource('paths', n) or 'none'
465 s = self.configsource('paths', n) or 'none'
462 self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
466 self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
463 % (n, p, s))
467 % (n, p, s))
464 p = p.replace('%%', '%')
468 p = p.replace('%%', '%')
465 p = util.expandpath(p)
469 p = util.expandpath(p)
466 if not util.hasscheme(p) and not os.path.isabs(p):
470 if not util.hasscheme(p) and not os.path.isabs(p):
467 p = os.path.normpath(os.path.join(root, p))
471 p = os.path.normpath(os.path.join(root, p))
468 c.set("paths", n, p)
472 c.set("paths", n, p)
469
473
470 if section in (None, 'ui'):
474 if section in (None, 'ui'):
471 # update ui options
475 # update ui options
476 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
472 self.debugflag = self.configbool('ui', 'debug')
477 self.debugflag = self.configbool('ui', 'debug')
473 self.verbose = self.debugflag or self.configbool('ui', 'verbose')
478 self.verbose = self.debugflag or self.configbool('ui', 'verbose')
474 self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
479 self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
475 if self.verbose and self.quiet:
480 if self.verbose and self.quiet:
476 self.quiet = self.verbose = False
481 self.quiet = self.verbose = False
477 self._reportuntrusted = self.debugflag or self.configbool("ui",
482 self._reportuntrusted = self.debugflag or self.configbool("ui",
478 "report_untrusted")
483 "report_untrusted")
479 self.tracebackflag = self.configbool('ui', 'traceback')
484 self.tracebackflag = self.configbool('ui', 'traceback')
480 self.logblockedtimes = self.configbool('ui', 'logblockedtimes')
485 self.logblockedtimes = self.configbool('ui', 'logblockedtimes')
481
486
482 if section in (None, 'trusted'):
487 if section in (None, 'trusted'):
483 # update trust information
488 # update trust information
484 self._trustusers.update(self.configlist('trusted', 'users'))
489 self._trustusers.update(self.configlist('trusted', 'users'))
485 self._trustgroups.update(self.configlist('trusted', 'groups'))
490 self._trustgroups.update(self.configlist('trusted', 'groups'))
486
491
487 def backupconfig(self, section, item):
492 def backupconfig(self, section, item):
488 return (self._ocfg.backup(section, item),
493 return (self._ocfg.backup(section, item),
489 self._tcfg.backup(section, item),
494 self._tcfg.backup(section, item),
490 self._ucfg.backup(section, item),)
495 self._ucfg.backup(section, item),)
491 def restoreconfig(self, data):
496 def restoreconfig(self, data):
492 self._ocfg.restore(data[0])
497 self._ocfg.restore(data[0])
493 self._tcfg.restore(data[1])
498 self._tcfg.restore(data[1])
494 self._ucfg.restore(data[2])
499 self._ucfg.restore(data[2])
495
500
496 def setconfig(self, section, name, value, source=''):
501 def setconfig(self, section, name, value, source=''):
497 for cfg in (self._ocfg, self._tcfg, self._ucfg):
502 for cfg in (self._ocfg, self._tcfg, self._ucfg):
498 cfg.set(section, name, value, source)
503 cfg.set(section, name, value, source)
499 self.fixconfig(section=section)
504 self.fixconfig(section=section)
500 self._maybetweakdefaults()
505 self._maybetweakdefaults()
501
506
502 def _data(self, untrusted):
507 def _data(self, untrusted):
503 return untrusted and self._ucfg or self._tcfg
508 return untrusted and self._ucfg or self._tcfg
504
509
505 def configsource(self, section, name, untrusted=False):
510 def configsource(self, section, name, untrusted=False):
506 return self._data(untrusted).source(section, name)
511 return self._data(untrusted).source(section, name)
507
512
508 def config(self, section, name, default=_unset, untrusted=False):
513 def config(self, section, name, default=_unset, untrusted=False):
509 """return the plain string version of a config"""
514 """return the plain string version of a config"""
510 value = self._config(section, name, default=default,
515 value = self._config(section, name, default=default,
511 untrusted=untrusted)
516 untrusted=untrusted)
512 if value is _unset:
517 if value is _unset:
513 return None
518 return None
514 return value
519 return value
515
520
516 def _config(self, section, name, default=_unset, untrusted=False):
521 def _config(self, section, name, default=_unset, untrusted=False):
517 value = itemdefault = default
522 value = itemdefault = default
518 item = self._knownconfig.get(section, {}).get(name)
523 item = self._knownconfig.get(section, {}).get(name)
519 alternates = [(section, name)]
524 alternates = [(section, name)]
520
525
521 if item is not None:
526 if item is not None:
522 alternates.extend(item.alias)
527 alternates.extend(item.alias)
523 if callable(item.default):
528 if callable(item.default):
524 itemdefault = item.default()
529 itemdefault = item.default()
525 else:
530 else:
526 itemdefault = item.default
531 itemdefault = item.default
527 else:
532 else:
528 msg = ("accessing unregistered config item: '%s.%s'")
533 msg = ("accessing unregistered config item: '%s.%s'")
529 msg %= (section, name)
534 msg %= (section, name)
530 self.develwarn(msg, 2, 'warn-config-unknown')
535 self.develwarn(msg, 2, 'warn-config-unknown')
531
536
532 if default is _unset:
537 if default is _unset:
533 if item is None:
538 if item is None:
534 value = default
539 value = default
535 elif item.default is configitems.dynamicdefault:
540 elif item.default is configitems.dynamicdefault:
536 value = None
541 value = None
537 msg = "config item requires an explicit default value: '%s.%s'"
542 msg = "config item requires an explicit default value: '%s.%s'"
538 msg %= (section, name)
543 msg %= (section, name)
539 self.develwarn(msg, 2, 'warn-config-default')
544 self.develwarn(msg, 2, 'warn-config-default')
540 else:
545 else:
541 value = itemdefault
546 value = itemdefault
542 elif (item is not None
547 elif (item is not None
543 and item.default is not configitems.dynamicdefault
548 and item.default is not configitems.dynamicdefault
544 and default != itemdefault):
549 and default != itemdefault):
545 msg = ("specifying a mismatched default value for a registered "
550 msg = ("specifying a mismatched default value for a registered "
546 "config item: '%s.%s' '%s'")
551 "config item: '%s.%s' '%s'")
547 msg %= (section, name, pycompat.bytestr(default))
552 msg %= (section, name, pycompat.bytestr(default))
548 self.develwarn(msg, 2, 'warn-config-default')
553 self.develwarn(msg, 2, 'warn-config-default')
549
554
550 for s, n in alternates:
555 for s, n in alternates:
551 candidate = self._data(untrusted).get(s, n, None)
556 candidate = self._data(untrusted).get(s, n, None)
552 if candidate is not None:
557 if candidate is not None:
553 value = candidate
558 value = candidate
554 section = s
559 section = s
555 name = n
560 name = n
556 break
561 break
557
562
558 if self.debugflag and not untrusted and self._reportuntrusted:
563 if self.debugflag and not untrusted and self._reportuntrusted:
559 for s, n in alternates:
564 for s, n in alternates:
560 uvalue = self._ucfg.get(s, n)
565 uvalue = self._ucfg.get(s, n)
561 if uvalue is not None and uvalue != value:
566 if uvalue is not None and uvalue != value:
562 self.debug("ignoring untrusted configuration option "
567 self.debug("ignoring untrusted configuration option "
563 "%s.%s = %s\n" % (s, n, uvalue))
568 "%s.%s = %s\n" % (s, n, uvalue))
564 return value
569 return value
565
570
566 def configsuboptions(self, section, name, default=_unset, untrusted=False):
571 def configsuboptions(self, section, name, default=_unset, untrusted=False):
567 """Get a config option and all sub-options.
572 """Get a config option and all sub-options.
568
573
569 Some config options have sub-options that are declared with the
574 Some config options have sub-options that are declared with the
570 format "key:opt = value". This method is used to return the main
575 format "key:opt = value". This method is used to return the main
571 option and all its declared sub-options.
576 option and all its declared sub-options.
572
577
573 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
578 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
574 is a dict of defined sub-options where keys and values are strings.
579 is a dict of defined sub-options where keys and values are strings.
575 """
580 """
576 main = self.config(section, name, default, untrusted=untrusted)
581 main = self.config(section, name, default, untrusted=untrusted)
577 data = self._data(untrusted)
582 data = self._data(untrusted)
578 sub = {}
583 sub = {}
579 prefix = '%s:' % name
584 prefix = '%s:' % name
580 for k, v in data.items(section):
585 for k, v in data.items(section):
581 if k.startswith(prefix):
586 if k.startswith(prefix):
582 sub[k[len(prefix):]] = v
587 sub[k[len(prefix):]] = v
583
588
584 if self.debugflag and not untrusted and self._reportuntrusted:
589 if self.debugflag and not untrusted and self._reportuntrusted:
585 for k, v in sub.items():
590 for k, v in sub.items():
586 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
591 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
587 if uvalue is not None and uvalue != v:
592 if uvalue is not None and uvalue != v:
588 self.debug('ignoring untrusted configuration option '
593 self.debug('ignoring untrusted configuration option '
589 '%s:%s.%s = %s\n' % (section, name, k, uvalue))
594 '%s:%s.%s = %s\n' % (section, name, k, uvalue))
590
595
591 return main, sub
596 return main, sub
592
597
593 def configpath(self, section, name, default=_unset, untrusted=False):
598 def configpath(self, section, name, default=_unset, untrusted=False):
594 'get a path config item, expanded relative to repo root or config file'
599 'get a path config item, expanded relative to repo root or config file'
595 v = self.config(section, name, default, untrusted)
600 v = self.config(section, name, default, untrusted)
596 if v is None:
601 if v is None:
597 return None
602 return None
598 if not os.path.isabs(v) or "://" not in v:
603 if not os.path.isabs(v) or "://" not in v:
599 src = self.configsource(section, name, untrusted)
604 src = self.configsource(section, name, untrusted)
600 if ':' in src:
605 if ':' in src:
601 base = os.path.dirname(src.rsplit(':')[0])
606 base = os.path.dirname(src.rsplit(':')[0])
602 v = os.path.join(base, os.path.expanduser(v))
607 v = os.path.join(base, os.path.expanduser(v))
603 return v
608 return v
604
609
605 def configbool(self, section, name, default=_unset, untrusted=False):
610 def configbool(self, section, name, default=_unset, untrusted=False):
606 """parse a configuration element as a boolean
611 """parse a configuration element as a boolean
607
612
608 >>> u = ui(); s = b'foo'
613 >>> u = ui(); s = b'foo'
609 >>> u.setconfig(s, b'true', b'yes')
614 >>> u.setconfig(s, b'true', b'yes')
610 >>> u.configbool(s, b'true')
615 >>> u.configbool(s, b'true')
611 True
616 True
612 >>> u.setconfig(s, b'false', b'no')
617 >>> u.setconfig(s, b'false', b'no')
613 >>> u.configbool(s, b'false')
618 >>> u.configbool(s, b'false')
614 False
619 False
615 >>> u.configbool(s, b'unknown')
620 >>> u.configbool(s, b'unknown')
616 False
621 False
617 >>> u.configbool(s, b'unknown', True)
622 >>> u.configbool(s, b'unknown', True)
618 True
623 True
619 >>> u.setconfig(s, b'invalid', b'somevalue')
624 >>> u.setconfig(s, b'invalid', b'somevalue')
620 >>> u.configbool(s, b'invalid')
625 >>> u.configbool(s, b'invalid')
621 Traceback (most recent call last):
626 Traceback (most recent call last):
622 ...
627 ...
623 ConfigError: foo.invalid is not a boolean ('somevalue')
628 ConfigError: foo.invalid is not a boolean ('somevalue')
624 """
629 """
625
630
626 v = self._config(section, name, default, untrusted=untrusted)
631 v = self._config(section, name, default, untrusted=untrusted)
627 if v is None:
632 if v is None:
628 return v
633 return v
629 if v is _unset:
634 if v is _unset:
630 if default is _unset:
635 if default is _unset:
631 return False
636 return False
632 return default
637 return default
633 if isinstance(v, bool):
638 if isinstance(v, bool):
634 return v
639 return v
635 b = stringutil.parsebool(v)
640 b = stringutil.parsebool(v)
636 if b is None:
641 if b is None:
637 raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
642 raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
638 % (section, name, v))
643 % (section, name, v))
639 return b
644 return b
640
645
641 def configwith(self, convert, section, name, default=_unset,
646 def configwith(self, convert, section, name, default=_unset,
642 desc=None, untrusted=False):
647 desc=None, untrusted=False):
643 """parse a configuration element with a conversion function
648 """parse a configuration element with a conversion function
644
649
645 >>> u = ui(); s = b'foo'
650 >>> u = ui(); s = b'foo'
646 >>> u.setconfig(s, b'float1', b'42')
651 >>> u.setconfig(s, b'float1', b'42')
647 >>> u.configwith(float, s, b'float1')
652 >>> u.configwith(float, s, b'float1')
648 42.0
653 42.0
649 >>> u.setconfig(s, b'float2', b'-4.25')
654 >>> u.setconfig(s, b'float2', b'-4.25')
650 >>> u.configwith(float, s, b'float2')
655 >>> u.configwith(float, s, b'float2')
651 -4.25
656 -4.25
652 >>> u.configwith(float, s, b'unknown', 7)
657 >>> u.configwith(float, s, b'unknown', 7)
653 7.0
658 7.0
654 >>> u.setconfig(s, b'invalid', b'somevalue')
659 >>> u.setconfig(s, b'invalid', b'somevalue')
655 >>> u.configwith(float, s, b'invalid')
660 >>> u.configwith(float, s, b'invalid')
656 Traceback (most recent call last):
661 Traceback (most recent call last):
657 ...
662 ...
658 ConfigError: foo.invalid is not a valid float ('somevalue')
663 ConfigError: foo.invalid is not a valid float ('somevalue')
659 >>> u.configwith(float, s, b'invalid', desc=b'womble')
664 >>> u.configwith(float, s, b'invalid', desc=b'womble')
660 Traceback (most recent call last):
665 Traceback (most recent call last):
661 ...
666 ...
662 ConfigError: foo.invalid is not a valid womble ('somevalue')
667 ConfigError: foo.invalid is not a valid womble ('somevalue')
663 """
668 """
664
669
665 v = self.config(section, name, default, untrusted)
670 v = self.config(section, name, default, untrusted)
666 if v is None:
671 if v is None:
667 return v # do not attempt to convert None
672 return v # do not attempt to convert None
668 try:
673 try:
669 return convert(v)
674 return convert(v)
670 except (ValueError, error.ParseError):
675 except (ValueError, error.ParseError):
671 if desc is None:
676 if desc is None:
672 desc = pycompat.sysbytes(convert.__name__)
677 desc = pycompat.sysbytes(convert.__name__)
673 raise error.ConfigError(_("%s.%s is not a valid %s ('%s')")
678 raise error.ConfigError(_("%s.%s is not a valid %s ('%s')")
674 % (section, name, desc, v))
679 % (section, name, desc, v))
675
680
676 def configint(self, section, name, default=_unset, untrusted=False):
681 def configint(self, section, name, default=_unset, untrusted=False):
677 """parse a configuration element as an integer
682 """parse a configuration element as an integer
678
683
679 >>> u = ui(); s = b'foo'
684 >>> u = ui(); s = b'foo'
680 >>> u.setconfig(s, b'int1', b'42')
685 >>> u.setconfig(s, b'int1', b'42')
681 >>> u.configint(s, b'int1')
686 >>> u.configint(s, b'int1')
682 42
687 42
683 >>> u.setconfig(s, b'int2', b'-42')
688 >>> u.setconfig(s, b'int2', b'-42')
684 >>> u.configint(s, b'int2')
689 >>> u.configint(s, b'int2')
685 -42
690 -42
686 >>> u.configint(s, b'unknown', 7)
691 >>> u.configint(s, b'unknown', 7)
687 7
692 7
688 >>> u.setconfig(s, b'invalid', b'somevalue')
693 >>> u.setconfig(s, b'invalid', b'somevalue')
689 >>> u.configint(s, b'invalid')
694 >>> u.configint(s, b'invalid')
690 Traceback (most recent call last):
695 Traceback (most recent call last):
691 ...
696 ...
692 ConfigError: foo.invalid is not a valid integer ('somevalue')
697 ConfigError: foo.invalid is not a valid integer ('somevalue')
693 """
698 """
694
699
695 return self.configwith(int, section, name, default, 'integer',
700 return self.configwith(int, section, name, default, 'integer',
696 untrusted)
701 untrusted)
697
702
698 def configbytes(self, section, name, default=_unset, untrusted=False):
703 def configbytes(self, section, name, default=_unset, untrusted=False):
699 """parse a configuration element as a quantity in bytes
704 """parse a configuration element as a quantity in bytes
700
705
701 Units can be specified as b (bytes), k or kb (kilobytes), m or
706 Units can be specified as b (bytes), k or kb (kilobytes), m or
702 mb (megabytes), g or gb (gigabytes).
707 mb (megabytes), g or gb (gigabytes).
703
708
704 >>> u = ui(); s = b'foo'
709 >>> u = ui(); s = b'foo'
705 >>> u.setconfig(s, b'val1', b'42')
710 >>> u.setconfig(s, b'val1', b'42')
706 >>> u.configbytes(s, b'val1')
711 >>> u.configbytes(s, b'val1')
707 42
712 42
708 >>> u.setconfig(s, b'val2', b'42.5 kb')
713 >>> u.setconfig(s, b'val2', b'42.5 kb')
709 >>> u.configbytes(s, b'val2')
714 >>> u.configbytes(s, b'val2')
710 43520
715 43520
711 >>> u.configbytes(s, b'unknown', b'7 MB')
716 >>> u.configbytes(s, b'unknown', b'7 MB')
712 7340032
717 7340032
713 >>> u.setconfig(s, b'invalid', b'somevalue')
718 >>> u.setconfig(s, b'invalid', b'somevalue')
714 >>> u.configbytes(s, b'invalid')
719 >>> u.configbytes(s, b'invalid')
715 Traceback (most recent call last):
720 Traceback (most recent call last):
716 ...
721 ...
717 ConfigError: foo.invalid is not a byte quantity ('somevalue')
722 ConfigError: foo.invalid is not a byte quantity ('somevalue')
718 """
723 """
719
724
720 value = self._config(section, name, default, untrusted)
725 value = self._config(section, name, default, untrusted)
721 if value is _unset:
726 if value is _unset:
722 if default is _unset:
727 if default is _unset:
723 default = 0
728 default = 0
724 value = default
729 value = default
725 if not isinstance(value, bytes):
730 if not isinstance(value, bytes):
726 return value
731 return value
727 try:
732 try:
728 return util.sizetoint(value)
733 return util.sizetoint(value)
729 except error.ParseError:
734 except error.ParseError:
730 raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
735 raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
731 % (section, name, value))
736 % (section, name, value))
732
737
733 def configlist(self, section, name, default=_unset, untrusted=False):
738 def configlist(self, section, name, default=_unset, untrusted=False):
734 """parse a configuration element as a list of comma/space separated
739 """parse a configuration element as a list of comma/space separated
735 strings
740 strings
736
741
737 >>> u = ui(); s = b'foo'
742 >>> u = ui(); s = b'foo'
738 >>> u.setconfig(s, b'list1', b'this,is "a small" ,test')
743 >>> u.setconfig(s, b'list1', b'this,is "a small" ,test')
739 >>> u.configlist(s, b'list1')
744 >>> u.configlist(s, b'list1')
740 ['this', 'is', 'a small', 'test']
745 ['this', 'is', 'a small', 'test']
741 >>> u.setconfig(s, b'list2', b'this, is "a small" , test ')
746 >>> u.setconfig(s, b'list2', b'this, is "a small" , test ')
742 >>> u.configlist(s, b'list2')
747 >>> u.configlist(s, b'list2')
743 ['this', 'is', 'a small', 'test']
748 ['this', 'is', 'a small', 'test']
744 """
749 """
745 # default is not always a list
750 # default is not always a list
746 v = self.configwith(config.parselist, section, name, default,
751 v = self.configwith(config.parselist, section, name, default,
747 'list', untrusted)
752 'list', untrusted)
748 if isinstance(v, bytes):
753 if isinstance(v, bytes):
749 return config.parselist(v)
754 return config.parselist(v)
750 elif v is None:
755 elif v is None:
751 return []
756 return []
752 return v
757 return v
753
758
754 def configdate(self, section, name, default=_unset, untrusted=False):
759 def configdate(self, section, name, default=_unset, untrusted=False):
755 """parse a configuration element as a tuple of ints
760 """parse a configuration element as a tuple of ints
756
761
757 >>> u = ui(); s = b'foo'
762 >>> u = ui(); s = b'foo'
758 >>> u.setconfig(s, b'date', b'0 0')
763 >>> u.setconfig(s, b'date', b'0 0')
759 >>> u.configdate(s, b'date')
764 >>> u.configdate(s, b'date')
760 (0, 0)
765 (0, 0)
761 """
766 """
762 if self.config(section, name, default, untrusted):
767 if self.config(section, name, default, untrusted):
763 return self.configwith(dateutil.parsedate, section, name, default,
768 return self.configwith(dateutil.parsedate, section, name, default,
764 'date', untrusted)
769 'date', untrusted)
765 if default is _unset:
770 if default is _unset:
766 return None
771 return None
767 return default
772 return default
768
773
769 def hasconfig(self, section, name, untrusted=False):
774 def hasconfig(self, section, name, untrusted=False):
770 return self._data(untrusted).hasitem(section, name)
775 return self._data(untrusted).hasitem(section, name)
771
776
772 def has_section(self, section, untrusted=False):
777 def has_section(self, section, untrusted=False):
773 '''tell whether section exists in config.'''
778 '''tell whether section exists in config.'''
774 return section in self._data(untrusted)
779 return section in self._data(untrusted)
775
780
776 def configitems(self, section, untrusted=False, ignoresub=False):
781 def configitems(self, section, untrusted=False, ignoresub=False):
777 items = self._data(untrusted).items(section)
782 items = self._data(untrusted).items(section)
778 if ignoresub:
783 if ignoresub:
779 items = [i for i in items if ':' not in i[0]]
784 items = [i for i in items if ':' not in i[0]]
780 if self.debugflag and not untrusted and self._reportuntrusted:
785 if self.debugflag and not untrusted and self._reportuntrusted:
781 for k, v in self._ucfg.items(section):
786 for k, v in self._ucfg.items(section):
782 if self._tcfg.get(section, k) != v:
787 if self._tcfg.get(section, k) != v:
783 self.debug("ignoring untrusted configuration option "
788 self.debug("ignoring untrusted configuration option "
784 "%s.%s = %s\n" % (section, k, v))
789 "%s.%s = %s\n" % (section, k, v))
785 return items
790 return items
786
791
787 def walkconfig(self, untrusted=False):
792 def walkconfig(self, untrusted=False):
788 cfg = self._data(untrusted)
793 cfg = self._data(untrusted)
789 for section in cfg.sections():
794 for section in cfg.sections():
790 for name, value in self.configitems(section, untrusted):
795 for name, value in self.configitems(section, untrusted):
791 yield section, name, value
796 yield section, name, value
792
797
793 def plain(self, feature=None):
798 def plain(self, feature=None):
794 '''is plain mode active?
799 '''is plain mode active?
795
800
796 Plain mode means that all configuration variables which affect
801 Plain mode means that all configuration variables which affect
797 the behavior and output of Mercurial should be
802 the behavior and output of Mercurial should be
798 ignored. Additionally, the output should be stable,
803 ignored. Additionally, the output should be stable,
799 reproducible and suitable for use in scripts or applications.
804 reproducible and suitable for use in scripts or applications.
800
805
801 The only way to trigger plain mode is by setting either the
806 The only way to trigger plain mode is by setting either the
802 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
807 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
803
808
804 The return value can either be
809 The return value can either be
805 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
810 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
806 - False if feature is disabled by default and not included in HGPLAIN
811 - False if feature is disabled by default and not included in HGPLAIN
807 - True otherwise
812 - True otherwise
808 '''
813 '''
809 if ('HGPLAIN' not in encoding.environ and
814 if ('HGPLAIN' not in encoding.environ and
810 'HGPLAINEXCEPT' not in encoding.environ):
815 'HGPLAINEXCEPT' not in encoding.environ):
811 return False
816 return False
812 exceptions = encoding.environ.get('HGPLAINEXCEPT',
817 exceptions = encoding.environ.get('HGPLAINEXCEPT',
813 '').strip().split(',')
818 '').strip().split(',')
814 # TODO: add support for HGPLAIN=+feature,-feature syntax
819 # TODO: add support for HGPLAIN=+feature,-feature syntax
815 if '+strictflags' not in encoding.environ.get('HGPLAIN', '').split(','):
820 if '+strictflags' not in encoding.environ.get('HGPLAIN', '').split(','):
816 exceptions.append('strictflags')
821 exceptions.append('strictflags')
817 if feature and exceptions:
822 if feature and exceptions:
818 return feature not in exceptions
823 return feature not in exceptions
819 return True
824 return True
820
825
821 def username(self, acceptempty=False):
826 def username(self, acceptempty=False):
822 """Return default username to be used in commits.
827 """Return default username to be used in commits.
823
828
824 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
829 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
825 and stop searching if one of these is set.
830 and stop searching if one of these is set.
826 If not found and acceptempty is True, returns None.
831 If not found and acceptempty is True, returns None.
827 If not found and ui.askusername is True, ask the user, else use
832 If not found and ui.askusername is True, ask the user, else use
828 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
833 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
829 If no username could be found, raise an Abort error.
834 If no username could be found, raise an Abort error.
830 """
835 """
831 user = encoding.environ.get("HGUSER")
836 user = encoding.environ.get("HGUSER")
832 if user is None:
837 if user is None:
833 user = self.config("ui", "username")
838 user = self.config("ui", "username")
834 if user is not None:
839 if user is not None:
835 user = os.path.expandvars(user)
840 user = os.path.expandvars(user)
836 if user is None:
841 if user is None:
837 user = encoding.environ.get("EMAIL")
842 user = encoding.environ.get("EMAIL")
838 if user is None and acceptempty:
843 if user is None and acceptempty:
839 return user
844 return user
840 if user is None and self.configbool("ui", "askusername"):
845 if user is None and self.configbool("ui", "askusername"):
841 user = self.prompt(_("enter a commit username:"), default=None)
846 user = self.prompt(_("enter a commit username:"), default=None)
842 if user is None and not self.interactive():
847 if user is None and not self.interactive():
843 try:
848 try:
844 user = '%s@%s' % (procutil.getuser(),
849 user = '%s@%s' % (procutil.getuser(),
845 encoding.strtolocal(socket.getfqdn()))
850 encoding.strtolocal(socket.getfqdn()))
846 self.warn(_("no username found, using '%s' instead\n") % user)
851 self.warn(_("no username found, using '%s' instead\n") % user)
847 except KeyError:
852 except KeyError:
848 pass
853 pass
849 if not user:
854 if not user:
850 raise error.Abort(_('no username supplied'),
855 raise error.Abort(_('no username supplied'),
851 hint=_("use 'hg config --edit' "
856 hint=_("use 'hg config --edit' "
852 'to set your username'))
857 'to set your username'))
853 if "\n" in user:
858 if "\n" in user:
854 raise error.Abort(_("username %r contains a newline\n")
859 raise error.Abort(_("username %r contains a newline\n")
855 % pycompat.bytestr(user))
860 % pycompat.bytestr(user))
856 return user
861 return user
857
862
858 def shortuser(self, user):
863 def shortuser(self, user):
859 """Return a short representation of a user name or email address."""
864 """Return a short representation of a user name or email address."""
860 if not self.verbose:
865 if not self.verbose:
861 user = stringutil.shortuser(user)
866 user = stringutil.shortuser(user)
862 return user
867 return user
863
868
864 def expandpath(self, loc, default=None):
869 def expandpath(self, loc, default=None):
865 """Return repository location relative to cwd or from [paths]"""
870 """Return repository location relative to cwd or from [paths]"""
866 try:
871 try:
867 p = self.paths.getpath(loc)
872 p = self.paths.getpath(loc)
868 if p:
873 if p:
869 return p.rawloc
874 return p.rawloc
870 except error.RepoError:
875 except error.RepoError:
871 pass
876 pass
872
877
873 if default:
878 if default:
874 try:
879 try:
875 p = self.paths.getpath(default)
880 p = self.paths.getpath(default)
876 if p:
881 if p:
877 return p.rawloc
882 return p.rawloc
878 except error.RepoError:
883 except error.RepoError:
879 pass
884 pass
880
885
881 return loc
886 return loc
882
887
883 @util.propertycache
888 @util.propertycache
884 def paths(self):
889 def paths(self):
885 return paths(self)
890 return paths(self)
886
891
887 @property
892 @property
888 def fout(self):
893 def fout(self):
889 return self._fout
894 return self._fout
890
895
891 @fout.setter
896 @fout.setter
892 def fout(self, f):
897 def fout(self, f):
893 self._fout = f
898 self._fout = f
899 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
894
900
895 @property
901 @property
896 def ferr(self):
902 def ferr(self):
897 return self._ferr
903 return self._ferr
898
904
899 @ferr.setter
905 @ferr.setter
900 def ferr(self, f):
906 def ferr(self, f):
901 self._ferr = f
907 self._ferr = f
908 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
902
909
903 @property
910 @property
904 def fin(self):
911 def fin(self):
905 return self._fin
912 return self._fin
906
913
907 @fin.setter
914 @fin.setter
908 def fin(self, f):
915 def fin(self, f):
909 self._fin = f
916 self._fin = f
910
917
911 def pushbuffer(self, error=False, subproc=False, labeled=False):
918 def pushbuffer(self, error=False, subproc=False, labeled=False):
912 """install a buffer to capture standard output of the ui object
919 """install a buffer to capture standard output of the ui object
913
920
914 If error is True, the error output will be captured too.
921 If error is True, the error output will be captured too.
915
922
916 If subproc is True, output from subprocesses (typically hooks) will be
923 If subproc is True, output from subprocesses (typically hooks) will be
917 captured too.
924 captured too.
918
925
919 If labeled is True, any labels associated with buffered
926 If labeled is True, any labels associated with buffered
920 output will be handled. By default, this has no effect
927 output will be handled. By default, this has no effect
921 on the output returned, but extensions and GUI tools may
928 on the output returned, but extensions and GUI tools may
922 handle this argument and returned styled output. If output
929 handle this argument and returned styled output. If output
923 is being buffered so it can be captured and parsed or
930 is being buffered so it can be captured and parsed or
924 processed, labeled should not be set to True.
931 processed, labeled should not be set to True.
925 """
932 """
926 self._buffers.append([])
933 self._buffers.append([])
927 self._bufferstates.append((error, subproc, labeled))
934 self._bufferstates.append((error, subproc, labeled))
928 self._bufferapplylabels = labeled
935 self._bufferapplylabels = labeled
929
936
930 def popbuffer(self):
937 def popbuffer(self):
931 '''pop the last buffer and return the buffered output'''
938 '''pop the last buffer and return the buffered output'''
932 self._bufferstates.pop()
939 self._bufferstates.pop()
933 if self._bufferstates:
940 if self._bufferstates:
934 self._bufferapplylabels = self._bufferstates[-1][2]
941 self._bufferapplylabels = self._bufferstates[-1][2]
935 else:
942 else:
936 self._bufferapplylabels = None
943 self._bufferapplylabels = None
937
944
938 return "".join(self._buffers.pop())
945 return "".join(self._buffers.pop())
939
946
940 def _isbuffered(self, dest):
947 def _isbuffered(self, dest):
941 if dest is self._fout:
948 if dest is self._fout:
942 return bool(self._buffers)
949 return bool(self._buffers)
943 if dest is self._ferr:
950 if dest is self._ferr:
944 return bool(self._bufferstates and self._bufferstates[-1][0])
951 return bool(self._bufferstates and self._bufferstates[-1][0])
945 return False
952 return False
946
953
947 def canwritewithoutlabels(self):
954 def canwritewithoutlabels(self):
948 '''check if write skips the label'''
955 '''check if write skips the label'''
949 if self._buffers and not self._bufferapplylabels:
956 if self._buffers and not self._bufferapplylabels:
950 return True
957 return True
951 return self._colormode is None
958 return self._colormode is None
952
959
953 def canbatchlabeledwrites(self):
960 def canbatchlabeledwrites(self):
954 '''check if write calls with labels are batchable'''
961 '''check if write calls with labels are batchable'''
955 # Windows color printing is special, see ``write``.
962 # Windows color printing is special, see ``write``.
956 return self._colormode != 'win32'
963 return self._colormode != 'win32'
957
964
958 def write(self, *args, **opts):
965 def write(self, *args, **opts):
959 '''write args to output
966 '''write args to output
960
967
961 By default, this method simply writes to the buffer or stdout.
968 By default, this method simply writes to the buffer or stdout.
962 Color mode can be set on the UI class to have the output decorated
969 Color mode can be set on the UI class to have the output decorated
963 with color modifier before being written to stdout.
970 with color modifier before being written to stdout.
964
971
965 The color used is controlled by an optional keyword argument, "label".
972 The color used is controlled by an optional keyword argument, "label".
966 This should be a string containing label names separated by space.
973 This should be a string containing label names separated by space.
967 Label names take the form of "topic.type". For example, ui.debug()
974 Label names take the form of "topic.type". For example, ui.debug()
968 issues a label of "ui.debug".
975 issues a label of "ui.debug".
969
976
970 When labeling output for a specific command, a label of
977 When labeling output for a specific command, a label of
971 "cmdname.type" is recommended. For example, status issues
978 "cmdname.type" is recommended. For example, status issues
972 a label of "status.modified" for modified files.
979 a label of "status.modified" for modified files.
973 '''
980 '''
974 self._write(self._fout, *args, **opts)
981 self._write(self._fout, *args, **opts)
975
982
976 def write_err(self, *args, **opts):
983 def write_err(self, *args, **opts):
977 self._write(self._ferr, *args, **opts)
984 self._write(self._ferr, *args, **opts)
978
985
979 def _write(self, dest, *args, **opts):
986 def _write(self, dest, *args, **opts):
980 if self._isbuffered(dest):
987 if self._isbuffered(dest):
981 if self._bufferapplylabels:
988 if self._bufferapplylabels:
982 label = opts.get(r'label', '')
989 label = opts.get(r'label', '')
983 self._buffers[-1].extend(self.label(a, label) for a in args)
990 self._buffers[-1].extend(self.label(a, label) for a in args)
984 else:
991 else:
985 self._buffers[-1].extend(args)
992 self._buffers[-1].extend(args)
986 else:
993 else:
987 self._writenobuf(dest, *args, **opts)
994 self._writenobuf(dest, *args, **opts)
988
995
989 def _writenobuf(self, dest, *args, **opts):
996 def _writenobuf(self, dest, *args, **opts):
990 self._progclear()
997 self._progclear()
991 msg = b''.join(args)
998 msg = b''.join(args)
992
999
993 # opencode timeblockedsection because this is a critical path
1000 # opencode timeblockedsection because this is a critical path
994 starttime = util.timer()
1001 starttime = util.timer()
995 try:
1002 try:
996 if dest is self._ferr and not getattr(self._fout, 'closed', False):
1003 if dest is self._ferr and not getattr(self._fout, 'closed', False):
997 self._fout.flush()
1004 self._fout.flush()
998 if self._colormode == 'win32':
1005 if self._colormode == 'win32':
999 # windows color printing is its own can of crab, defer to
1006 # windows color printing is its own can of crab, defer to
1000 # the color module and that is it.
1007 # the color module and that is it.
1001 color.win32print(self, dest.write, msg, **opts)
1008 color.win32print(self, dest.write, msg, **opts)
1002 else:
1009 else:
1003 if self._colormode is not None:
1010 if self._colormode is not None:
1004 label = opts.get(r'label', '')
1011 label = opts.get(r'label', '')
1005 msg = self.label(msg, label)
1012 msg = self.label(msg, label)
1006 dest.write(msg)
1013 dest.write(msg)
1007 # stderr may be buffered under win32 when redirected to files,
1014 # stderr may be buffered under win32 when redirected to files,
1008 # including stdout.
1015 # including stdout.
1009 if dest is self._ferr and not getattr(self._ferr, 'closed', False):
1016 if dest is self._ferr and not getattr(self._ferr, 'closed', False):
1010 dest.flush()
1017 dest.flush()
1011 except IOError as err:
1018 except IOError as err:
1012 if (dest is self._ferr
1019 if (dest is self._ferr
1013 and err.errno in (errno.EPIPE, errno.EIO, errno.EBADF)):
1020 and err.errno in (errno.EPIPE, errno.EIO, errno.EBADF)):
1014 # no way to report the error, so ignore it
1021 # no way to report the error, so ignore it
1015 return
1022 return
1016 raise error.StdioError(err)
1023 raise error.StdioError(err)
1017 finally:
1024 finally:
1018 self._blockedtimes['stdio_blocked'] += \
1025 self._blockedtimes['stdio_blocked'] += \
1019 (util.timer() - starttime) * 1000
1026 (util.timer() - starttime) * 1000
1020
1027
1021 def flush(self):
1028 def flush(self):
1022 # opencode timeblockedsection because this is a critical path
1029 # opencode timeblockedsection because this is a critical path
1023 starttime = util.timer()
1030 starttime = util.timer()
1024 try:
1031 try:
1025 try:
1032 try:
1026 self._fout.flush()
1033 self._fout.flush()
1027 except IOError as err:
1034 except IOError as err:
1028 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1035 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1029 raise error.StdioError(err)
1036 raise error.StdioError(err)
1030 finally:
1037 finally:
1031 try:
1038 try:
1032 self._ferr.flush()
1039 self._ferr.flush()
1033 except IOError as err:
1040 except IOError as err:
1034 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1041 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1035 raise error.StdioError(err)
1042 raise error.StdioError(err)
1036 finally:
1043 finally:
1037 self._blockedtimes['stdio_blocked'] += \
1044 self._blockedtimes['stdio_blocked'] += \
1038 (util.timer() - starttime) * 1000
1045 (util.timer() - starttime) * 1000
1039
1046
1040 def _isatty(self, fh):
1047 def _isatty(self, fh):
1041 if self.configbool('ui', 'nontty'):
1048 if self.configbool('ui', 'nontty'):
1042 return False
1049 return False
1043 return procutil.isatty(fh)
1050 return procutil.isatty(fh)
1044
1051
1045 def disablepager(self):
1052 def disablepager(self):
1046 self._disablepager = True
1053 self._disablepager = True
1047
1054
1048 def pager(self, command):
1055 def pager(self, command):
1049 """Start a pager for subsequent command output.
1056 """Start a pager for subsequent command output.
1050
1057
1051 Commands which produce a long stream of output should call
1058 Commands which produce a long stream of output should call
1052 this function to activate the user's preferred pagination
1059 this function to activate the user's preferred pagination
1053 mechanism (which may be no pager). Calling this function
1060 mechanism (which may be no pager). Calling this function
1054 precludes any future use of interactive functionality, such as
1061 precludes any future use of interactive functionality, such as
1055 prompting the user or activating curses.
1062 prompting the user or activating curses.
1056
1063
1057 Args:
1064 Args:
1058 command: The full, non-aliased name of the command. That is, "log"
1065 command: The full, non-aliased name of the command. That is, "log"
1059 not "history, "summary" not "summ", etc.
1066 not "history, "summary" not "summ", etc.
1060 """
1067 """
1061 if (self._disablepager
1068 if (self._disablepager
1062 or self.pageractive):
1069 or self.pageractive):
1063 # how pager should do is already determined
1070 # how pager should do is already determined
1064 return
1071 return
1065
1072
1066 if not command.startswith('internal-always-') and (
1073 if not command.startswith('internal-always-') and (
1067 # explicit --pager=on (= 'internal-always-' prefix) should
1074 # explicit --pager=on (= 'internal-always-' prefix) should
1068 # take precedence over disabling factors below
1075 # take precedence over disabling factors below
1069 command in self.configlist('pager', 'ignore')
1076 command in self.configlist('pager', 'ignore')
1070 or not self.configbool('ui', 'paginate')
1077 or not self.configbool('ui', 'paginate')
1071 or not self.configbool('pager', 'attend-' + command, True)
1078 or not self.configbool('pager', 'attend-' + command, True)
1072 or encoding.environ.get('TERM') == 'dumb'
1079 or encoding.environ.get('TERM') == 'dumb'
1073 # TODO: if we want to allow HGPLAINEXCEPT=pager,
1080 # TODO: if we want to allow HGPLAINEXCEPT=pager,
1074 # formatted() will need some adjustment.
1081 # formatted() will need some adjustment.
1075 or not self.formatted()
1082 or not self.formatted()
1076 or self.plain()
1083 or self.plain()
1077 or self._buffers
1084 or self._buffers
1078 # TODO: expose debugger-enabled on the UI object
1085 # TODO: expose debugger-enabled on the UI object
1079 or '--debugger' in pycompat.sysargv):
1086 or '--debugger' in pycompat.sysargv):
1080 # We only want to paginate if the ui appears to be
1087 # We only want to paginate if the ui appears to be
1081 # interactive, the user didn't say HGPLAIN or
1088 # interactive, the user didn't say HGPLAIN or
1082 # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
1089 # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
1083 return
1090 return
1084
1091
1085 pagercmd = self.config('pager', 'pager', rcutil.fallbackpager)
1092 pagercmd = self.config('pager', 'pager', rcutil.fallbackpager)
1086 if not pagercmd:
1093 if not pagercmd:
1087 return
1094 return
1088
1095
1089 pagerenv = {}
1096 pagerenv = {}
1090 for name, value in rcutil.defaultpagerenv().items():
1097 for name, value in rcutil.defaultpagerenv().items():
1091 if name not in encoding.environ:
1098 if name not in encoding.environ:
1092 pagerenv[name] = value
1099 pagerenv[name] = value
1093
1100
1094 self.debug('starting pager for command %s\n' %
1101 self.debug('starting pager for command %s\n' %
1095 stringutil.pprint(command))
1102 stringutil.pprint(command))
1096 self.flush()
1103 self.flush()
1097
1104
1098 wasformatted = self.formatted()
1105 wasformatted = self.formatted()
1099 if util.safehasattr(signal, "SIGPIPE"):
1106 if util.safehasattr(signal, "SIGPIPE"):
1100 signal.signal(signal.SIGPIPE, _catchterm)
1107 signal.signal(signal.SIGPIPE, _catchterm)
1101 if self._runpager(pagercmd, pagerenv):
1108 if self._runpager(pagercmd, pagerenv):
1102 self.pageractive = True
1109 self.pageractive = True
1103 # Preserve the formatted-ness of the UI. This is important
1110 # Preserve the formatted-ness of the UI. This is important
1104 # because we mess with stdout, which might confuse
1111 # because we mess with stdout, which might confuse
1105 # auto-detection of things being formatted.
1112 # auto-detection of things being formatted.
1106 self.setconfig('ui', 'formatted', wasformatted, 'pager')
1113 self.setconfig('ui', 'formatted', wasformatted, 'pager')
1107 self.setconfig('ui', 'interactive', False, 'pager')
1114 self.setconfig('ui', 'interactive', False, 'pager')
1108
1115
1109 # If pagermode differs from color.mode, reconfigure color now that
1116 # If pagermode differs from color.mode, reconfigure color now that
1110 # pageractive is set.
1117 # pageractive is set.
1111 cm = self._colormode
1118 cm = self._colormode
1112 if cm != self.config('color', 'pagermode', cm):
1119 if cm != self.config('color', 'pagermode', cm):
1113 color.setup(self)
1120 color.setup(self)
1114 else:
1121 else:
1115 # If the pager can't be spawned in dispatch when --pager=on is
1122 # If the pager can't be spawned in dispatch when --pager=on is
1116 # given, don't try again when the command runs, to avoid a duplicate
1123 # given, don't try again when the command runs, to avoid a duplicate
1117 # warning about a missing pager command.
1124 # warning about a missing pager command.
1118 self.disablepager()
1125 self.disablepager()
1119
1126
1120 def _runpager(self, command, env=None):
1127 def _runpager(self, command, env=None):
1121 """Actually start the pager and set up file descriptors.
1128 """Actually start the pager and set up file descriptors.
1122
1129
1123 This is separate in part so that extensions (like chg) can
1130 This is separate in part so that extensions (like chg) can
1124 override how a pager is invoked.
1131 override how a pager is invoked.
1125 """
1132 """
1126 if command == 'cat':
1133 if command == 'cat':
1127 # Save ourselves some work.
1134 # Save ourselves some work.
1128 return False
1135 return False
1129 # If the command doesn't contain any of these characters, we
1136 # If the command doesn't contain any of these characters, we
1130 # assume it's a binary and exec it directly. This means for
1137 # assume it's a binary and exec it directly. This means for
1131 # simple pager command configurations, we can degrade
1138 # simple pager command configurations, we can degrade
1132 # gracefully and tell the user about their broken pager.
1139 # gracefully and tell the user about their broken pager.
1133 shell = any(c in command for c in "|&;<>()$`\\\"' \t\n*?[#~=%")
1140 shell = any(c in command for c in "|&;<>()$`\\\"' \t\n*?[#~=%")
1134
1141
1135 if pycompat.iswindows and not shell:
1142 if pycompat.iswindows and not shell:
1136 # Window's built-in `more` cannot be invoked with shell=False, but
1143 # Window's built-in `more` cannot be invoked with shell=False, but
1137 # its `more.com` can. Hide this implementation detail from the
1144 # its `more.com` can. Hide this implementation detail from the
1138 # user so we can also get sane bad PAGER behavior. MSYS has
1145 # user so we can also get sane bad PAGER behavior. MSYS has
1139 # `more.exe`, so do a cmd.exe style resolution of the executable to
1146 # `more.exe`, so do a cmd.exe style resolution of the executable to
1140 # determine which one to use.
1147 # determine which one to use.
1141 fullcmd = procutil.findexe(command)
1148 fullcmd = procutil.findexe(command)
1142 if not fullcmd:
1149 if not fullcmd:
1143 self.warn(_("missing pager command '%s', skipping pager\n")
1150 self.warn(_("missing pager command '%s', skipping pager\n")
1144 % command)
1151 % command)
1145 return False
1152 return False
1146
1153
1147 command = fullcmd
1154 command = fullcmd
1148
1155
1149 try:
1156 try:
1150 pager = subprocess.Popen(
1157 pager = subprocess.Popen(
1151 procutil.tonativestr(command), shell=shell, bufsize=-1,
1158 procutil.tonativestr(command), shell=shell, bufsize=-1,
1152 close_fds=procutil.closefds, stdin=subprocess.PIPE,
1159 close_fds=procutil.closefds, stdin=subprocess.PIPE,
1153 stdout=procutil.stdout, stderr=procutil.stderr,
1160 stdout=procutil.stdout, stderr=procutil.stderr,
1154 env=procutil.tonativeenv(procutil.shellenviron(env)))
1161 env=procutil.tonativeenv(procutil.shellenviron(env)))
1155 except OSError as e:
1162 except OSError as e:
1156 if e.errno == errno.ENOENT and not shell:
1163 if e.errno == errno.ENOENT and not shell:
1157 self.warn(_("missing pager command '%s', skipping pager\n")
1164 self.warn(_("missing pager command '%s', skipping pager\n")
1158 % command)
1165 % command)
1159 return False
1166 return False
1160 raise
1167 raise
1161
1168
1162 # back up original file descriptors
1169 # back up original file descriptors
1163 stdoutfd = os.dup(procutil.stdout.fileno())
1170 stdoutfd = os.dup(procutil.stdout.fileno())
1164 stderrfd = os.dup(procutil.stderr.fileno())
1171 stderrfd = os.dup(procutil.stderr.fileno())
1165
1172
1166 os.dup2(pager.stdin.fileno(), procutil.stdout.fileno())
1173 os.dup2(pager.stdin.fileno(), procutil.stdout.fileno())
1167 if self._isatty(procutil.stderr):
1174 if self._isatty(procutil.stderr):
1168 os.dup2(pager.stdin.fileno(), procutil.stderr.fileno())
1175 os.dup2(pager.stdin.fileno(), procutil.stderr.fileno())
1169
1176
1170 @self.atexit
1177 @self.atexit
1171 def killpager():
1178 def killpager():
1172 if util.safehasattr(signal, "SIGINT"):
1179 if util.safehasattr(signal, "SIGINT"):
1173 signal.signal(signal.SIGINT, signal.SIG_IGN)
1180 signal.signal(signal.SIGINT, signal.SIG_IGN)
1174 # restore original fds, closing pager.stdin copies in the process
1181 # restore original fds, closing pager.stdin copies in the process
1175 os.dup2(stdoutfd, procutil.stdout.fileno())
1182 os.dup2(stdoutfd, procutil.stdout.fileno())
1176 os.dup2(stderrfd, procutil.stderr.fileno())
1183 os.dup2(stderrfd, procutil.stderr.fileno())
1177 pager.stdin.close()
1184 pager.stdin.close()
1178 pager.wait()
1185 pager.wait()
1179
1186
1180 return True
1187 return True
1181
1188
1182 @property
1189 @property
1183 def _exithandlers(self):
1190 def _exithandlers(self):
1184 return _reqexithandlers
1191 return _reqexithandlers
1185
1192
1186 def atexit(self, func, *args, **kwargs):
1193 def atexit(self, func, *args, **kwargs):
1187 '''register a function to run after dispatching a request
1194 '''register a function to run after dispatching a request
1188
1195
1189 Handlers do not stay registered across request boundaries.'''
1196 Handlers do not stay registered across request boundaries.'''
1190 self._exithandlers.append((func, args, kwargs))
1197 self._exithandlers.append((func, args, kwargs))
1191 return func
1198 return func
1192
1199
1193 def interface(self, feature):
1200 def interface(self, feature):
1194 """what interface to use for interactive console features?
1201 """what interface to use for interactive console features?
1195
1202
1196 The interface is controlled by the value of `ui.interface` but also by
1203 The interface is controlled by the value of `ui.interface` but also by
1197 the value of feature-specific configuration. For example:
1204 the value of feature-specific configuration. For example:
1198
1205
1199 ui.interface.histedit = text
1206 ui.interface.histedit = text
1200 ui.interface.chunkselector = curses
1207 ui.interface.chunkselector = curses
1201
1208
1202 Here the features are "histedit" and "chunkselector".
1209 Here the features are "histedit" and "chunkselector".
1203
1210
1204 The configuration above means that the default interfaces for commands
1211 The configuration above means that the default interfaces for commands
1205 is curses, the interface for histedit is text and the interface for
1212 is curses, the interface for histedit is text and the interface for
1206 selecting chunk is crecord (the best curses interface available).
1213 selecting chunk is crecord (the best curses interface available).
1207
1214
1208 Consider the following example:
1215 Consider the following example:
1209 ui.interface = curses
1216 ui.interface = curses
1210 ui.interface.histedit = text
1217 ui.interface.histedit = text
1211
1218
1212 Then histedit will use the text interface and chunkselector will use
1219 Then histedit will use the text interface and chunkselector will use
1213 the default curses interface (crecord at the moment).
1220 the default curses interface (crecord at the moment).
1214 """
1221 """
1215 alldefaults = frozenset(["text", "curses"])
1222 alldefaults = frozenset(["text", "curses"])
1216
1223
1217 featureinterfaces = {
1224 featureinterfaces = {
1218 "chunkselector": [
1225 "chunkselector": [
1219 "text",
1226 "text",
1220 "curses",
1227 "curses",
1221 ]
1228 ]
1222 }
1229 }
1223
1230
1224 # Feature-specific interface
1231 # Feature-specific interface
1225 if feature not in featureinterfaces.keys():
1232 if feature not in featureinterfaces.keys():
1226 # Programming error, not user error
1233 # Programming error, not user error
1227 raise ValueError("Unknown feature requested %s" % feature)
1234 raise ValueError("Unknown feature requested %s" % feature)
1228
1235
1229 availableinterfaces = frozenset(featureinterfaces[feature])
1236 availableinterfaces = frozenset(featureinterfaces[feature])
1230 if alldefaults > availableinterfaces:
1237 if alldefaults > availableinterfaces:
1231 # Programming error, not user error. We need a use case to
1238 # Programming error, not user error. We need a use case to
1232 # define the right thing to do here.
1239 # define the right thing to do here.
1233 raise ValueError(
1240 raise ValueError(
1234 "Feature %s does not handle all default interfaces" %
1241 "Feature %s does not handle all default interfaces" %
1235 feature)
1242 feature)
1236
1243
1237 if self.plain() or encoding.environ.get('TERM') == 'dumb':
1244 if self.plain() or encoding.environ.get('TERM') == 'dumb':
1238 return "text"
1245 return "text"
1239
1246
1240 # Default interface for all the features
1247 # Default interface for all the features
1241 defaultinterface = "text"
1248 defaultinterface = "text"
1242 i = self.config("ui", "interface")
1249 i = self.config("ui", "interface")
1243 if i in alldefaults:
1250 if i in alldefaults:
1244 defaultinterface = i
1251 defaultinterface = i
1245
1252
1246 choseninterface = defaultinterface
1253 choseninterface = defaultinterface
1247 f = self.config("ui", "interface.%s" % feature)
1254 f = self.config("ui", "interface.%s" % feature)
1248 if f in availableinterfaces:
1255 if f in availableinterfaces:
1249 choseninterface = f
1256 choseninterface = f
1250
1257
1251 if i is not None and defaultinterface != i:
1258 if i is not None and defaultinterface != i:
1252 if f is not None:
1259 if f is not None:
1253 self.warn(_("invalid value for ui.interface: %s\n") %
1260 self.warn(_("invalid value for ui.interface: %s\n") %
1254 (i,))
1261 (i,))
1255 else:
1262 else:
1256 self.warn(_("invalid value for ui.interface: %s (using %s)\n") %
1263 self.warn(_("invalid value for ui.interface: %s (using %s)\n") %
1257 (i, choseninterface))
1264 (i, choseninterface))
1258 if f is not None and choseninterface != f:
1265 if f is not None and choseninterface != f:
1259 self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") %
1266 self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") %
1260 (feature, f, choseninterface))
1267 (feature, f, choseninterface))
1261
1268
1262 return choseninterface
1269 return choseninterface
1263
1270
1264 def interactive(self):
1271 def interactive(self):
1265 '''is interactive input allowed?
1272 '''is interactive input allowed?
1266
1273
1267 An interactive session is a session where input can be reasonably read
1274 An interactive session is a session where input can be reasonably read
1268 from `sys.stdin'. If this function returns false, any attempt to read
1275 from `sys.stdin'. If this function returns false, any attempt to read
1269 from stdin should fail with an error, unless a sensible default has been
1276 from stdin should fail with an error, unless a sensible default has been
1270 specified.
1277 specified.
1271
1278
1272 Interactiveness is triggered by the value of the `ui.interactive'
1279 Interactiveness is triggered by the value of the `ui.interactive'
1273 configuration variable or - if it is unset - when `sys.stdin' points
1280 configuration variable or - if it is unset - when `sys.stdin' points
1274 to a terminal device.
1281 to a terminal device.
1275
1282
1276 This function refers to input only; for output, see `ui.formatted()'.
1283 This function refers to input only; for output, see `ui.formatted()'.
1277 '''
1284 '''
1278 i = self.configbool("ui", "interactive")
1285 i = self.configbool("ui", "interactive")
1279 if i is None:
1286 if i is None:
1280 # some environments replace stdin without implementing isatty
1287 # some environments replace stdin without implementing isatty
1281 # usually those are non-interactive
1288 # usually those are non-interactive
1282 return self._isatty(self._fin)
1289 return self._isatty(self._fin)
1283
1290
1284 return i
1291 return i
1285
1292
1286 def termwidth(self):
1293 def termwidth(self):
1287 '''how wide is the terminal in columns?
1294 '''how wide is the terminal in columns?
1288 '''
1295 '''
1289 if 'COLUMNS' in encoding.environ:
1296 if 'COLUMNS' in encoding.environ:
1290 try:
1297 try:
1291 return int(encoding.environ['COLUMNS'])
1298 return int(encoding.environ['COLUMNS'])
1292 except ValueError:
1299 except ValueError:
1293 pass
1300 pass
1294 return scmutil.termsize(self)[0]
1301 return scmutil.termsize(self)[0]
1295
1302
1296 def formatted(self):
1303 def formatted(self):
1297 '''should formatted output be used?
1304 '''should formatted output be used?
1298
1305
1299 It is often desirable to format the output to suite the output medium.
1306 It is often desirable to format the output to suite the output medium.
1300 Examples of this are truncating long lines or colorizing messages.
1307 Examples of this are truncating long lines or colorizing messages.
1301 However, this is not often not desirable when piping output into other
1308 However, this is not often not desirable when piping output into other
1302 utilities, e.g. `grep'.
1309 utilities, e.g. `grep'.
1303
1310
1304 Formatted output is triggered by the value of the `ui.formatted'
1311 Formatted output is triggered by the value of the `ui.formatted'
1305 configuration variable or - if it is unset - when `sys.stdout' points
1312 configuration variable or - if it is unset - when `sys.stdout' points
1306 to a terminal device. Please note that `ui.formatted' should be
1313 to a terminal device. Please note that `ui.formatted' should be
1307 considered an implementation detail; it is not intended for use outside
1314 considered an implementation detail; it is not intended for use outside
1308 Mercurial or its extensions.
1315 Mercurial or its extensions.
1309
1316
1310 This function refers to output only; for input, see `ui.interactive()'.
1317 This function refers to output only; for input, see `ui.interactive()'.
1311 This function always returns false when in plain mode, see `ui.plain()'.
1318 This function always returns false when in plain mode, see `ui.plain()'.
1312 '''
1319 '''
1313 if self.plain():
1320 if self.plain():
1314 return False
1321 return False
1315
1322
1316 i = self.configbool("ui", "formatted")
1323 i = self.configbool("ui", "formatted")
1317 if i is None:
1324 if i is None:
1318 # some environments replace stdout without implementing isatty
1325 # some environments replace stdout without implementing isatty
1319 # usually those are non-interactive
1326 # usually those are non-interactive
1320 return self._isatty(self._fout)
1327 return self._isatty(self._fout)
1321
1328
1322 return i
1329 return i
1323
1330
1324 def _readline(self):
1331 def _readline(self):
1325 # Replacing stdin/stdout temporarily is a hard problem on Python 3
1332 # Replacing stdin/stdout temporarily is a hard problem on Python 3
1326 # because they have to be text streams with *no buffering*. Instead,
1333 # because they have to be text streams with *no buffering*. Instead,
1327 # we use rawinput() only if call_readline() will be invoked by
1334 # we use rawinput() only if call_readline() will be invoked by
1328 # PyOS_Readline(), so no I/O will be made at Python layer.
1335 # PyOS_Readline(), so no I/O will be made at Python layer.
1329 usereadline = (self._isatty(self._fin) and self._isatty(self._fout)
1336 usereadline = (self._isatty(self._fin) and self._isatty(self._fout)
1330 and procutil.isstdin(self._fin)
1337 and procutil.isstdin(self._fin)
1331 and procutil.isstdout(self._fout))
1338 and procutil.isstdout(self._fout))
1332 if usereadline:
1339 if usereadline:
1333 try:
1340 try:
1334 # magically add command line editing support, where
1341 # magically add command line editing support, where
1335 # available
1342 # available
1336 import readline
1343 import readline
1337 # force demandimport to really load the module
1344 # force demandimport to really load the module
1338 readline.read_history_file
1345 readline.read_history_file
1339 # windows sometimes raises something other than ImportError
1346 # windows sometimes raises something other than ImportError
1340 except Exception:
1347 except Exception:
1341 usereadline = False
1348 usereadline = False
1342
1349
1343 # prompt ' ' must exist; otherwise readline may delete entire line
1350 # prompt ' ' must exist; otherwise readline may delete entire line
1344 # - http://bugs.python.org/issue12833
1351 # - http://bugs.python.org/issue12833
1345 with self.timeblockedsection('stdio'):
1352 with self.timeblockedsection('stdio'):
1346 if usereadline:
1353 if usereadline:
1347 line = encoding.strtolocal(pycompat.rawinput(r' '))
1354 line = encoding.strtolocal(pycompat.rawinput(r' '))
1348 # When stdin is in binary mode on Windows, it can cause
1355 # When stdin is in binary mode on Windows, it can cause
1349 # raw_input() to emit an extra trailing carriage return
1356 # raw_input() to emit an extra trailing carriage return
1350 if pycompat.oslinesep == b'\r\n' and line.endswith(b'\r'):
1357 if pycompat.oslinesep == b'\r\n' and line.endswith(b'\r'):
1351 line = line[:-1]
1358 line = line[:-1]
1352 else:
1359 else:
1353 self._fout.write(b' ')
1360 self._fout.write(b' ')
1354 self._fout.flush()
1361 self._fout.flush()
1355 line = self._fin.readline()
1362 line = self._fin.readline()
1356 if not line:
1363 if not line:
1357 raise EOFError
1364 raise EOFError
1358 line = line.rstrip(pycompat.oslinesep)
1365 line = line.rstrip(pycompat.oslinesep)
1359
1366
1360 return line
1367 return line
1361
1368
1362 def prompt(self, msg, default="y"):
1369 def prompt(self, msg, default="y"):
1363 """Prompt user with msg, read response.
1370 """Prompt user with msg, read response.
1364 If ui is not interactive, the default is returned.
1371 If ui is not interactive, the default is returned.
1365 """
1372 """
1366 if not self.interactive():
1373 if not self.interactive():
1367 self.write(msg, ' ', label='ui.prompt')
1374 self._write(self._fmsgout, msg, ' ', label='ui.prompt')
1368 self.write(default or '', "\n", label='ui.promptecho')
1375 self._write(self._fmsgout, default or '', "\n",
1376 label='ui.promptecho')
1369 return default
1377 return default
1370 self._writenobuf(self._fout, msg, label='ui.prompt')
1378 self._writenobuf(self._fmsgout, msg, label='ui.prompt')
1371 self.flush()
1379 self.flush()
1372 try:
1380 try:
1373 r = self._readline()
1381 r = self._readline()
1374 if not r:
1382 if not r:
1375 r = default
1383 r = default
1376 if self.configbool('ui', 'promptecho'):
1384 if self.configbool('ui', 'promptecho'):
1377 self.write(r, "\n", label='ui.promptecho')
1385 self._write(self._fmsgout, r, "\n", label='ui.promptecho')
1378 return r
1386 return r
1379 except EOFError:
1387 except EOFError:
1380 raise error.ResponseExpected()
1388 raise error.ResponseExpected()
1381
1389
1382 @staticmethod
1390 @staticmethod
1383 def extractchoices(prompt):
1391 def extractchoices(prompt):
1384 """Extract prompt message and list of choices from specified prompt.
1392 """Extract prompt message and list of choices from specified prompt.
1385
1393
1386 This returns tuple "(message, choices)", and "choices" is the
1394 This returns tuple "(message, choices)", and "choices" is the
1387 list of tuple "(response character, text without &)".
1395 list of tuple "(response character, text without &)".
1388
1396
1389 >>> ui.extractchoices(b"awake? $$ &Yes $$ &No")
1397 >>> ui.extractchoices(b"awake? $$ &Yes $$ &No")
1390 ('awake? ', [('y', 'Yes'), ('n', 'No')])
1398 ('awake? ', [('y', 'Yes'), ('n', 'No')])
1391 >>> ui.extractchoices(b"line\\nbreak? $$ &Yes $$ &No")
1399 >>> ui.extractchoices(b"line\\nbreak? $$ &Yes $$ &No")
1392 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
1400 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
1393 >>> ui.extractchoices(b"want lots of $$money$$?$$Ye&s$$N&o")
1401 >>> ui.extractchoices(b"want lots of $$money$$?$$Ye&s$$N&o")
1394 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
1402 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
1395 """
1403 """
1396
1404
1397 # Sadly, the prompt string may have been built with a filename
1405 # Sadly, the prompt string may have been built with a filename
1398 # containing "$$" so let's try to find the first valid-looking
1406 # containing "$$" so let's try to find the first valid-looking
1399 # prompt to start parsing. Sadly, we also can't rely on
1407 # prompt to start parsing. Sadly, we also can't rely on
1400 # choices containing spaces, ASCII, or basically anything
1408 # choices containing spaces, ASCII, or basically anything
1401 # except an ampersand followed by a character.
1409 # except an ampersand followed by a character.
1402 m = re.match(br'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
1410 m = re.match(br'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
1403 msg = m.group(1)
1411 msg = m.group(1)
1404 choices = [p.strip(' ') for p in m.group(2).split('$$')]
1412 choices = [p.strip(' ') for p in m.group(2).split('$$')]
1405 def choicetuple(s):
1413 def choicetuple(s):
1406 ampidx = s.index('&')
1414 ampidx = s.index('&')
1407 return s[ampidx + 1:ampidx + 2].lower(), s.replace('&', '', 1)
1415 return s[ampidx + 1:ampidx + 2].lower(), s.replace('&', '', 1)
1408 return (msg, [choicetuple(s) for s in choices])
1416 return (msg, [choicetuple(s) for s in choices])
1409
1417
1410 def promptchoice(self, prompt, default=0):
1418 def promptchoice(self, prompt, default=0):
1411 """Prompt user with a message, read response, and ensure it matches
1419 """Prompt user with a message, read response, and ensure it matches
1412 one of the provided choices. The prompt is formatted as follows:
1420 one of the provided choices. The prompt is formatted as follows:
1413
1421
1414 "would you like fries with that (Yn)? $$ &Yes $$ &No"
1422 "would you like fries with that (Yn)? $$ &Yes $$ &No"
1415
1423
1416 The index of the choice is returned. Responses are case
1424 The index of the choice is returned. Responses are case
1417 insensitive. If ui is not interactive, the default is
1425 insensitive. If ui is not interactive, the default is
1418 returned.
1426 returned.
1419 """
1427 """
1420
1428
1421 msg, choices = self.extractchoices(prompt)
1429 msg, choices = self.extractchoices(prompt)
1422 resps = [r for r, t in choices]
1430 resps = [r for r, t in choices]
1423 while True:
1431 while True:
1424 r = self.prompt(msg, resps[default])
1432 r = self.prompt(msg, resps[default])
1425 if r.lower() in resps:
1433 if r.lower() in resps:
1426 return resps.index(r.lower())
1434 return resps.index(r.lower())
1427 self.write(_("unrecognized response\n"))
1435 # TODO: shouldn't it be a warning?
1436 self._write(self._fmsgout, _("unrecognized response\n"))
1428
1437
1429 def getpass(self, prompt=None, default=None):
1438 def getpass(self, prompt=None, default=None):
1430 if not self.interactive():
1439 if not self.interactive():
1431 return default
1440 return default
1432 try:
1441 try:
1433 self.write_err(self.label(prompt or _('password: '), 'ui.prompt'))
1442 self._write(self._fmsgerr, prompt or _('password: '),
1443 label='ui.prompt')
1434 # disable getpass() only if explicitly specified. it's still valid
1444 # disable getpass() only if explicitly specified. it's still valid
1435 # to interact with tty even if fin is not a tty.
1445 # to interact with tty even if fin is not a tty.
1436 with self.timeblockedsection('stdio'):
1446 with self.timeblockedsection('stdio'):
1437 if self.configbool('ui', 'nontty'):
1447 if self.configbool('ui', 'nontty'):
1438 l = self._fin.readline()
1448 l = self._fin.readline()
1439 if not l:
1449 if not l:
1440 raise EOFError
1450 raise EOFError
1441 return l.rstrip('\n')
1451 return l.rstrip('\n')
1442 else:
1452 else:
1443 return getpass.getpass('')
1453 return getpass.getpass('')
1444 except EOFError:
1454 except EOFError:
1445 raise error.ResponseExpected()
1455 raise error.ResponseExpected()
1446
1456
1447 def status(self, *msg, **opts):
1457 def status(self, *msg, **opts):
1448 '''write status message to output (if ui.quiet is False)
1458 '''write status message to output (if ui.quiet is False)
1449
1459
1450 This adds an output label of "ui.status".
1460 This adds an output label of "ui.status".
1451 '''
1461 '''
1452 if not self.quiet:
1462 if not self.quiet:
1453 opts[r'label'] = opts.get(r'label', '') + ' ui.status'
1463 opts[r'label'] = opts.get(r'label', '') + ' ui.status'
1454 self.write(*msg, **opts)
1464 self._write(self._fmsgout, *msg, **opts)
1455
1465
1456 def warn(self, *msg, **opts):
1466 def warn(self, *msg, **opts):
1457 '''write warning message to output (stderr)
1467 '''write warning message to output (stderr)
1458
1468
1459 This adds an output label of "ui.warning".
1469 This adds an output label of "ui.warning".
1460 '''
1470 '''
1461 opts[r'label'] = opts.get(r'label', '') + ' ui.warning'
1471 opts[r'label'] = opts.get(r'label', '') + ' ui.warning'
1462 self.write_err(*msg, **opts)
1472 self._write(self._fmsgerr, *msg, **opts)
1463
1473
1464 def error(self, *msg, **opts):
1474 def error(self, *msg, **opts):
1465 '''write error message to output (stderr)
1475 '''write error message to output (stderr)
1466
1476
1467 This adds an output label of "ui.error".
1477 This adds an output label of "ui.error".
1468 '''
1478 '''
1469 opts[r'label'] = opts.get(r'label', '') + ' ui.error'
1479 opts[r'label'] = opts.get(r'label', '') + ' ui.error'
1470 self.write_err(*msg, **opts)
1480 self._write(self._fmsgerr, *msg, **opts)
1471
1481
1472 def note(self, *msg, **opts):
1482 def note(self, *msg, **opts):
1473 '''write note to output (if ui.verbose is True)
1483 '''write note to output (if ui.verbose is True)
1474
1484
1475 This adds an output label of "ui.note".
1485 This adds an output label of "ui.note".
1476 '''
1486 '''
1477 if self.verbose:
1487 if self.verbose:
1478 opts[r'label'] = opts.get(r'label', '') + ' ui.note'
1488 opts[r'label'] = opts.get(r'label', '') + ' ui.note'
1479 self.write(*msg, **opts)
1489 self._write(self._fmsgout, *msg, **opts)
1480
1490
1481 def debug(self, *msg, **opts):
1491 def debug(self, *msg, **opts):
1482 '''write debug message to output (if ui.debugflag is True)
1492 '''write debug message to output (if ui.debugflag is True)
1483
1493
1484 This adds an output label of "ui.debug".
1494 This adds an output label of "ui.debug".
1485 '''
1495 '''
1486 if self.debugflag:
1496 if self.debugflag:
1487 opts[r'label'] = opts.get(r'label', '') + ' ui.debug'
1497 opts[r'label'] = opts.get(r'label', '') + ' ui.debug'
1488 self.write(*msg, **opts)
1498 self._write(self._fmsgout, *msg, **opts)
1489
1499
1490 def edit(self, text, user, extra=None, editform=None, pending=None,
1500 def edit(self, text, user, extra=None, editform=None, pending=None,
1491 repopath=None, action=None):
1501 repopath=None, action=None):
1492 if action is None:
1502 if action is None:
1493 self.develwarn('action is None but will soon be a required '
1503 self.develwarn('action is None but will soon be a required '
1494 'parameter to ui.edit()')
1504 'parameter to ui.edit()')
1495 extra_defaults = {
1505 extra_defaults = {
1496 'prefix': 'editor',
1506 'prefix': 'editor',
1497 'suffix': '.txt',
1507 'suffix': '.txt',
1498 }
1508 }
1499 if extra is not None:
1509 if extra is not None:
1500 if extra.get('suffix') is not None:
1510 if extra.get('suffix') is not None:
1501 self.develwarn('extra.suffix is not None but will soon be '
1511 self.develwarn('extra.suffix is not None but will soon be '
1502 'ignored by ui.edit()')
1512 'ignored by ui.edit()')
1503 extra_defaults.update(extra)
1513 extra_defaults.update(extra)
1504 extra = extra_defaults
1514 extra = extra_defaults
1505
1515
1506 if action == 'diff':
1516 if action == 'diff':
1507 suffix = '.diff'
1517 suffix = '.diff'
1508 elif action:
1518 elif action:
1509 suffix = '.%s.hg.txt' % action
1519 suffix = '.%s.hg.txt' % action
1510 else:
1520 else:
1511 suffix = extra['suffix']
1521 suffix = extra['suffix']
1512
1522
1513 rdir = None
1523 rdir = None
1514 if self.configbool('experimental', 'editortmpinhg'):
1524 if self.configbool('experimental', 'editortmpinhg'):
1515 rdir = repopath
1525 rdir = repopath
1516 (fd, name) = pycompat.mkstemp(prefix='hg-' + extra['prefix'] + '-',
1526 (fd, name) = pycompat.mkstemp(prefix='hg-' + extra['prefix'] + '-',
1517 suffix=suffix,
1527 suffix=suffix,
1518 dir=rdir)
1528 dir=rdir)
1519 try:
1529 try:
1520 f = os.fdopen(fd, r'wb')
1530 f = os.fdopen(fd, r'wb')
1521 f.write(util.tonativeeol(text))
1531 f.write(util.tonativeeol(text))
1522 f.close()
1532 f.close()
1523
1533
1524 environ = {'HGUSER': user}
1534 environ = {'HGUSER': user}
1525 if 'transplant_source' in extra:
1535 if 'transplant_source' in extra:
1526 environ.update({'HGREVISION': hex(extra['transplant_source'])})
1536 environ.update({'HGREVISION': hex(extra['transplant_source'])})
1527 for label in ('intermediate-source', 'source', 'rebase_source'):
1537 for label in ('intermediate-source', 'source', 'rebase_source'):
1528 if label in extra:
1538 if label in extra:
1529 environ.update({'HGREVISION': extra[label]})
1539 environ.update({'HGREVISION': extra[label]})
1530 break
1540 break
1531 if editform:
1541 if editform:
1532 environ.update({'HGEDITFORM': editform})
1542 environ.update({'HGEDITFORM': editform})
1533 if pending:
1543 if pending:
1534 environ.update({'HG_PENDING': pending})
1544 environ.update({'HG_PENDING': pending})
1535
1545
1536 editor = self.geteditor()
1546 editor = self.geteditor()
1537
1547
1538 self.system("%s \"%s\"" % (editor, name),
1548 self.system("%s \"%s\"" % (editor, name),
1539 environ=environ,
1549 environ=environ,
1540 onerr=error.Abort, errprefix=_("edit failed"),
1550 onerr=error.Abort, errprefix=_("edit failed"),
1541 blockedtag='editor')
1551 blockedtag='editor')
1542
1552
1543 f = open(name, r'rb')
1553 f = open(name, r'rb')
1544 t = util.fromnativeeol(f.read())
1554 t = util.fromnativeeol(f.read())
1545 f.close()
1555 f.close()
1546 finally:
1556 finally:
1547 os.unlink(name)
1557 os.unlink(name)
1548
1558
1549 return t
1559 return t
1550
1560
1551 def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None,
1561 def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None,
1552 blockedtag=None):
1562 blockedtag=None):
1553 '''execute shell command with appropriate output stream. command
1563 '''execute shell command with appropriate output stream. command
1554 output will be redirected if fout is not stdout.
1564 output will be redirected if fout is not stdout.
1555
1565
1556 if command fails and onerr is None, return status, else raise onerr
1566 if command fails and onerr is None, return status, else raise onerr
1557 object as exception.
1567 object as exception.
1558 '''
1568 '''
1559 if blockedtag is None:
1569 if blockedtag is None:
1560 # Long cmds tend to be because of an absolute path on cmd. Keep
1570 # Long cmds tend to be because of an absolute path on cmd. Keep
1561 # the tail end instead
1571 # the tail end instead
1562 cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
1572 cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
1563 blockedtag = 'unknown_system_' + cmdsuffix
1573 blockedtag = 'unknown_system_' + cmdsuffix
1564 out = self._fout
1574 out = self._fout
1565 if any(s[1] for s in self._bufferstates):
1575 if any(s[1] for s in self._bufferstates):
1566 out = self
1576 out = self
1567 with self.timeblockedsection(blockedtag):
1577 with self.timeblockedsection(blockedtag):
1568 rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
1578 rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
1569 if rc and onerr:
1579 if rc and onerr:
1570 errmsg = '%s %s' % (os.path.basename(cmd.split(None, 1)[0]),
1580 errmsg = '%s %s' % (os.path.basename(cmd.split(None, 1)[0]),
1571 procutil.explainexit(rc))
1581 procutil.explainexit(rc))
1572 if errprefix:
1582 if errprefix:
1573 errmsg = '%s: %s' % (errprefix, errmsg)
1583 errmsg = '%s: %s' % (errprefix, errmsg)
1574 raise onerr(errmsg)
1584 raise onerr(errmsg)
1575 return rc
1585 return rc
1576
1586
1577 def _runsystem(self, cmd, environ, cwd, out):
1587 def _runsystem(self, cmd, environ, cwd, out):
1578 """actually execute the given shell command (can be overridden by
1588 """actually execute the given shell command (can be overridden by
1579 extensions like chg)"""
1589 extensions like chg)"""
1580 return procutil.system(cmd, environ=environ, cwd=cwd, out=out)
1590 return procutil.system(cmd, environ=environ, cwd=cwd, out=out)
1581
1591
1582 def traceback(self, exc=None, force=False):
1592 def traceback(self, exc=None, force=False):
1583 '''print exception traceback if traceback printing enabled or forced.
1593 '''print exception traceback if traceback printing enabled or forced.
1584 only to call in exception handler. returns true if traceback
1594 only to call in exception handler. returns true if traceback
1585 printed.'''
1595 printed.'''
1586 if self.tracebackflag or force:
1596 if self.tracebackflag or force:
1587 if exc is None:
1597 if exc is None:
1588 exc = sys.exc_info()
1598 exc = sys.exc_info()
1589 cause = getattr(exc[1], 'cause', None)
1599 cause = getattr(exc[1], 'cause', None)
1590
1600
1591 if cause is not None:
1601 if cause is not None:
1592 causetb = traceback.format_tb(cause[2])
1602 causetb = traceback.format_tb(cause[2])
1593 exctb = traceback.format_tb(exc[2])
1603 exctb = traceback.format_tb(exc[2])
1594 exconly = traceback.format_exception_only(cause[0], cause[1])
1604 exconly = traceback.format_exception_only(cause[0], cause[1])
1595
1605
1596 # exclude frame where 'exc' was chained and rethrown from exctb
1606 # exclude frame where 'exc' was chained and rethrown from exctb
1597 self.write_err('Traceback (most recent call last):\n',
1607 self.write_err('Traceback (most recent call last):\n',
1598 ''.join(exctb[:-1]),
1608 ''.join(exctb[:-1]),
1599 ''.join(causetb),
1609 ''.join(causetb),
1600 ''.join(exconly))
1610 ''.join(exconly))
1601 else:
1611 else:
1602 output = traceback.format_exception(exc[0], exc[1], exc[2])
1612 output = traceback.format_exception(exc[0], exc[1], exc[2])
1603 self.write_err(encoding.strtolocal(r''.join(output)))
1613 self.write_err(encoding.strtolocal(r''.join(output)))
1604 return self.tracebackflag or force
1614 return self.tracebackflag or force
1605
1615
1606 def geteditor(self):
1616 def geteditor(self):
1607 '''return editor to use'''
1617 '''return editor to use'''
1608 if pycompat.sysplatform == 'plan9':
1618 if pycompat.sysplatform == 'plan9':
1609 # vi is the MIPS instruction simulator on Plan 9. We
1619 # vi is the MIPS instruction simulator on Plan 9. We
1610 # instead default to E to plumb commit messages to
1620 # instead default to E to plumb commit messages to
1611 # avoid confusion.
1621 # avoid confusion.
1612 editor = 'E'
1622 editor = 'E'
1613 else:
1623 else:
1614 editor = 'vi'
1624 editor = 'vi'
1615 return (encoding.environ.get("HGEDITOR") or
1625 return (encoding.environ.get("HGEDITOR") or
1616 self.config("ui", "editor", editor))
1626 self.config("ui", "editor", editor))
1617
1627
1618 @util.propertycache
1628 @util.propertycache
1619 def _progbar(self):
1629 def _progbar(self):
1620 """setup the progbar singleton to the ui object"""
1630 """setup the progbar singleton to the ui object"""
1621 if (self.quiet or self.debugflag
1631 if (self.quiet or self.debugflag
1622 or self.configbool('progress', 'disable')
1632 or self.configbool('progress', 'disable')
1623 or not progress.shouldprint(self)):
1633 or not progress.shouldprint(self)):
1624 return None
1634 return None
1625 return getprogbar(self)
1635 return getprogbar(self)
1626
1636
1627 def _progclear(self):
1637 def _progclear(self):
1628 """clear progress bar output if any. use it before any output"""
1638 """clear progress bar output if any. use it before any output"""
1629 if not haveprogbar(): # nothing loaded yet
1639 if not haveprogbar(): # nothing loaded yet
1630 return
1640 return
1631 if self._progbar is not None and self._progbar.printed:
1641 if self._progbar is not None and self._progbar.printed:
1632 self._progbar.clear()
1642 self._progbar.clear()
1633
1643
1634 def progress(self, topic, pos, item="", unit="", total=None):
1644 def progress(self, topic, pos, item="", unit="", total=None):
1635 '''show a progress message
1645 '''show a progress message
1636
1646
1637 By default a textual progress bar will be displayed if an operation
1647 By default a textual progress bar will be displayed if an operation
1638 takes too long. 'topic' is the current operation, 'item' is a
1648 takes too long. 'topic' is the current operation, 'item' is a
1639 non-numeric marker of the current position (i.e. the currently
1649 non-numeric marker of the current position (i.e. the currently
1640 in-process file), 'pos' is the current numeric position (i.e.
1650 in-process file), 'pos' is the current numeric position (i.e.
1641 revision, bytes, etc.), unit is a corresponding unit label,
1651 revision, bytes, etc.), unit is a corresponding unit label,
1642 and total is the highest expected pos.
1652 and total is the highest expected pos.
1643
1653
1644 Multiple nested topics may be active at a time.
1654 Multiple nested topics may be active at a time.
1645
1655
1646 All topics should be marked closed by setting pos to None at
1656 All topics should be marked closed by setting pos to None at
1647 termination.
1657 termination.
1648 '''
1658 '''
1649 if self._progbar is not None:
1659 if self._progbar is not None:
1650 self._progbar.progress(topic, pos, item=item, unit=unit,
1660 self._progbar.progress(topic, pos, item=item, unit=unit,
1651 total=total)
1661 total=total)
1652 if pos is None or not self.configbool('progress', 'debug'):
1662 if pos is None or not self.configbool('progress', 'debug'):
1653 return
1663 return
1654
1664
1655 if unit:
1665 if unit:
1656 unit = ' ' + unit
1666 unit = ' ' + unit
1657 if item:
1667 if item:
1658 item = ' ' + item
1668 item = ' ' + item
1659
1669
1660 if total:
1670 if total:
1661 pct = 100.0 * pos / total
1671 pct = 100.0 * pos / total
1662 self.debug('%s:%s %d/%d%s (%4.2f%%)\n'
1672 self.debug('%s:%s %d/%d%s (%4.2f%%)\n'
1663 % (topic, item, pos, total, unit, pct))
1673 % (topic, item, pos, total, unit, pct))
1664 else:
1674 else:
1665 self.debug('%s:%s %d%s\n' % (topic, item, pos, unit))
1675 self.debug('%s:%s %d%s\n' % (topic, item, pos, unit))
1666
1676
1667 def makeprogress(self, topic, unit="", total=None):
1677 def makeprogress(self, topic, unit="", total=None):
1668 '''exists only so low-level modules won't need to import scmutil'''
1678 '''exists only so low-level modules won't need to import scmutil'''
1669 return scmutil.progress(self, topic, unit, total)
1679 return scmutil.progress(self, topic, unit, total)
1670
1680
1671 def log(self, service, *msg, **opts):
1681 def log(self, service, *msg, **opts):
1672 '''hook for logging facility extensions
1682 '''hook for logging facility extensions
1673
1683
1674 service should be a readily-identifiable subsystem, which will
1684 service should be a readily-identifiable subsystem, which will
1675 allow filtering.
1685 allow filtering.
1676
1686
1677 *msg should be a newline-terminated format string to log, and
1687 *msg should be a newline-terminated format string to log, and
1678 then any values to %-format into that format string.
1688 then any values to %-format into that format string.
1679
1689
1680 **opts currently has no defined meanings.
1690 **opts currently has no defined meanings.
1681 '''
1691 '''
1682
1692
1683 def label(self, msg, label):
1693 def label(self, msg, label):
1684 '''style msg based on supplied label
1694 '''style msg based on supplied label
1685
1695
1686 If some color mode is enabled, this will add the necessary control
1696 If some color mode is enabled, this will add the necessary control
1687 characters to apply such color. In addition, 'debug' color mode adds
1697 characters to apply such color. In addition, 'debug' color mode adds
1688 markup showing which label affects a piece of text.
1698 markup showing which label affects a piece of text.
1689
1699
1690 ui.write(s, 'label') is equivalent to
1700 ui.write(s, 'label') is equivalent to
1691 ui.write(ui.label(s, 'label')).
1701 ui.write(ui.label(s, 'label')).
1692 '''
1702 '''
1693 if self._colormode is not None:
1703 if self._colormode is not None:
1694 return color.colorlabel(self, msg, label)
1704 return color.colorlabel(self, msg, label)
1695 return msg
1705 return msg
1696
1706
1697 def develwarn(self, msg, stacklevel=1, config=None):
1707 def develwarn(self, msg, stacklevel=1, config=None):
1698 """issue a developer warning message
1708 """issue a developer warning message
1699
1709
1700 Use 'stacklevel' to report the offender some layers further up in the
1710 Use 'stacklevel' to report the offender some layers further up in the
1701 stack.
1711 stack.
1702 """
1712 """
1703 if not self.configbool('devel', 'all-warnings'):
1713 if not self.configbool('devel', 'all-warnings'):
1704 if config is None or not self.configbool('devel', config):
1714 if config is None or not self.configbool('devel', config):
1705 return
1715 return
1706 msg = 'devel-warn: ' + msg
1716 msg = 'devel-warn: ' + msg
1707 stacklevel += 1 # get in develwarn
1717 stacklevel += 1 # get in develwarn
1708 if self.tracebackflag:
1718 if self.tracebackflag:
1709 util.debugstacktrace(msg, stacklevel, self._ferr, self._fout)
1719 util.debugstacktrace(msg, stacklevel, self._ferr, self._fout)
1710 self.log('develwarn', '%s at:\n%s' %
1720 self.log('develwarn', '%s at:\n%s' %
1711 (msg, ''.join(util.getstackframes(stacklevel))))
1721 (msg, ''.join(util.getstackframes(stacklevel))))
1712 else:
1722 else:
1713 curframe = inspect.currentframe()
1723 curframe = inspect.currentframe()
1714 calframe = inspect.getouterframes(curframe, 2)
1724 calframe = inspect.getouterframes(curframe, 2)
1715 fname, lineno, fmsg = calframe[stacklevel][1:4]
1725 fname, lineno, fmsg = calframe[stacklevel][1:4]
1716 fname, fmsg = pycompat.sysbytes(fname), pycompat.sysbytes(fmsg)
1726 fname, fmsg = pycompat.sysbytes(fname), pycompat.sysbytes(fmsg)
1717 self.write_err('%s at: %s:%d (%s)\n'
1727 self.write_err('%s at: %s:%d (%s)\n'
1718 % (msg, fname, lineno, fmsg))
1728 % (msg, fname, lineno, fmsg))
1719 self.log('develwarn', '%s at: %s:%d (%s)\n',
1729 self.log('develwarn', '%s at: %s:%d (%s)\n',
1720 msg, fname, lineno, fmsg)
1730 msg, fname, lineno, fmsg)
1721 curframe = calframe = None # avoid cycles
1731 curframe = calframe = None # avoid cycles
1722
1732
1723 def deprecwarn(self, msg, version, stacklevel=2):
1733 def deprecwarn(self, msg, version, stacklevel=2):
1724 """issue a deprecation warning
1734 """issue a deprecation warning
1725
1735
1726 - msg: message explaining what is deprecated and how to upgrade,
1736 - msg: message explaining what is deprecated and how to upgrade,
1727 - version: last version where the API will be supported,
1737 - version: last version where the API will be supported,
1728 """
1738 """
1729 if not (self.configbool('devel', 'all-warnings')
1739 if not (self.configbool('devel', 'all-warnings')
1730 or self.configbool('devel', 'deprec-warn')):
1740 or self.configbool('devel', 'deprec-warn')):
1731 return
1741 return
1732 msg += ("\n(compatibility will be dropped after Mercurial-%s,"
1742 msg += ("\n(compatibility will be dropped after Mercurial-%s,"
1733 " update your code.)") % version
1743 " update your code.)") % version
1734 self.develwarn(msg, stacklevel=stacklevel, config='deprec-warn')
1744 self.develwarn(msg, stacklevel=stacklevel, config='deprec-warn')
1735
1745
1736 def exportableenviron(self):
1746 def exportableenviron(self):
1737 """The environment variables that are safe to export, e.g. through
1747 """The environment variables that are safe to export, e.g. through
1738 hgweb.
1748 hgweb.
1739 """
1749 """
1740 return self._exportableenviron
1750 return self._exportableenviron
1741
1751
1742 @contextlib.contextmanager
1752 @contextlib.contextmanager
1743 def configoverride(self, overrides, source=""):
1753 def configoverride(self, overrides, source=""):
1744 """Context manager for temporary config overrides
1754 """Context manager for temporary config overrides
1745 `overrides` must be a dict of the following structure:
1755 `overrides` must be a dict of the following structure:
1746 {(section, name) : value}"""
1756 {(section, name) : value}"""
1747 backups = {}
1757 backups = {}
1748 try:
1758 try:
1749 for (section, name), value in overrides.items():
1759 for (section, name), value in overrides.items():
1750 backups[(section, name)] = self.backupconfig(section, name)
1760 backups[(section, name)] = self.backupconfig(section, name)
1751 self.setconfig(section, name, value, source)
1761 self.setconfig(section, name, value, source)
1752 yield
1762 yield
1753 finally:
1763 finally:
1754 for __, backup in backups.items():
1764 for __, backup in backups.items():
1755 self.restoreconfig(backup)
1765 self.restoreconfig(backup)
1756 # just restoring ui.quiet config to the previous value is not enough
1766 # just restoring ui.quiet config to the previous value is not enough
1757 # as it does not update ui.quiet class member
1767 # as it does not update ui.quiet class member
1758 if ('ui', 'quiet') in overrides:
1768 if ('ui', 'quiet') in overrides:
1759 self.fixconfig(section='ui')
1769 self.fixconfig(section='ui')
1760
1770
1761 class paths(dict):
1771 class paths(dict):
1762 """Represents a collection of paths and their configs.
1772 """Represents a collection of paths and their configs.
1763
1773
1764 Data is initially derived from ui instances and the config files they have
1774 Data is initially derived from ui instances and the config files they have
1765 loaded.
1775 loaded.
1766 """
1776 """
1767 def __init__(self, ui):
1777 def __init__(self, ui):
1768 dict.__init__(self)
1778 dict.__init__(self)
1769
1779
1770 for name, loc in ui.configitems('paths', ignoresub=True):
1780 for name, loc in ui.configitems('paths', ignoresub=True):
1771 # No location is the same as not existing.
1781 # No location is the same as not existing.
1772 if not loc:
1782 if not loc:
1773 continue
1783 continue
1774 loc, sub = ui.configsuboptions('paths', name)
1784 loc, sub = ui.configsuboptions('paths', name)
1775 self[name] = path(ui, name, rawloc=loc, suboptions=sub)
1785 self[name] = path(ui, name, rawloc=loc, suboptions=sub)
1776
1786
1777 def getpath(self, name, default=None):
1787 def getpath(self, name, default=None):
1778 """Return a ``path`` from a string, falling back to default.
1788 """Return a ``path`` from a string, falling back to default.
1779
1789
1780 ``name`` can be a named path or locations. Locations are filesystem
1790 ``name`` can be a named path or locations. Locations are filesystem
1781 paths or URIs.
1791 paths or URIs.
1782
1792
1783 Returns None if ``name`` is not a registered path, a URI, or a local
1793 Returns None if ``name`` is not a registered path, a URI, or a local
1784 path to a repo.
1794 path to a repo.
1785 """
1795 """
1786 # Only fall back to default if no path was requested.
1796 # Only fall back to default if no path was requested.
1787 if name is None:
1797 if name is None:
1788 if not default:
1798 if not default:
1789 default = ()
1799 default = ()
1790 elif not isinstance(default, (tuple, list)):
1800 elif not isinstance(default, (tuple, list)):
1791 default = (default,)
1801 default = (default,)
1792 for k in default:
1802 for k in default:
1793 try:
1803 try:
1794 return self[k]
1804 return self[k]
1795 except KeyError:
1805 except KeyError:
1796 continue
1806 continue
1797 return None
1807 return None
1798
1808
1799 # Most likely empty string.
1809 # Most likely empty string.
1800 # This may need to raise in the future.
1810 # This may need to raise in the future.
1801 if not name:
1811 if not name:
1802 return None
1812 return None
1803
1813
1804 try:
1814 try:
1805 return self[name]
1815 return self[name]
1806 except KeyError:
1816 except KeyError:
1807 # Try to resolve as a local path or URI.
1817 # Try to resolve as a local path or URI.
1808 try:
1818 try:
1809 # We don't pass sub-options in, so no need to pass ui instance.
1819 # We don't pass sub-options in, so no need to pass ui instance.
1810 return path(None, None, rawloc=name)
1820 return path(None, None, rawloc=name)
1811 except ValueError:
1821 except ValueError:
1812 raise error.RepoError(_('repository %s does not exist') %
1822 raise error.RepoError(_('repository %s does not exist') %
1813 name)
1823 name)
1814
1824
1815 _pathsuboptions = {}
1825 _pathsuboptions = {}
1816
1826
1817 def pathsuboption(option, attr):
1827 def pathsuboption(option, attr):
1818 """Decorator used to declare a path sub-option.
1828 """Decorator used to declare a path sub-option.
1819
1829
1820 Arguments are the sub-option name and the attribute it should set on
1830 Arguments are the sub-option name and the attribute it should set on
1821 ``path`` instances.
1831 ``path`` instances.
1822
1832
1823 The decorated function will receive as arguments a ``ui`` instance,
1833 The decorated function will receive as arguments a ``ui`` instance,
1824 ``path`` instance, and the string value of this option from the config.
1834 ``path`` instance, and the string value of this option from the config.
1825 The function should return the value that will be set on the ``path``
1835 The function should return the value that will be set on the ``path``
1826 instance.
1836 instance.
1827
1837
1828 This decorator can be used to perform additional verification of
1838 This decorator can be used to perform additional verification of
1829 sub-options and to change the type of sub-options.
1839 sub-options and to change the type of sub-options.
1830 """
1840 """
1831 def register(func):
1841 def register(func):
1832 _pathsuboptions[option] = (attr, func)
1842 _pathsuboptions[option] = (attr, func)
1833 return func
1843 return func
1834 return register
1844 return register
1835
1845
1836 @pathsuboption('pushurl', 'pushloc')
1846 @pathsuboption('pushurl', 'pushloc')
1837 def pushurlpathoption(ui, path, value):
1847 def pushurlpathoption(ui, path, value):
1838 u = util.url(value)
1848 u = util.url(value)
1839 # Actually require a URL.
1849 # Actually require a URL.
1840 if not u.scheme:
1850 if not u.scheme:
1841 ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
1851 ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
1842 return None
1852 return None
1843
1853
1844 # Don't support the #foo syntax in the push URL to declare branch to
1854 # Don't support the #foo syntax in the push URL to declare branch to
1845 # push.
1855 # push.
1846 if u.fragment:
1856 if u.fragment:
1847 ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
1857 ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
1848 'ignoring)\n') % path.name)
1858 'ignoring)\n') % path.name)
1849 u.fragment = None
1859 u.fragment = None
1850
1860
1851 return bytes(u)
1861 return bytes(u)
1852
1862
1853 @pathsuboption('pushrev', 'pushrev')
1863 @pathsuboption('pushrev', 'pushrev')
1854 def pushrevpathoption(ui, path, value):
1864 def pushrevpathoption(ui, path, value):
1855 return value
1865 return value
1856
1866
1857 class path(object):
1867 class path(object):
1858 """Represents an individual path and its configuration."""
1868 """Represents an individual path and its configuration."""
1859
1869
1860 def __init__(self, ui, name, rawloc=None, suboptions=None):
1870 def __init__(self, ui, name, rawloc=None, suboptions=None):
1861 """Construct a path from its config options.
1871 """Construct a path from its config options.
1862
1872
1863 ``ui`` is the ``ui`` instance the path is coming from.
1873 ``ui`` is the ``ui`` instance the path is coming from.
1864 ``name`` is the symbolic name of the path.
1874 ``name`` is the symbolic name of the path.
1865 ``rawloc`` is the raw location, as defined in the config.
1875 ``rawloc`` is the raw location, as defined in the config.
1866 ``pushloc`` is the raw locations pushes should be made to.
1876 ``pushloc`` is the raw locations pushes should be made to.
1867
1877
1868 If ``name`` is not defined, we require that the location be a) a local
1878 If ``name`` is not defined, we require that the location be a) a local
1869 filesystem path with a .hg directory or b) a URL. If not,
1879 filesystem path with a .hg directory or b) a URL. If not,
1870 ``ValueError`` is raised.
1880 ``ValueError`` is raised.
1871 """
1881 """
1872 if not rawloc:
1882 if not rawloc:
1873 raise ValueError('rawloc must be defined')
1883 raise ValueError('rawloc must be defined')
1874
1884
1875 # Locations may define branches via syntax <base>#<branch>.
1885 # Locations may define branches via syntax <base>#<branch>.
1876 u = util.url(rawloc)
1886 u = util.url(rawloc)
1877 branch = None
1887 branch = None
1878 if u.fragment:
1888 if u.fragment:
1879 branch = u.fragment
1889 branch = u.fragment
1880 u.fragment = None
1890 u.fragment = None
1881
1891
1882 self.url = u
1892 self.url = u
1883 self.branch = branch
1893 self.branch = branch
1884
1894
1885 self.name = name
1895 self.name = name
1886 self.rawloc = rawloc
1896 self.rawloc = rawloc
1887 self.loc = '%s' % u
1897 self.loc = '%s' % u
1888
1898
1889 # When given a raw location but not a symbolic name, validate the
1899 # When given a raw location but not a symbolic name, validate the
1890 # location is valid.
1900 # location is valid.
1891 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
1901 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
1892 raise ValueError('location is not a URL or path to a local '
1902 raise ValueError('location is not a URL or path to a local '
1893 'repo: %s' % rawloc)
1903 'repo: %s' % rawloc)
1894
1904
1895 suboptions = suboptions or {}
1905 suboptions = suboptions or {}
1896
1906
1897 # Now process the sub-options. If a sub-option is registered, its
1907 # Now process the sub-options. If a sub-option is registered, its
1898 # attribute will always be present. The value will be None if there
1908 # attribute will always be present. The value will be None if there
1899 # was no valid sub-option.
1909 # was no valid sub-option.
1900 for suboption, (attr, func) in _pathsuboptions.iteritems():
1910 for suboption, (attr, func) in _pathsuboptions.iteritems():
1901 if suboption not in suboptions:
1911 if suboption not in suboptions:
1902 setattr(self, attr, None)
1912 setattr(self, attr, None)
1903 continue
1913 continue
1904
1914
1905 value = func(ui, self, suboptions[suboption])
1915 value = func(ui, self, suboptions[suboption])
1906 setattr(self, attr, value)
1916 setattr(self, attr, value)
1907
1917
1908 def _isvalidlocalpath(self, path):
1918 def _isvalidlocalpath(self, path):
1909 """Returns True if the given path is a potentially valid repository.
1919 """Returns True if the given path is a potentially valid repository.
1910 This is its own function so that extensions can change the definition of
1920 This is its own function so that extensions can change the definition of
1911 'valid' in this case (like when pulling from a git repo into a hg
1921 'valid' in this case (like when pulling from a git repo into a hg
1912 one)."""
1922 one)."""
1913 return os.path.isdir(os.path.join(path, '.hg'))
1923 return os.path.isdir(os.path.join(path, '.hg'))
1914
1924
1915 @property
1925 @property
1916 def suboptions(self):
1926 def suboptions(self):
1917 """Return sub-options and their values for this path.
1927 """Return sub-options and their values for this path.
1918
1928
1919 This is intended to be used for presentation purposes.
1929 This is intended to be used for presentation purposes.
1920 """
1930 """
1921 d = {}
1931 d = {}
1922 for subopt, (attr, _func) in _pathsuboptions.iteritems():
1932 for subopt, (attr, _func) in _pathsuboptions.iteritems():
1923 value = getattr(self, attr)
1933 value = getattr(self, attr)
1924 if value is not None:
1934 if value is not None:
1925 d[subopt] = value
1935 d[subopt] = value
1926 return d
1936 return d
1927
1937
1928 # we instantiate one globally shared progress bar to avoid
1938 # we instantiate one globally shared progress bar to avoid
1929 # competing progress bars when multiple UI objects get created
1939 # competing progress bars when multiple UI objects get created
1930 _progresssingleton = None
1940 _progresssingleton = None
1931
1941
1932 def getprogbar(ui):
1942 def getprogbar(ui):
1933 global _progresssingleton
1943 global _progresssingleton
1934 if _progresssingleton is None:
1944 if _progresssingleton is None:
1935 # passing 'ui' object to the singleton is fishy,
1945 # passing 'ui' object to the singleton is fishy,
1936 # this is how the extension used to work but feel free to rework it.
1946 # this is how the extension used to work but feel free to rework it.
1937 _progresssingleton = progress.progbar(ui)
1947 _progresssingleton = progress.progbar(ui)
1938 return _progresssingleton
1948 return _progresssingleton
1939
1949
1940 def haveprogbar():
1950 def haveprogbar():
1941 return _progresssingleton is not None
1951 return _progresssingleton is not None
1952
1953 def _selectmsgdests(ui):
1954 name = ui.config(b'ui', b'message-output')
1955 if name == b'stdio':
1956 return ui.fout, ui.ferr
1957 if name == b'stderr':
1958 return ui.ferr, ui.ferr
1959 raise error.Abort(b'invalid ui.message-output destination: %s' % name)
@@ -1,104 +1,219 b''
1 Create a repository:
1 Create a repository:
2
2
3 #if no-extraextensions
3 #if no-extraextensions
4 $ hg config
4 $ hg config
5 devel.all-warnings=true
5 devel.all-warnings=true
6 devel.default-date=0 0
6 devel.default-date=0 0
7 extensions.fsmonitor= (fsmonitor !)
7 extensions.fsmonitor= (fsmonitor !)
8 largefiles.usercache=$TESTTMP/.cache/largefiles
8 largefiles.usercache=$TESTTMP/.cache/largefiles
9 lfs.usercache=$TESTTMP/.cache/lfs
9 lfs.usercache=$TESTTMP/.cache/lfs
10 ui.slash=True
10 ui.slash=True
11 ui.interactive=False
11 ui.interactive=False
12 ui.merge=internal:merge
12 ui.merge=internal:merge
13 ui.mergemarkers=detailed
13 ui.mergemarkers=detailed
14 ui.promptecho=True
14 ui.promptecho=True
15 web.address=localhost
15 web.address=localhost
16 web\.ipv6=(?:True|False) (re)
16 web\.ipv6=(?:True|False) (re)
17 web.server-header=testing stub value
17 web.server-header=testing stub value
18 #endif
18 #endif
19
19
20 $ hg init t
20 $ hg init t
21 $ cd t
21 $ cd t
22
22
23 Prepare a changeset:
23 Prepare a changeset:
24
24
25 $ echo a > a
25 $ echo a > a
26 $ hg add a
26 $ hg add a
27
27
28 $ hg status
28 $ hg status
29 A a
29 A a
30
30
31 Writes to stdio succeed and fail appropriately
31 Writes to stdio succeed and fail appropriately
32
32
33 #if devfull
33 #if devfull
34 $ hg status 2>/dev/full
34 $ hg status 2>/dev/full
35 A a
35 A a
36
36
37 $ hg status >/dev/full
37 $ hg status >/dev/full
38 abort: No space left on device
38 abort: No space left on device
39 [255]
39 [255]
40 #endif
40 #endif
41
41
42 #if devfull
42 #if devfull
43 $ hg status >/dev/full 2>&1
43 $ hg status >/dev/full 2>&1
44 [255]
44 [255]
45
45
46 $ hg status ENOENT 2>/dev/full
46 $ hg status ENOENT 2>/dev/full
47 [255]
47 [255]
48 #endif
48 #endif
49
49
50 $ hg commit -m test
50 $ hg commit -m test
51
51
52 This command is ancient:
52 This command is ancient:
53
53
54 $ hg history
54 $ hg history
55 changeset: 0:acb14030fe0a
55 changeset: 0:acb14030fe0a
56 tag: tip
56 tag: tip
57 user: test
57 user: test
58 date: Thu Jan 01 00:00:00 1970 +0000
58 date: Thu Jan 01 00:00:00 1970 +0000
59 summary: test
59 summary: test
60
60
61
61
62 Verify that updating to revision 0 via commands.update() works properly
62 Verify that updating to revision 0 via commands.update() works properly
63
63
64 $ cat <<EOF > update_to_rev0.py
64 $ cat <<EOF > update_to_rev0.py
65 > from mercurial import commands, hg, ui as uimod
65 > from mercurial import commands, hg, ui as uimod
66 > myui = uimod.ui.load()
66 > myui = uimod.ui.load()
67 > repo = hg.repository(myui, path=b'.')
67 > repo = hg.repository(myui, path=b'.')
68 > commands.update(myui, repo, rev=b"0")
68 > commands.update(myui, repo, rev=b"0")
69 > EOF
69 > EOF
70 $ hg up null
70 $ hg up null
71 0 files updated, 0 files merged, 1 files removed, 0 files unresolved
71 0 files updated, 0 files merged, 1 files removed, 0 files unresolved
72 $ "$PYTHON" ./update_to_rev0.py
72 $ "$PYTHON" ./update_to_rev0.py
73 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
73 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
74 $ hg identify -n
74 $ hg identify -n
75 0
75 0
76
76
77
77
78 Poke around at hashes:
78 Poke around at hashes:
79
79
80 $ hg manifest --debug
80 $ hg manifest --debug
81 b789fdd96dc2f3bd229c1dd8eedf0fc60e2b68e3 644 a
81 b789fdd96dc2f3bd229c1dd8eedf0fc60e2b68e3 644 a
82
82
83 $ hg cat a
83 $ hg cat a
84 a
84 a
85
85
86 Verify should succeed:
86 Verify should succeed:
87
87
88 $ hg verify
88 $ hg verify
89 checking changesets
89 checking changesets
90 checking manifests
90 checking manifests
91 crosschecking files in changesets and manifests
91 crosschecking files in changesets and manifests
92 checking files
92 checking files
93 checked 1 changesets with 1 changes to 1 files
93 checked 1 changesets with 1 changes to 1 files
94
94
95 Repository root:
95 Repository root:
96
96
97 $ hg root
97 $ hg root
98 $TESTTMP/t
98 $TESTTMP/t
99 $ hg log -l1 -T '{reporoot}\n'
99 $ hg log -l1 -T '{reporoot}\n'
100 $TESTTMP/t
100 $TESTTMP/t
101
101
102 At the end...
102 At the end...
103
103
104 $ cd ..
104 $ cd ..
105
106 Status message redirection:
107
108 $ hg init empty
109
110 status messages are sent to stdout by default:
111
112 $ hg outgoing -R t empty -Tjson 2>/dev/null
113 comparing with empty
114 searching for changes
115 [
116 {
117 "bookmarks": [],
118 "branch": "default",
119 "date": [0, 0],
120 "desc": "test",
121 "node": "acb14030fe0a21b60322c440ad2d20cf7685a376",
122 "parents": ["0000000000000000000000000000000000000000"],
123 "phase": "draft",
124 "rev": 0,
125 "tags": ["tip"],
126 "user": "test"
127 }
128 ]
129
130 which can be configured to send to stderr, so the output wouldn't be
131 interleaved:
132
133 $ cat <<'EOF' >> "$HGRCPATH"
134 > [ui]
135 > message-output = stderr
136 > EOF
137 $ hg outgoing -R t empty -Tjson 2>/dev/null
138 [
139 {
140 "bookmarks": [],
141 "branch": "default",
142 "date": [0, 0],
143 "desc": "test",
144 "node": "acb14030fe0a21b60322c440ad2d20cf7685a376",
145 "parents": ["0000000000000000000000000000000000000000"],
146 "phase": "draft",
147 "rev": 0,
148 "tags": ["tip"],
149 "user": "test"
150 }
151 ]
152 $ hg outgoing -R t empty -Tjson >/dev/null
153 comparing with empty
154 searching for changes
155
156 this option should be turned off by HGPLAIN= since it may break scripting use:
157
158 $ HGPLAIN= hg outgoing -R t empty -Tjson 2>/dev/null
159 comparing with empty
160 searching for changes
161 [
162 {
163 "bookmarks": [],
164 "branch": "default",
165 "date": [0, 0],
166 "desc": "test",
167 "node": "acb14030fe0a21b60322c440ad2d20cf7685a376",
168 "parents": ["0000000000000000000000000000000000000000"],
169 "phase": "draft",
170 "rev": 0,
171 "tags": ["tip"],
172 "user": "test"
173 }
174 ]
175
176 but still overridden by --config:
177
178 $ HGPLAIN= hg outgoing -R t empty -Tjson --config ui.message-output=stderr \
179 > 2>/dev/null
180 [
181 {
182 "bookmarks": [],
183 "branch": "default",
184 "date": [0, 0],
185 "desc": "test",
186 "node": "acb14030fe0a21b60322c440ad2d20cf7685a376",
187 "parents": ["0000000000000000000000000000000000000000"],
188 "phase": "draft",
189 "rev": 0,
190 "tags": ["tip"],
191 "user": "test"
192 }
193 ]
194
195 Invalid ui.message-output option:
196
197 $ hg log -R t --config ui.message-output=bad
198 abort: invalid ui.message-output destination: bad
199 [255]
200
201 Underlying message streams should be updated when ui.fout/ferr are set:
202
203 $ cat <<'EOF' > capui.py
204 > from mercurial import pycompat, registrar
205 > cmdtable = {}
206 > command = registrar.command(cmdtable)
207 > @command(b'capui', norepo=True)
208 > def capui(ui):
209 > out = ui.fout
210 > ui.fout = pycompat.bytesio()
211 > ui.status(b'status\n')
212 > ui.ferr = pycompat.bytesio()
213 > ui.warn(b'warn\n')
214 > out.write(b'stdout: %s' % ui.fout.getvalue())
215 > out.write(b'stderr: %s' % ui.ferr.getvalue())
216 > EOF
217 $ hg --config extensions.capui=capui.py --config ui.message-output=stdio capui
218 stdout: status
219 stderr: warn
General Comments 0
You need to be logged in to leave comments. Login now