##// END OF EJS Templates
help: minor copy editing for grammar
Matt Harbison -
r34950:ff178743 stable
parent child Browse files
Show More
@@ -1,211 +1,211 b''
1 1 # Copyright 2006, 2007 Matt Mackall <mpm@selenic.com>
2 2 #
3 3 # This software may be used and distributed according to the terms of the
4 4 # GNU General Public License version 2 or any later version.
5 5
6 6 '''share a common history between several working directories
7 7
8 8 Automatic Pooled Storage for Clones
9 9 -----------------------------------
10 10
11 11 When this extension is active, :hg:`clone` can be configured to
12 12 automatically share/pool storage across multiple clones. This
13 13 mode effectively converts :hg:`clone` to :hg:`clone` + :hg:`share`.
14 14 The benefit of using this mode is the automatic management of
15 15 store paths and intelligent pooling of related repositories.
16 16
17 17 The following ``share.`` config options influence this feature:
18 18
19 19 ``share.pool``
20 20 Filesystem path where shared repository data will be stored. When
21 21 defined, :hg:`clone` will automatically use shared repository
22 22 storage instead of creating a store inside each clone.
23 23
24 24 ``share.poolnaming``
25 25 How directory names in ``share.pool`` are constructed.
26 26
27 27 "identity" means the name is derived from the first changeset in the
28 28 repository. In this mode, different remotes share storage if their
29 29 root/initial changeset is identical. In this mode, the local shared
30 30 repository is an aggregate of all encountered remote repositories.
31 31
32 32 "remote" means the name is derived from the source repository's
33 33 path or URL. In this mode, storage is only shared if the path or URL
34 34 requested in the :hg:`clone` command matches exactly to a repository
35 35 that was cloned before.
36 36
37 The default naming mode is "identity."
37 The default naming mode is "identity".
38 38 '''
39 39
40 40 from __future__ import absolute_import
41 41
42 42 import errno
43 43 from mercurial.i18n import _
44 44 from mercurial import (
45 45 bookmarks,
46 46 commands,
47 47 error,
48 48 extensions,
49 49 hg,
50 50 registrar,
51 51 txnutil,
52 52 util,
53 53 )
54 54
55 55 repository = hg.repository
56 56 parseurl = hg.parseurl
57 57
58 58 cmdtable = {}
59 59 command = registrar.command(cmdtable)
60 60 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
61 61 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
62 62 # be specifying the version(s) of Mercurial they are tested with, or
63 63 # leave the attribute unspecified.
64 64 testedwith = 'ships-with-hg-core'
65 65
66 66 configtable = {}
67 67 configitem = registrar.configitem(configtable)
68 68
69 69 configitem('share', 'pool',
70 70 default=None,
71 71 )
72 72 configitem('share', 'poolnaming',
73 73 default='identity',
74 74 )
75 75
76 76 @command('share',
77 77 [('U', 'noupdate', None, _('do not create a working directory')),
78 78 ('B', 'bookmarks', None, _('also share bookmarks')),
79 79 ('', 'relative', None, _('point to source using a relative path '
80 80 '(EXPERIMENTAL)')),
81 81 ],
82 82 _('[-U] [-B] SOURCE [DEST]'),
83 83 norepo=True)
84 84 def share(ui, source, dest=None, noupdate=False, bookmarks=False,
85 85 relative=False):
86 86 """create a new shared repository
87 87
88 88 Initialize a new repository and working directory that shares its
89 89 history (and optionally bookmarks) with another repository.
90 90
91 91 .. note::
92 92
93 93 using rollback or extensions that destroy/modify history (mq,
94 94 rebase, etc.) can cause considerable confusion with shared
95 95 clones. In particular, if two shared clones are both updated to
96 96 the same changeset, and one of them destroys that changeset
97 97 with rollback, the other clone will suddenly stop working: all
98 98 operations will fail with "abort: working directory has unknown
99 99 parent". The only known workaround is to use debugsetparents on
100 100 the broken clone to reset it to a changeset that still exists.
101 101 """
102 102
103 103 hg.share(ui, source, dest=dest, update=not noupdate,
104 104 bookmarks=bookmarks, relative=relative)
105 105 return 0
106 106
107 107 @command('unshare', [], '')
108 108 def unshare(ui, repo):
109 109 """convert a shared repository to a normal one
110 110
111 111 Copy the store data to the repo and remove the sharedpath data.
112 112 """
113 113
114 114 if not repo.shared():
115 115 raise error.Abort(_("this is not a shared repo"))
116 116
117 117 hg.unshare(ui, repo)
118 118
119 119 # Wrap clone command to pass auto share options.
120 120 def clone(orig, ui, source, *args, **opts):
121 121 pool = ui.config('share', 'pool')
122 122 if pool:
123 123 pool = util.expandpath(pool)
124 124
125 125 opts[r'shareopts'] = {
126 126 'pool': pool,
127 127 'mode': ui.config('share', 'poolnaming'),
128 128 }
129 129
130 130 return orig(ui, source, *args, **opts)
131 131
132 132 def extsetup(ui):
133 133 extensions.wrapfunction(bookmarks, '_getbkfile', getbkfile)
134 134 extensions.wrapfunction(bookmarks.bmstore, '_recordchange', recordchange)
135 135 extensions.wrapfunction(bookmarks.bmstore, '_writerepo', writerepo)
136 136 extensions.wrapcommand(commands.table, 'clone', clone)
137 137
138 138 def _hassharedbookmarks(repo):
139 139 """Returns whether this repo has shared bookmarks"""
140 140 try:
141 141 shared = repo.vfs.read('shared').splitlines()
142 142 except IOError as inst:
143 143 if inst.errno != errno.ENOENT:
144 144 raise
145 145 return False
146 146 return hg.sharedbookmarks in shared
147 147
148 148 def _getsrcrepo(repo):
149 149 """
150 150 Returns the source repository object for a given shared repository.
151 151 If repo is not a shared repository, return None.
152 152 """
153 153 if repo.sharedpath == repo.path:
154 154 return None
155 155
156 156 if util.safehasattr(repo, 'srcrepo') and repo.srcrepo:
157 157 return repo.srcrepo
158 158
159 159 # the sharedpath always ends in the .hg; we want the path to the repo
160 160 source = repo.vfs.split(repo.sharedpath)[0]
161 161 srcurl, branches = parseurl(source)
162 162 srcrepo = repository(repo.ui, srcurl)
163 163 repo.srcrepo = srcrepo
164 164 return srcrepo
165 165
166 166 def getbkfile(orig, repo):
167 167 if _hassharedbookmarks(repo):
168 168 srcrepo = _getsrcrepo(repo)
169 169 if srcrepo is not None:
170 170 # just orig(srcrepo) doesn't work as expected, because
171 171 # HG_PENDING refers repo.root.
172 172 try:
173 173 fp, pending = txnutil.trypending(repo.root, repo.vfs,
174 174 'bookmarks')
175 175 if pending:
176 176 # only in this case, bookmark information in repo
177 177 # is up-to-date.
178 178 return fp
179 179 fp.close()
180 180 except IOError as inst:
181 181 if inst.errno != errno.ENOENT:
182 182 raise
183 183
184 184 # otherwise, we should read bookmarks from srcrepo,
185 185 # because .hg/bookmarks in srcrepo might be already
186 186 # changed via another sharing repo
187 187 repo = srcrepo
188 188
189 189 # TODO: Pending changes in repo are still invisible in
190 190 # srcrepo, because bookmarks.pending is written only into repo.
191 191 # See also https://www.mercurial-scm.org/wiki/SharedRepository
192 192 return orig(repo)
193 193
194 194 def recordchange(orig, self, tr):
195 195 # Continue with write to local bookmarks file as usual
196 196 orig(self, tr)
197 197
198 198 if _hassharedbookmarks(self._repo):
199 199 srcrepo = _getsrcrepo(self._repo)
200 200 if srcrepo is not None:
201 201 category = 'share-bookmarks'
202 202 tr.addpostclose(category, lambda tr: self._writerepo(srcrepo))
203 203
204 204 def writerepo(orig, self, repo):
205 205 # First write local bookmarks file in case we ever unshare
206 206 orig(self, repo)
207 207
208 208 if _hassharedbookmarks(self._repo):
209 209 srcrepo = _getsrcrepo(self._repo)
210 210 if srcrepo is not None:
211 211 orig(self, srcrepo)
@@ -1,5587 +1,5587 b''
1 1 # commands.py - command processing for mercurial
2 2 #
3 3 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 from __future__ import absolute_import
9 9
10 10 import difflib
11 11 import errno
12 12 import os
13 13 import re
14 14 import sys
15 15
16 16 from .i18n import _
17 17 from .node import (
18 18 hex,
19 19 nullid,
20 20 nullrev,
21 21 short,
22 22 )
23 23 from . import (
24 24 archival,
25 25 bookmarks,
26 26 bundle2,
27 27 changegroup,
28 28 cmdutil,
29 29 copies,
30 30 debugcommands as debugcommandsmod,
31 31 destutil,
32 32 dirstateguard,
33 33 discovery,
34 34 encoding,
35 35 error,
36 36 exchange,
37 37 extensions,
38 38 formatter,
39 39 graphmod,
40 40 hbisect,
41 41 help,
42 42 hg,
43 43 lock as lockmod,
44 44 merge as mergemod,
45 45 obsolete,
46 46 patch,
47 47 phases,
48 48 pycompat,
49 49 rcutil,
50 50 registrar,
51 51 revsetlang,
52 52 scmutil,
53 53 server,
54 54 sshserver,
55 55 streamclone,
56 56 tags as tagsmod,
57 57 templatekw,
58 58 ui as uimod,
59 59 util,
60 60 )
61 61
62 62 release = lockmod.release
63 63
64 64 table = {}
65 65 table.update(debugcommandsmod.command._table)
66 66
67 67 command = registrar.command(table)
68 68
69 69 # common command options
70 70
71 71 globalopts = [
72 72 ('R', 'repository', '',
73 73 _('repository root directory or name of overlay bundle file'),
74 74 _('REPO')),
75 75 ('', 'cwd', '',
76 76 _('change working directory'), _('DIR')),
77 77 ('y', 'noninteractive', None,
78 78 _('do not prompt, automatically pick the first choice for all prompts')),
79 79 ('q', 'quiet', None, _('suppress output')),
80 80 ('v', 'verbose', None, _('enable additional output')),
81 81 ('', 'color', '',
82 82 # i18n: 'always', 'auto', 'never', and 'debug' are keywords
83 83 # and should not be translated
84 84 _("when to colorize (boolean, always, auto, never, or debug)"),
85 85 _('TYPE')),
86 86 ('', 'config', [],
87 87 _('set/override config option (use \'section.name=value\')'),
88 88 _('CONFIG')),
89 89 ('', 'debug', None, _('enable debugging output')),
90 90 ('', 'debugger', None, _('start debugger')),
91 91 ('', 'encoding', encoding.encoding, _('set the charset encoding'),
92 92 _('ENCODE')),
93 93 ('', 'encodingmode', encoding.encodingmode,
94 94 _('set the charset encoding mode'), _('MODE')),
95 95 ('', 'traceback', None, _('always print a traceback on exception')),
96 96 ('', 'time', None, _('time how long the command takes')),
97 97 ('', 'profile', None, _('print command execution profile')),
98 98 ('', 'version', None, _('output version information and exit')),
99 99 ('h', 'help', None, _('display help and exit')),
100 100 ('', 'hidden', False, _('consider hidden changesets')),
101 101 ('', 'pager', 'auto',
102 102 _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
103 103 ]
104 104
105 105 dryrunopts = cmdutil.dryrunopts
106 106 remoteopts = cmdutil.remoteopts
107 107 walkopts = cmdutil.walkopts
108 108 commitopts = cmdutil.commitopts
109 109 commitopts2 = cmdutil.commitopts2
110 110 formatteropts = cmdutil.formatteropts
111 111 templateopts = cmdutil.templateopts
112 112 logopts = cmdutil.logopts
113 113 diffopts = cmdutil.diffopts
114 114 diffwsopts = cmdutil.diffwsopts
115 115 diffopts2 = cmdutil.diffopts2
116 116 mergetoolopts = cmdutil.mergetoolopts
117 117 similarityopts = cmdutil.similarityopts
118 118 subrepoopts = cmdutil.subrepoopts
119 119 debugrevlogopts = cmdutil.debugrevlogopts
120 120
121 121 # Commands start here, listed alphabetically
122 122
123 123 @command('^add',
124 124 walkopts + subrepoopts + dryrunopts,
125 125 _('[OPTION]... [FILE]...'),
126 126 inferrepo=True)
127 127 def add(ui, repo, *pats, **opts):
128 128 """add the specified files on the next commit
129 129
130 130 Schedule files to be version controlled and added to the
131 131 repository.
132 132
133 133 The files will be added to the repository at the next commit. To
134 134 undo an add before that, see :hg:`forget`.
135 135
136 136 If no names are given, add all files to the repository (except
137 137 files matching ``.hgignore``).
138 138
139 139 .. container:: verbose
140 140
141 141 Examples:
142 142
143 143 - New (unknown) files are added
144 144 automatically by :hg:`add`::
145 145
146 146 $ ls
147 147 foo.c
148 148 $ hg status
149 149 ? foo.c
150 150 $ hg add
151 151 adding foo.c
152 152 $ hg status
153 153 A foo.c
154 154
155 155 - Specific files to be added can be specified::
156 156
157 157 $ ls
158 158 bar.c foo.c
159 159 $ hg status
160 160 ? bar.c
161 161 ? foo.c
162 162 $ hg add bar.c
163 163 $ hg status
164 164 A bar.c
165 165 ? foo.c
166 166
167 167 Returns 0 if all files are successfully added.
168 168 """
169 169
170 170 m = scmutil.match(repo[None], pats, pycompat.byteskwargs(opts))
171 171 rejected = cmdutil.add(ui, repo, m, "", False, **opts)
172 172 return rejected and 1 or 0
173 173
174 174 @command('addremove',
175 175 similarityopts + subrepoopts + walkopts + dryrunopts,
176 176 _('[OPTION]... [FILE]...'),
177 177 inferrepo=True)
178 178 def addremove(ui, repo, *pats, **opts):
179 179 """add all new files, delete all missing files
180 180
181 181 Add all new files and remove all missing files from the
182 182 repository.
183 183
184 184 Unless names are given, new files are ignored if they match any of
185 185 the patterns in ``.hgignore``. As with add, these changes take
186 186 effect at the next commit.
187 187
188 188 Use the -s/--similarity option to detect renamed files. This
189 189 option takes a percentage between 0 (disabled) and 100 (files must
190 190 be identical) as its parameter. With a parameter greater than 0,
191 191 this compares every removed file with every added file and records
192 192 those similar enough as renames. Detecting renamed files this way
193 193 can be expensive. After using this option, :hg:`status -C` can be
194 194 used to check which files were identified as moved or renamed. If
195 195 not specified, -s/--similarity defaults to 100 and only renames of
196 196 identical files are detected.
197 197
198 198 .. container:: verbose
199 199
200 200 Examples:
201 201
202 202 - A number of files (bar.c and foo.c) are new,
203 203 while foobar.c has been removed (without using :hg:`remove`)
204 204 from the repository::
205 205
206 206 $ ls
207 207 bar.c foo.c
208 208 $ hg status
209 209 ! foobar.c
210 210 ? bar.c
211 211 ? foo.c
212 212 $ hg addremove
213 213 adding bar.c
214 214 adding foo.c
215 215 removing foobar.c
216 216 $ hg status
217 217 A bar.c
218 218 A foo.c
219 219 R foobar.c
220 220
221 221 - A file foobar.c was moved to foo.c without using :hg:`rename`.
222 222 Afterwards, it was edited slightly::
223 223
224 224 $ ls
225 225 foo.c
226 226 $ hg status
227 227 ! foobar.c
228 228 ? foo.c
229 229 $ hg addremove --similarity 90
230 230 removing foobar.c
231 231 adding foo.c
232 232 recording removal of foobar.c as rename to foo.c (94% similar)
233 233 $ hg status -C
234 234 A foo.c
235 235 foobar.c
236 236 R foobar.c
237 237
238 238 Returns 0 if all files are successfully added.
239 239 """
240 240 opts = pycompat.byteskwargs(opts)
241 241 try:
242 242 sim = float(opts.get('similarity') or 100)
243 243 except ValueError:
244 244 raise error.Abort(_('similarity must be a number'))
245 245 if sim < 0 or sim > 100:
246 246 raise error.Abort(_('similarity must be between 0 and 100'))
247 247 matcher = scmutil.match(repo[None], pats, opts)
248 248 return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
249 249
250 250 @command('^annotate|blame',
251 251 [('r', 'rev', '', _('annotate the specified revision'), _('REV')),
252 252 ('', 'follow', None,
253 253 _('follow copies/renames and list the filename (DEPRECATED)')),
254 254 ('', 'no-follow', None, _("don't follow copies and renames")),
255 255 ('a', 'text', None, _('treat all files as text')),
256 256 ('u', 'user', None, _('list the author (long with -v)')),
257 257 ('f', 'file', None, _('list the filename')),
258 258 ('d', 'date', None, _('list the date (short with -q)')),
259 259 ('n', 'number', None, _('list the revision number (default)')),
260 260 ('c', 'changeset', None, _('list the changeset')),
261 261 ('l', 'line-number', None, _('show line number at the first appearance')),
262 262 ('', 'skip', [], _('revision to not display (EXPERIMENTAL)'), _('REV')),
263 263 ] + diffwsopts + walkopts + formatteropts,
264 264 _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
265 265 inferrepo=True)
266 266 def annotate(ui, repo, *pats, **opts):
267 267 """show changeset information by line for each file
268 268
269 269 List changes in files, showing the revision id responsible for
270 270 each line.
271 271
272 272 This command is useful for discovering when a change was made and
273 273 by whom.
274 274
275 275 If you include --file, --user, or --date, the revision number is
276 276 suppressed unless you also include --number.
277 277
278 278 Without the -a/--text option, annotate will avoid processing files
279 279 it detects as binary. With -a, annotate will annotate the file
280 280 anyway, although the results will probably be neither useful
281 281 nor desirable.
282 282
283 283 Returns 0 on success.
284 284 """
285 285 opts = pycompat.byteskwargs(opts)
286 286 if not pats:
287 287 raise error.Abort(_('at least one filename or pattern is required'))
288 288
289 289 if opts.get('follow'):
290 290 # --follow is deprecated and now just an alias for -f/--file
291 291 # to mimic the behavior of Mercurial before version 1.5
292 292 opts['file'] = True
293 293
294 294 ctx = scmutil.revsingle(repo, opts.get('rev'))
295 295
296 296 rootfm = ui.formatter('annotate', opts)
297 297 if ui.quiet:
298 298 datefunc = util.shortdate
299 299 else:
300 300 datefunc = util.datestr
301 301 if ctx.rev() is None:
302 302 def hexfn(node):
303 303 if node is None:
304 304 return None
305 305 else:
306 306 return rootfm.hexfunc(node)
307 307 if opts.get('changeset'):
308 308 # omit "+" suffix which is appended to node hex
309 309 def formatrev(rev):
310 310 if rev is None:
311 311 return '%d' % ctx.p1().rev()
312 312 else:
313 313 return '%d' % rev
314 314 else:
315 315 def formatrev(rev):
316 316 if rev is None:
317 317 return '%d+' % ctx.p1().rev()
318 318 else:
319 319 return '%d ' % rev
320 320 def formathex(hex):
321 321 if hex is None:
322 322 return '%s+' % rootfm.hexfunc(ctx.p1().node())
323 323 else:
324 324 return '%s ' % hex
325 325 else:
326 326 hexfn = rootfm.hexfunc
327 327 formatrev = formathex = pycompat.bytestr
328 328
329 329 opmap = [('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
330 330 ('number', ' ', lambda x: x.fctx.rev(), formatrev),
331 331 ('changeset', ' ', lambda x: hexfn(x.fctx.node()), formathex),
332 332 ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
333 333 ('file', ' ', lambda x: x.fctx.path(), str),
334 334 ('line_number', ':', lambda x: x.lineno, str),
335 335 ]
336 336 fieldnamemap = {'number': 'rev', 'changeset': 'node'}
337 337
338 338 if (not opts.get('user') and not opts.get('changeset')
339 339 and not opts.get('date') and not opts.get('file')):
340 340 opts['number'] = True
341 341
342 342 linenumber = opts.get('line_number') is not None
343 343 if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
344 344 raise error.Abort(_('at least one of -n/-c is required for -l'))
345 345
346 346 ui.pager('annotate')
347 347
348 348 if rootfm.isplain():
349 349 def makefunc(get, fmt):
350 350 return lambda x: fmt(get(x))
351 351 else:
352 352 def makefunc(get, fmt):
353 353 return get
354 354 funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
355 355 if opts.get(op)]
356 356 funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
357 357 fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
358 358 if opts.get(op))
359 359
360 360 def bad(x, y):
361 361 raise error.Abort("%s: %s" % (x, y))
362 362
363 363 m = scmutil.match(ctx, pats, opts, badfn=bad)
364 364
365 365 follow = not opts.get('no_follow')
366 366 diffopts = patch.difffeatureopts(ui, opts, section='annotate',
367 367 whitespace=True)
368 368 skiprevs = opts.get('skip')
369 369 if skiprevs:
370 370 skiprevs = scmutil.revrange(repo, skiprevs)
371 371
372 372 for abs in ctx.walk(m):
373 373 fctx = ctx[abs]
374 374 rootfm.startitem()
375 375 rootfm.data(abspath=abs, path=m.rel(abs))
376 376 if not opts.get('text') and fctx.isbinary():
377 377 rootfm.plain(_("%s: binary file\n")
378 378 % ((pats and m.rel(abs)) or abs))
379 379 continue
380 380
381 381 fm = rootfm.nested('lines')
382 382 lines = fctx.annotate(follow=follow, linenumber=linenumber,
383 383 skiprevs=skiprevs, diffopts=diffopts)
384 384 if not lines:
385 385 fm.end()
386 386 continue
387 387 formats = []
388 388 pieces = []
389 389
390 390 for f, sep in funcmap:
391 391 l = [f(n) for n, dummy in lines]
392 392 if fm.isplain():
393 393 sizes = [encoding.colwidth(x) for x in l]
394 394 ml = max(sizes)
395 395 formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
396 396 else:
397 397 formats.append(['%s' for x in l])
398 398 pieces.append(l)
399 399
400 400 for f, p, l in zip(zip(*formats), zip(*pieces), lines):
401 401 fm.startitem()
402 402 fm.write(fields, "".join(f), *p)
403 403 if l[0].skip:
404 404 fmt = "* %s"
405 405 else:
406 406 fmt = ": %s"
407 407 fm.write('line', fmt, l[1])
408 408
409 409 if not lines[-1][1].endswith('\n'):
410 410 fm.plain('\n')
411 411 fm.end()
412 412
413 413 rootfm.end()
414 414
415 415 @command('archive',
416 416 [('', 'no-decode', None, _('do not pass files through decoders')),
417 417 ('p', 'prefix', '', _('directory prefix for files in archive'),
418 418 _('PREFIX')),
419 419 ('r', 'rev', '', _('revision to distribute'), _('REV')),
420 420 ('t', 'type', '', _('type of distribution to create'), _('TYPE')),
421 421 ] + subrepoopts + walkopts,
422 422 _('[OPTION]... DEST'))
423 423 def archive(ui, repo, dest, **opts):
424 424 '''create an unversioned archive of a repository revision
425 425
426 426 By default, the revision used is the parent of the working
427 427 directory; use -r/--rev to specify a different revision.
428 428
429 429 The archive type is automatically detected based on file
430 430 extension (to override, use -t/--type).
431 431
432 432 .. container:: verbose
433 433
434 434 Examples:
435 435
436 436 - create a zip file containing the 1.0 release::
437 437
438 438 hg archive -r 1.0 project-1.0.zip
439 439
440 440 - create a tarball excluding .hg files::
441 441
442 442 hg archive project.tar.gz -X ".hg*"
443 443
444 444 Valid types are:
445 445
446 446 :``files``: a directory full of files (default)
447 447 :``tar``: tar archive, uncompressed
448 448 :``tbz2``: tar archive, compressed using bzip2
449 449 :``tgz``: tar archive, compressed using gzip
450 450 :``uzip``: zip archive, uncompressed
451 451 :``zip``: zip archive, compressed using deflate
452 452
453 453 The exact name of the destination archive or directory is given
454 454 using a format string; see :hg:`help export` for details.
455 455
456 456 Each member added to an archive file has a directory prefix
457 457 prepended. Use -p/--prefix to specify a format string for the
458 458 prefix. The default is the basename of the archive, with suffixes
459 459 removed.
460 460
461 461 Returns 0 on success.
462 462 '''
463 463
464 464 opts = pycompat.byteskwargs(opts)
465 465 ctx = scmutil.revsingle(repo, opts.get('rev'))
466 466 if not ctx:
467 467 raise error.Abort(_('no working directory: please specify a revision'))
468 468 node = ctx.node()
469 469 dest = cmdutil.makefilename(repo, dest, node)
470 470 if os.path.realpath(dest) == repo.root:
471 471 raise error.Abort(_('repository root cannot be destination'))
472 472
473 473 kind = opts.get('type') or archival.guesskind(dest) or 'files'
474 474 prefix = opts.get('prefix')
475 475
476 476 if dest == '-':
477 477 if kind == 'files':
478 478 raise error.Abort(_('cannot archive plain files to stdout'))
479 479 dest = cmdutil.makefileobj(repo, dest)
480 480 if not prefix:
481 481 prefix = os.path.basename(repo.root) + '-%h'
482 482
483 483 prefix = cmdutil.makefilename(repo, prefix, node)
484 484 match = scmutil.match(ctx, [], opts)
485 485 archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
486 486 match, prefix, subrepos=opts.get('subrepos'))
487 487
488 488 @command('backout',
489 489 [('', 'merge', None, _('merge with old dirstate parent after backout')),
490 490 ('', 'commit', None,
491 491 _('commit if no conflicts were encountered (DEPRECATED)')),
492 492 ('', 'no-commit', None, _('do not commit')),
493 493 ('', 'parent', '',
494 494 _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
495 495 ('r', 'rev', '', _('revision to backout'), _('REV')),
496 496 ('e', 'edit', False, _('invoke editor on commit messages')),
497 497 ] + mergetoolopts + walkopts + commitopts + commitopts2,
498 498 _('[OPTION]... [-r] REV'))
499 499 def backout(ui, repo, node=None, rev=None, **opts):
500 500 '''reverse effect of earlier changeset
501 501
502 502 Prepare a new changeset with the effect of REV undone in the
503 503 current working directory. If no conflicts were encountered,
504 504 it will be committed immediately.
505 505
506 506 If REV is the parent of the working directory, then this new changeset
507 507 is committed automatically (unless --no-commit is specified).
508 508
509 509 .. note::
510 510
511 511 :hg:`backout` cannot be used to fix either an unwanted or
512 512 incorrect merge.
513 513
514 514 .. container:: verbose
515 515
516 516 Examples:
517 517
518 518 - Reverse the effect of the parent of the working directory.
519 519 This backout will be committed immediately::
520 520
521 521 hg backout -r .
522 522
523 523 - Reverse the effect of previous bad revision 23::
524 524
525 525 hg backout -r 23
526 526
527 527 - Reverse the effect of previous bad revision 23 and
528 528 leave changes uncommitted::
529 529
530 530 hg backout -r 23 --no-commit
531 531 hg commit -m "Backout revision 23"
532 532
533 533 By default, the pending changeset will have one parent,
534 534 maintaining a linear history. With --merge, the pending
535 535 changeset will instead have two parents: the old parent of the
536 536 working directory and a new child of REV that simply undoes REV.
537 537
538 538 Before version 1.7, the behavior without --merge was equivalent
539 539 to specifying --merge followed by :hg:`update --clean .` to
540 540 cancel the merge and leave the child of REV as a head to be
541 541 merged separately.
542 542
543 543 See :hg:`help dates` for a list of formats valid for -d/--date.
544 544
545 545 See :hg:`help revert` for a way to restore files to the state
546 546 of another revision.
547 547
548 548 Returns 0 on success, 1 if nothing to backout or there are unresolved
549 549 files.
550 550 '''
551 551 wlock = lock = None
552 552 try:
553 553 wlock = repo.wlock()
554 554 lock = repo.lock()
555 555 return _dobackout(ui, repo, node, rev, **opts)
556 556 finally:
557 557 release(lock, wlock)
558 558
559 559 def _dobackout(ui, repo, node=None, rev=None, **opts):
560 560 opts = pycompat.byteskwargs(opts)
561 561 if opts.get('commit') and opts.get('no_commit'):
562 562 raise error.Abort(_("cannot use --commit with --no-commit"))
563 563 if opts.get('merge') and opts.get('no_commit'):
564 564 raise error.Abort(_("cannot use --merge with --no-commit"))
565 565
566 566 if rev and node:
567 567 raise error.Abort(_("please specify just one revision"))
568 568
569 569 if not rev:
570 570 rev = node
571 571
572 572 if not rev:
573 573 raise error.Abort(_("please specify a revision to backout"))
574 574
575 575 date = opts.get('date')
576 576 if date:
577 577 opts['date'] = util.parsedate(date)
578 578
579 579 cmdutil.checkunfinished(repo)
580 580 cmdutil.bailifchanged(repo)
581 581 node = scmutil.revsingle(repo, rev).node()
582 582
583 583 op1, op2 = repo.dirstate.parents()
584 584 if not repo.changelog.isancestor(node, op1):
585 585 raise error.Abort(_('cannot backout change that is not an ancestor'))
586 586
587 587 p1, p2 = repo.changelog.parents(node)
588 588 if p1 == nullid:
589 589 raise error.Abort(_('cannot backout a change with no parents'))
590 590 if p2 != nullid:
591 591 if not opts.get('parent'):
592 592 raise error.Abort(_('cannot backout a merge changeset'))
593 593 p = repo.lookup(opts['parent'])
594 594 if p not in (p1, p2):
595 595 raise error.Abort(_('%s is not a parent of %s') %
596 596 (short(p), short(node)))
597 597 parent = p
598 598 else:
599 599 if opts.get('parent'):
600 600 raise error.Abort(_('cannot use --parent on non-merge changeset'))
601 601 parent = p1
602 602
603 603 # the backout should appear on the same branch
604 604 branch = repo.dirstate.branch()
605 605 bheads = repo.branchheads(branch)
606 606 rctx = scmutil.revsingle(repo, hex(parent))
607 607 if not opts.get('merge') and op1 != node:
608 608 dsguard = dirstateguard.dirstateguard(repo, 'backout')
609 609 try:
610 610 ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
611 611 'backout')
612 612 stats = mergemod.update(repo, parent, True, True, node, False)
613 613 repo.setparents(op1, op2)
614 614 dsguard.close()
615 615 hg._showstats(repo, stats)
616 616 if stats[3]:
617 617 repo.ui.status(_("use 'hg resolve' to retry unresolved "
618 618 "file merges\n"))
619 619 return 1
620 620 finally:
621 621 ui.setconfig('ui', 'forcemerge', '', '')
622 622 lockmod.release(dsguard)
623 623 else:
624 624 hg.clean(repo, node, show_stats=False)
625 625 repo.dirstate.setbranch(branch)
626 626 cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())
627 627
628 628 if opts.get('no_commit'):
629 629 msg = _("changeset %s backed out, "
630 630 "don't forget to commit.\n")
631 631 ui.status(msg % short(node))
632 632 return 0
633 633
634 634 def commitfunc(ui, repo, message, match, opts):
635 635 editform = 'backout'
636 636 e = cmdutil.getcommiteditor(editform=editform,
637 637 **pycompat.strkwargs(opts))
638 638 if not message:
639 639 # we don't translate commit messages
640 640 message = "Backed out changeset %s" % short(node)
641 641 e = cmdutil.getcommiteditor(edit=True, editform=editform)
642 642 return repo.commit(message, opts.get('user'), opts.get('date'),
643 643 match, editor=e)
644 644 newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
645 645 if not newnode:
646 646 ui.status(_("nothing changed\n"))
647 647 return 1
648 648 cmdutil.commitstatus(repo, newnode, branch, bheads)
649 649
650 650 def nice(node):
651 651 return '%d:%s' % (repo.changelog.rev(node), short(node))
652 652 ui.status(_('changeset %s backs out changeset %s\n') %
653 653 (nice(repo.changelog.tip()), nice(node)))
654 654 if opts.get('merge') and op1 != node:
655 655 hg.clean(repo, op1, show_stats=False)
656 656 ui.status(_('merging with changeset %s\n')
657 657 % nice(repo.changelog.tip()))
658 658 try:
659 659 ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
660 660 'backout')
661 661 return hg.merge(repo, hex(repo.changelog.tip()))
662 662 finally:
663 663 ui.setconfig('ui', 'forcemerge', '', '')
664 664 return 0
665 665
666 666 @command('bisect',
667 667 [('r', 'reset', False, _('reset bisect state')),
668 668 ('g', 'good', False, _('mark changeset good')),
669 669 ('b', 'bad', False, _('mark changeset bad')),
670 670 ('s', 'skip', False, _('skip testing changeset')),
671 671 ('e', 'extend', False, _('extend the bisect range')),
672 672 ('c', 'command', '', _('use command to check changeset state'), _('CMD')),
673 673 ('U', 'noupdate', False, _('do not update to target'))],
674 674 _("[-gbsr] [-U] [-c CMD] [REV]"))
675 675 def bisect(ui, repo, rev=None, extra=None, command=None,
676 676 reset=None, good=None, bad=None, skip=None, extend=None,
677 677 noupdate=None):
678 678 """subdivision search of changesets
679 679
680 680 This command helps to find changesets which introduce problems. To
681 681 use, mark the earliest changeset you know exhibits the problem as
682 682 bad, then mark the latest changeset which is free from the problem
683 683 as good. Bisect will update your working directory to a revision
684 684 for testing (unless the -U/--noupdate option is specified). Once
685 685 you have performed tests, mark the working directory as good or
686 686 bad, and bisect will either update to another candidate changeset
687 687 or announce that it has found the bad revision.
688 688
689 689 As a shortcut, you can also use the revision argument to mark a
690 690 revision as good or bad without checking it out first.
691 691
692 692 If you supply a command, it will be used for automatic bisection.
693 693 The environment variable HG_NODE will contain the ID of the
694 694 changeset being tested. The exit status of the command will be
695 695 used to mark revisions as good or bad: status 0 means good, 125
696 696 means to skip the revision, 127 (command not found) will abort the
697 697 bisection, and any other non-zero exit status means the revision
698 698 is bad.
699 699
700 700 .. container:: verbose
701 701
702 702 Some examples:
703 703
704 704 - start a bisection with known bad revision 34, and good revision 12::
705 705
706 706 hg bisect --bad 34
707 707 hg bisect --good 12
708 708
709 709 - advance the current bisection by marking current revision as good or
710 710 bad::
711 711
712 712 hg bisect --good
713 713 hg bisect --bad
714 714
715 715 - mark the current revision, or a known revision, to be skipped (e.g. if
716 716 that revision is not usable because of another issue)::
717 717
718 718 hg bisect --skip
719 719 hg bisect --skip 23
720 720
721 721 - skip all revisions that do not touch directories ``foo`` or ``bar``::
722 722
723 723 hg bisect --skip "!( file('path:foo') & file('path:bar') )"
724 724
725 725 - forget the current bisection::
726 726
727 727 hg bisect --reset
728 728
729 729 - use 'make && make tests' to automatically find the first broken
730 730 revision::
731 731
732 732 hg bisect --reset
733 733 hg bisect --bad 34
734 734 hg bisect --good 12
735 735 hg bisect --command "make && make tests"
736 736
737 737 - see all changesets whose states are already known in the current
738 738 bisection::
739 739
740 740 hg log -r "bisect(pruned)"
741 741
742 742 - see the changeset currently being bisected (especially useful
743 743 if running with -U/--noupdate)::
744 744
745 745 hg log -r "bisect(current)"
746 746
747 747 - see all changesets that took part in the current bisection::
748 748
749 749 hg log -r "bisect(range)"
750 750
751 751 - you can even get a nice graph::
752 752
753 753 hg log --graph -r "bisect(range)"
754 754
755 755 See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
756 756
757 757 Returns 0 on success.
758 758 """
759 759 # backward compatibility
760 760 if rev in "good bad reset init".split():
761 761 ui.warn(_("(use of 'hg bisect <cmd>' is deprecated)\n"))
762 762 cmd, rev, extra = rev, extra, None
763 763 if cmd == "good":
764 764 good = True
765 765 elif cmd == "bad":
766 766 bad = True
767 767 else:
768 768 reset = True
769 769 elif extra:
770 770 raise error.Abort(_('incompatible arguments'))
771 771
772 772 incompatibles = {
773 773 '--bad': bad,
774 774 '--command': bool(command),
775 775 '--extend': extend,
776 776 '--good': good,
777 777 '--reset': reset,
778 778 '--skip': skip,
779 779 }
780 780
781 781 enabled = [x for x in incompatibles if incompatibles[x]]
782 782
783 783 if len(enabled) > 1:
784 784 raise error.Abort(_('%s and %s are incompatible') %
785 785 tuple(sorted(enabled)[0:2]))
786 786
787 787 if reset:
788 788 hbisect.resetstate(repo)
789 789 return
790 790
791 791 state = hbisect.load_state(repo)
792 792
793 793 # update state
794 794 if good or bad or skip:
795 795 if rev:
796 796 nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
797 797 else:
798 798 nodes = [repo.lookup('.')]
799 799 if good:
800 800 state['good'] += nodes
801 801 elif bad:
802 802 state['bad'] += nodes
803 803 elif skip:
804 804 state['skip'] += nodes
805 805 hbisect.save_state(repo, state)
806 806 if not (state['good'] and state['bad']):
807 807 return
808 808
809 809 def mayupdate(repo, node, show_stats=True):
810 810 """common used update sequence"""
811 811 if noupdate:
812 812 return
813 813 cmdutil.checkunfinished(repo)
814 814 cmdutil.bailifchanged(repo)
815 815 return hg.clean(repo, node, show_stats=show_stats)
816 816
817 817 displayer = cmdutil.show_changeset(ui, repo, {})
818 818
819 819 if command:
820 820 changesets = 1
821 821 if noupdate:
822 822 try:
823 823 node = state['current'][0]
824 824 except LookupError:
825 825 raise error.Abort(_('current bisect revision is unknown - '
826 826 'start a new bisect to fix'))
827 827 else:
828 828 node, p2 = repo.dirstate.parents()
829 829 if p2 != nullid:
830 830 raise error.Abort(_('current bisect revision is a merge'))
831 831 if rev:
832 832 node = repo[scmutil.revsingle(repo, rev, node)].node()
833 833 try:
834 834 while changesets:
835 835 # update state
836 836 state['current'] = [node]
837 837 hbisect.save_state(repo, state)
838 838 status = ui.system(command, environ={'HG_NODE': hex(node)},
839 839 blockedtag='bisect_check')
840 840 if status == 125:
841 841 transition = "skip"
842 842 elif status == 0:
843 843 transition = "good"
844 844 # status < 0 means process was killed
845 845 elif status == 127:
846 846 raise error.Abort(_("failed to execute %s") % command)
847 847 elif status < 0:
848 848 raise error.Abort(_("%s killed") % command)
849 849 else:
850 850 transition = "bad"
851 851 state[transition].append(node)
852 852 ctx = repo[node]
853 853 ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
854 854 hbisect.checkstate(state)
855 855 # bisect
856 856 nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
857 857 # update to next check
858 858 node = nodes[0]
859 859 mayupdate(repo, node, show_stats=False)
860 860 finally:
861 861 state['current'] = [node]
862 862 hbisect.save_state(repo, state)
863 863 hbisect.printresult(ui, repo, state, displayer, nodes, bgood)
864 864 return
865 865
866 866 hbisect.checkstate(state)
867 867
868 868 # actually bisect
869 869 nodes, changesets, good = hbisect.bisect(repo.changelog, state)
870 870 if extend:
871 871 if not changesets:
872 872 extendnode = hbisect.extendrange(repo, state, nodes, good)
873 873 if extendnode is not None:
874 874 ui.write(_("Extending search to changeset %d:%s\n")
875 875 % (extendnode.rev(), extendnode))
876 876 state['current'] = [extendnode.node()]
877 877 hbisect.save_state(repo, state)
878 878 return mayupdate(repo, extendnode.node())
879 879 raise error.Abort(_("nothing to extend"))
880 880
881 881 if changesets == 0:
882 882 hbisect.printresult(ui, repo, state, displayer, nodes, good)
883 883 else:
884 884 assert len(nodes) == 1 # only a single node can be tested next
885 885 node = nodes[0]
886 886 # compute the approximate number of remaining tests
887 887 tests, size = 0, 2
888 888 while size <= changesets:
889 889 tests, size = tests + 1, size * 2
890 890 rev = repo.changelog.rev(node)
891 891 ui.write(_("Testing changeset %d:%s "
892 892 "(%d changesets remaining, ~%d tests)\n")
893 893 % (rev, short(node), changesets, tests))
894 894 state['current'] = [node]
895 895 hbisect.save_state(repo, state)
896 896 return mayupdate(repo, node)
897 897
898 898 @command('bookmarks|bookmark',
899 899 [('f', 'force', False, _('force')),
900 900 ('r', 'rev', '', _('revision for bookmark action'), _('REV')),
901 901 ('d', 'delete', False, _('delete a given bookmark')),
902 902 ('m', 'rename', '', _('rename a given bookmark'), _('OLD')),
903 903 ('i', 'inactive', False, _('mark a bookmark inactive')),
904 904 ] + formatteropts,
905 905 _('hg bookmarks [OPTIONS]... [NAME]...'))
906 906 def bookmark(ui, repo, *names, **opts):
907 907 '''create a new bookmark or list existing bookmarks
908 908
909 909 Bookmarks are labels on changesets to help track lines of development.
910 910 Bookmarks are unversioned and can be moved, renamed and deleted.
911 911 Deleting or moving a bookmark has no effect on the associated changesets.
912 912
913 913 Creating or updating to a bookmark causes it to be marked as 'active'.
914 914 The active bookmark is indicated with a '*'.
915 915 When a commit is made, the active bookmark will advance to the new commit.
916 916 A plain :hg:`update` will also advance an active bookmark, if possible.
917 917 Updating away from a bookmark will cause it to be deactivated.
918 918
919 919 Bookmarks can be pushed and pulled between repositories (see
920 920 :hg:`help push` and :hg:`help pull`). If a shared bookmark has
921 921 diverged, a new 'divergent bookmark' of the form 'name@path' will
922 922 be created. Using :hg:`merge` will resolve the divergence.
923 923
924 924 Specifying bookmark as '.' to -m or -d options is equivalent to specifying
925 925 the active bookmark's name.
926 926
927 927 A bookmark named '@' has the special property that :hg:`clone` will
928 928 check it out by default if it exists.
929 929
930 930 .. container:: verbose
931 931
932 932 Examples:
933 933
934 934 - create an active bookmark for a new line of development::
935 935
936 936 hg book new-feature
937 937
938 938 - create an inactive bookmark as a place marker::
939 939
940 940 hg book -i reviewed
941 941
942 942 - create an inactive bookmark on another changeset::
943 943
944 944 hg book -r .^ tested
945 945
946 946 - rename bookmark turkey to dinner::
947 947
948 948 hg book -m turkey dinner
949 949
950 950 - move the '@' bookmark from another branch::
951 951
952 952 hg book -f @
953 953 '''
954 954 force = opts.get(r'force')
955 955 rev = opts.get(r'rev')
956 956 delete = opts.get(r'delete')
957 957 rename = opts.get(r'rename')
958 958 inactive = opts.get(r'inactive')
959 959
960 960 if delete and rename:
961 961 raise error.Abort(_("--delete and --rename are incompatible"))
962 962 if delete and rev:
963 963 raise error.Abort(_("--rev is incompatible with --delete"))
964 964 if rename and rev:
965 965 raise error.Abort(_("--rev is incompatible with --rename"))
966 966 if not names and (delete or rev):
967 967 raise error.Abort(_("bookmark name required"))
968 968
969 969 if delete or rename or names or inactive:
970 970 with repo.wlock(), repo.lock(), repo.transaction('bookmark') as tr:
971 971 if delete:
972 972 names = pycompat.maplist(repo._bookmarks.expandname, names)
973 973 bookmarks.delete(repo, tr, names)
974 974 elif rename:
975 975 if not names:
976 976 raise error.Abort(_("new bookmark name required"))
977 977 elif len(names) > 1:
978 978 raise error.Abort(_("only one new bookmark name allowed"))
979 979 rename = repo._bookmarks.expandname(rename)
980 980 bookmarks.rename(repo, tr, rename, names[0], force, inactive)
981 981 elif names:
982 982 bookmarks.addbookmarks(repo, tr, names, rev, force, inactive)
983 983 elif inactive:
984 984 if len(repo._bookmarks) == 0:
985 985 ui.status(_("no bookmarks set\n"))
986 986 elif not repo._activebookmark:
987 987 ui.status(_("no active bookmark\n"))
988 988 else:
989 989 bookmarks.deactivate(repo)
990 990 else: # show bookmarks
991 991 bookmarks.printbookmarks(ui, repo, **opts)
992 992
993 993 @command('branch',
994 994 [('f', 'force', None,
995 995 _('set branch name even if it shadows an existing branch')),
996 996 ('C', 'clean', None, _('reset branch name to parent branch name'))],
997 997 _('[-fC] [NAME]'))
998 998 def branch(ui, repo, label=None, **opts):
999 999 """set or show the current branch name
1000 1000
1001 1001 .. note::
1002 1002
1003 1003 Branch names are permanent and global. Use :hg:`bookmark` to create a
1004 1004 light-weight bookmark instead. See :hg:`help glossary` for more
1005 1005 information about named branches and bookmarks.
1006 1006
1007 1007 With no argument, show the current branch name. With one argument,
1008 1008 set the working directory branch name (the branch will not exist
1009 1009 in the repository until the next commit). Standard practice
1010 1010 recommends that primary development take place on the 'default'
1011 1011 branch.
1012 1012
1013 1013 Unless -f/--force is specified, branch will not let you set a
1014 1014 branch name that already exists.
1015 1015
1016 1016 Use -C/--clean to reset the working directory branch to that of
1017 1017 the parent of the working directory, negating a previous branch
1018 1018 change.
1019 1019
1020 1020 Use the command :hg:`update` to switch to an existing branch. Use
1021 1021 :hg:`commit --close-branch` to mark this branch head as closed.
1022 1022 When all heads of a branch are closed, the branch will be
1023 1023 considered closed.
1024 1024
1025 1025 Returns 0 on success.
1026 1026 """
1027 1027 opts = pycompat.byteskwargs(opts)
1028 1028 if label:
1029 1029 label = label.strip()
1030 1030
1031 1031 if not opts.get('clean') and not label:
1032 1032 ui.write("%s\n" % repo.dirstate.branch())
1033 1033 return
1034 1034
1035 1035 with repo.wlock():
1036 1036 if opts.get('clean'):
1037 1037 label = repo[None].p1().branch()
1038 1038 repo.dirstate.setbranch(label)
1039 1039 ui.status(_('reset working directory to branch %s\n') % label)
1040 1040 elif label:
1041 1041 if not opts.get('force') and label in repo.branchmap():
1042 1042 if label not in [p.branch() for p in repo[None].parents()]:
1043 1043 raise error.Abort(_('a branch of the same name already'
1044 1044 ' exists'),
1045 1045 # i18n: "it" refers to an existing branch
1046 1046 hint=_("use 'hg update' to switch to it"))
1047 1047 scmutil.checknewlabel(repo, label, 'branch')
1048 1048 repo.dirstate.setbranch(label)
1049 1049 ui.status(_('marked working directory as branch %s\n') % label)
1050 1050
1051 1051 # find any open named branches aside from default
1052 1052 others = [n for n, h, t, c in repo.branchmap().iterbranches()
1053 1053 if n != "default" and not c]
1054 1054 if not others:
1055 1055 ui.status(_('(branches are permanent and global, '
1056 1056 'did you want a bookmark?)\n'))
1057 1057
1058 1058 @command('branches',
1059 1059 [('a', 'active', False,
1060 1060 _('show only branches that have unmerged heads (DEPRECATED)')),
1061 1061 ('c', 'closed', False, _('show normal and closed branches')),
1062 1062 ] + formatteropts,
1063 1063 _('[-c]'))
1064 1064 def branches(ui, repo, active=False, closed=False, **opts):
1065 1065 """list repository named branches
1066 1066
1067 1067 List the repository's named branches, indicating which ones are
1068 1068 inactive. If -c/--closed is specified, also list branches which have
1069 1069 been marked closed (see :hg:`commit --close-branch`).
1070 1070
1071 1071 Use the command :hg:`update` to switch to an existing branch.
1072 1072
1073 1073 Returns 0.
1074 1074 """
1075 1075
1076 1076 opts = pycompat.byteskwargs(opts)
1077 1077 ui.pager('branches')
1078 1078 fm = ui.formatter('branches', opts)
1079 1079 hexfunc = fm.hexfunc
1080 1080
1081 1081 allheads = set(repo.heads())
1082 1082 branches = []
1083 1083 for tag, heads, tip, isclosed in repo.branchmap().iterbranches():
1084 1084 isactive = False
1085 1085 if not isclosed:
1086 1086 openheads = set(repo.branchmap().iteropen(heads))
1087 1087 isactive = bool(openheads & allheads)
1088 1088 branches.append((tag, repo[tip], isactive, not isclosed))
1089 1089 branches.sort(key=lambda i: (i[2], i[1].rev(), i[0], i[3]),
1090 1090 reverse=True)
1091 1091
1092 1092 for tag, ctx, isactive, isopen in branches:
1093 1093 if active and not isactive:
1094 1094 continue
1095 1095 if isactive:
1096 1096 label = 'branches.active'
1097 1097 notice = ''
1098 1098 elif not isopen:
1099 1099 if not closed:
1100 1100 continue
1101 1101 label = 'branches.closed'
1102 1102 notice = _(' (closed)')
1103 1103 else:
1104 1104 label = 'branches.inactive'
1105 1105 notice = _(' (inactive)')
1106 1106 current = (tag == repo.dirstate.branch())
1107 1107 if current:
1108 1108 label = 'branches.current'
1109 1109
1110 1110 fm.startitem()
1111 1111 fm.write('branch', '%s', tag, label=label)
1112 1112 rev = ctx.rev()
1113 1113 padsize = max(31 - len(str(rev)) - encoding.colwidth(tag), 0)
1114 1114 fmt = ' ' * padsize + ' %d:%s'
1115 1115 fm.condwrite(not ui.quiet, 'rev node', fmt, rev, hexfunc(ctx.node()),
1116 1116 label='log.changeset changeset.%s' % ctx.phasestr())
1117 1117 fm.context(ctx=ctx)
1118 1118 fm.data(active=isactive, closed=not isopen, current=current)
1119 1119 if not ui.quiet:
1120 1120 fm.plain(notice)
1121 1121 fm.plain('\n')
1122 1122 fm.end()
1123 1123
1124 1124 @command('bundle',
1125 1125 [('f', 'force', None, _('run even when the destination is unrelated')),
1126 1126 ('r', 'rev', [], _('a changeset intended to be added to the destination'),
1127 1127 _('REV')),
1128 1128 ('b', 'branch', [], _('a specific branch you would like to bundle'),
1129 1129 _('BRANCH')),
1130 1130 ('', 'base', [],
1131 1131 _('a base changeset assumed to be available at the destination'),
1132 1132 _('REV')),
1133 1133 ('a', 'all', None, _('bundle all changesets in the repository')),
1134 1134 ('t', 'type', 'bzip2', _('bundle compression type to use'), _('TYPE')),
1135 1135 ] + remoteopts,
1136 1136 _('[-f] [-t BUNDLESPEC] [-a] [-r REV]... [--base REV]... FILE [DEST]'))
1137 1137 def bundle(ui, repo, fname, dest=None, **opts):
1138 1138 """create a bundle file
1139 1139
1140 1140 Generate a bundle file containing data to be added to a repository.
1141 1141
1142 1142 To create a bundle containing all changesets, use -a/--all
1143 1143 (or --base null). Otherwise, hg assumes the destination will have
1144 1144 all the nodes you specify with --base parameters. Otherwise, hg
1145 1145 will assume the repository has all the nodes in destination, or
1146 1146 default-push/default if no destination is specified.
1147 1147
1148 1148 You can change bundle format with the -t/--type option. See
1149 1149 :hg:`help bundlespec` for documentation on this format. By default,
1150 1150 the most appropriate format is used and compression defaults to
1151 1151 bzip2.
1152 1152
1153 1153 The bundle file can then be transferred using conventional means
1154 1154 and applied to another repository with the unbundle or pull
1155 1155 command. This is useful when direct push and pull are not
1156 1156 available or when exporting an entire repository is undesirable.
1157 1157
1158 1158 Applying bundles preserves all changeset contents including
1159 1159 permissions, copy/rename information, and revision history.
1160 1160
1161 1161 Returns 0 on success, 1 if no changes found.
1162 1162 """
1163 1163 opts = pycompat.byteskwargs(opts)
1164 1164 revs = None
1165 1165 if 'rev' in opts:
1166 1166 revstrings = opts['rev']
1167 1167 revs = scmutil.revrange(repo, revstrings)
1168 1168 if revstrings and not revs:
1169 1169 raise error.Abort(_('no commits to bundle'))
1170 1170
1171 1171 bundletype = opts.get('type', 'bzip2').lower()
1172 1172 try:
1173 1173 bcompression, cgversion, params = exchange.parsebundlespec(
1174 1174 repo, bundletype, strict=False)
1175 1175 except error.UnsupportedBundleSpecification as e:
1176 1176 raise error.Abort(str(e),
1177 1177 hint=_("see 'hg help bundlespec' for supported "
1178 1178 "values for --type"))
1179 1179
1180 1180 # Packed bundles are a pseudo bundle format for now.
1181 1181 if cgversion == 's1':
1182 1182 raise error.Abort(_('packed bundles cannot be produced by "hg bundle"'),
1183 1183 hint=_("use 'hg debugcreatestreamclonebundle'"))
1184 1184
1185 1185 if opts.get('all'):
1186 1186 if dest:
1187 1187 raise error.Abort(_("--all is incompatible with specifying "
1188 1188 "a destination"))
1189 1189 if opts.get('base'):
1190 1190 ui.warn(_("ignoring --base because --all was specified\n"))
1191 1191 base = ['null']
1192 1192 else:
1193 1193 base = scmutil.revrange(repo, opts.get('base'))
1194 1194 if cgversion not in changegroup.supportedoutgoingversions(repo):
1195 1195 raise error.Abort(_("repository does not support bundle version %s") %
1196 1196 cgversion)
1197 1197
1198 1198 if base:
1199 1199 if dest:
1200 1200 raise error.Abort(_("--base is incompatible with specifying "
1201 1201 "a destination"))
1202 1202 common = [repo.lookup(rev) for rev in base]
1203 1203 heads = revs and map(repo.lookup, revs) or None
1204 1204 outgoing = discovery.outgoing(repo, common, heads)
1205 1205 else:
1206 1206 dest = ui.expandpath(dest or 'default-push', dest or 'default')
1207 1207 dest, branches = hg.parseurl(dest, opts.get('branch'))
1208 1208 other = hg.peer(repo, opts, dest)
1209 1209 revs, checkout = hg.addbranchrevs(repo, repo, branches, revs)
1210 1210 heads = revs and map(repo.lookup, revs) or revs
1211 1211 outgoing = discovery.findcommonoutgoing(repo, other,
1212 1212 onlyheads=heads,
1213 1213 force=opts.get('force'),
1214 1214 portable=True)
1215 1215
1216 1216 if not outgoing.missing:
1217 1217 scmutil.nochangesfound(ui, repo, not base and outgoing.excluded)
1218 1218 return 1
1219 1219
1220 1220 if cgversion == '01': #bundle1
1221 1221 if bcompression is None:
1222 1222 bcompression = 'UN'
1223 1223 bversion = 'HG10' + bcompression
1224 1224 bcompression = None
1225 1225 elif cgversion in ('02', '03'):
1226 1226 bversion = 'HG20'
1227 1227 else:
1228 1228 raise error.ProgrammingError(
1229 1229 'bundle: unexpected changegroup version %s' % cgversion)
1230 1230
1231 1231 # TODO compression options should be derived from bundlespec parsing.
1232 1232 # This is a temporary hack to allow adjusting bundle compression
1233 1233 # level without a) formalizing the bundlespec changes to declare it
1234 1234 # b) introducing a command flag.
1235 1235 compopts = {}
1236 1236 complevel = ui.configint('experimental', 'bundlecomplevel')
1237 1237 if complevel is not None:
1238 1238 compopts['level'] = complevel
1239 1239
1240 1240
1241 1241 contentopts = {'cg.version': cgversion}
1242 1242 if repo.ui.configbool('experimental', 'evolution.bundle-obsmarker'):
1243 1243 contentopts['obsolescence'] = True
1244 1244 if repo.ui.configbool('experimental', 'bundle-phases'):
1245 1245 contentopts['phases'] = True
1246 1246 bundle2.writenewbundle(ui, repo, 'bundle', fname, bversion, outgoing,
1247 1247 contentopts, compression=bcompression,
1248 1248 compopts=compopts)
1249 1249
1250 1250 @command('cat',
1251 1251 [('o', 'output', '',
1252 1252 _('print output to file with formatted name'), _('FORMAT')),
1253 1253 ('r', 'rev', '', _('print the given revision'), _('REV')),
1254 1254 ('', 'decode', None, _('apply any matching decode filter')),
1255 1255 ] + walkopts + formatteropts,
1256 1256 _('[OPTION]... FILE...'),
1257 1257 inferrepo=True)
1258 1258 def cat(ui, repo, file1, *pats, **opts):
1259 1259 """output the current or given revision of files
1260 1260
1261 1261 Print the specified files as they were at the given revision. If
1262 1262 no revision is given, the parent of the working directory is used.
1263 1263
1264 1264 Output may be to a file, in which case the name of the file is
1265 1265 given using a format string. The formatting rules as follows:
1266 1266
1267 1267 :``%%``: literal "%" character
1268 1268 :``%s``: basename of file being printed
1269 1269 :``%d``: dirname of file being printed, or '.' if in repository root
1270 1270 :``%p``: root-relative path name of file being printed
1271 1271 :``%H``: changeset hash (40 hexadecimal digits)
1272 1272 :``%R``: changeset revision number
1273 1273 :``%h``: short-form changeset hash (12 hexadecimal digits)
1274 1274 :``%r``: zero-padded changeset revision number
1275 1275 :``%b``: basename of the exporting repository
1276 1276
1277 1277 Returns 0 on success.
1278 1278 """
1279 1279 ctx = scmutil.revsingle(repo, opts.get('rev'))
1280 1280 m = scmutil.match(ctx, (file1,) + pats, opts)
1281 1281 fntemplate = opts.pop('output', '')
1282 1282 if cmdutil.isstdiofilename(fntemplate):
1283 1283 fntemplate = ''
1284 1284
1285 1285 if fntemplate:
1286 1286 fm = formatter.nullformatter(ui, 'cat')
1287 1287 else:
1288 1288 ui.pager('cat')
1289 1289 fm = ui.formatter('cat', opts)
1290 1290 with fm:
1291 1291 return cmdutil.cat(ui, repo, ctx, m, fm, fntemplate, '', **opts)
1292 1292
1293 1293 @command('^clone',
1294 1294 [('U', 'noupdate', None, _('the clone will include an empty working '
1295 1295 'directory (only a repository)')),
1296 1296 ('u', 'updaterev', '', _('revision, tag, or branch to check out'),
1297 1297 _('REV')),
1298 1298 ('r', 'rev', [], _('include the specified changeset'), _('REV')),
1299 1299 ('b', 'branch', [], _('clone only the specified branch'), _('BRANCH')),
1300 1300 ('', 'pull', None, _('use pull protocol to copy metadata')),
1301 1301 ('', 'uncompressed', None,
1302 1302 _('an alias to --stream (DEPRECATED)')),
1303 1303 ('', 'stream', None,
1304 1304 _('clone with minimal data processing')),
1305 1305 ] + remoteopts,
1306 1306 _('[OPTION]... SOURCE [DEST]'),
1307 1307 norepo=True)
1308 1308 def clone(ui, source, dest=None, **opts):
1309 1309 """make a copy of an existing repository
1310 1310
1311 1311 Create a copy of an existing repository in a new directory.
1312 1312
1313 1313 If no destination directory name is specified, it defaults to the
1314 1314 basename of the source.
1315 1315
1316 1316 The location of the source is added to the new repository's
1317 1317 ``.hg/hgrc`` file, as the default to be used for future pulls.
1318 1318
1319 1319 Only local paths and ``ssh://`` URLs are supported as
1320 1320 destinations. For ``ssh://`` destinations, no working directory or
1321 1321 ``.hg/hgrc`` will be created on the remote side.
1322 1322
1323 1323 If the source repository has a bookmark called '@' set, that
1324 1324 revision will be checked out in the new repository by default.
1325 1325
1326 1326 To check out a particular version, use -u/--update, or
1327 1327 -U/--noupdate to create a clone with no working directory.
1328 1328
1329 1329 To pull only a subset of changesets, specify one or more revisions
1330 1330 identifiers with -r/--rev or branches with -b/--branch. The
1331 1331 resulting clone will contain only the specified changesets and
1332 1332 their ancestors. These options (or 'clone src#rev dest') imply
1333 1333 --pull, even for local source repositories.
1334 1334
1335 1335 In normal clone mode, the remote normalizes repository data into a common
1336 1336 exchange format and the receiving end translates this data into its local
1337 1337 storage format. --stream activates a different clone mode that essentially
1338 1338 copies repository files from the remote with minimal data processing. This
1339 1339 significantly reduces the CPU cost of a clone both remotely and locally.
1340 1340 However, it often increases the transferred data size by 30-40%. This can
1341 1341 result in substantially faster clones where I/O throughput is plentiful,
1342 1342 especially for larger repositories. A side-effect of --stream clones is
1343 1343 that storage settings and requirements on the remote are applied locally:
1344 1344 a modern client may inherit legacy or inefficient storage used by the
1345 1345 remote or a legacy Mercurial client may not be able to clone from a
1346 1346 modern Mercurial remote.
1347 1347
1348 1348 .. note::
1349 1349
1350 1350 Specifying a tag will include the tagged changeset but not the
1351 1351 changeset containing the tag.
1352 1352
1353 1353 .. container:: verbose
1354 1354
1355 1355 For efficiency, hardlinks are used for cloning whenever the
1356 1356 source and destination are on the same filesystem (note this
1357 1357 applies only to the repository data, not to the working
1358 1358 directory). Some filesystems, such as AFS, implement hardlinking
1359 1359 incorrectly, but do not report errors. In these cases, use the
1360 1360 --pull option to avoid hardlinking.
1361 1361
1362 1362 Mercurial will update the working directory to the first applicable
1363 1363 revision from this list:
1364 1364
1365 1365 a) null if -U or the source repository has no changesets
1366 1366 b) if -u . and the source repository is local, the first parent of
1367 1367 the source repository's working directory
1368 1368 c) the changeset specified with -u (if a branch name, this means the
1369 1369 latest head of that branch)
1370 1370 d) the changeset specified with -r
1371 1371 e) the tipmost head specified with -b
1372 1372 f) the tipmost head specified with the url#branch source syntax
1373 1373 g) the revision marked with the '@' bookmark, if present
1374 1374 h) the tipmost head of the default branch
1375 1375 i) tip
1376 1376
1377 1377 When cloning from servers that support it, Mercurial may fetch
1378 1378 pre-generated data from a server-advertised URL. When this is done,
1379 1379 hooks operating on incoming changesets and changegroups may fire twice,
1380 1380 once for the bundle fetched from the URL and another for any additional
1381 1381 data not fetched from this URL. In addition, if an error occurs, the
1382 1382 repository may be rolled back to a partial clone. This behavior may
1383 1383 change in future releases. See :hg:`help -e clonebundles` for more.
1384 1384
1385 1385 Examples:
1386 1386
1387 1387 - clone a remote repository to a new directory named hg/::
1388 1388
1389 1389 hg clone https://www.mercurial-scm.org/repo/hg/
1390 1390
1391 1391 - create a lightweight local clone::
1392 1392
1393 1393 hg clone project/ project-feature/
1394 1394
1395 1395 - clone from an absolute path on an ssh server (note double-slash)::
1396 1396
1397 1397 hg clone ssh://user@server//home/projects/alpha/
1398 1398
1399 1399 - do a streaming clone while checking out a specified version::
1400 1400
1401 1401 hg clone --stream http://server/repo -u 1.5
1402 1402
1403 1403 - create a repository without changesets after a particular revision::
1404 1404
1405 1405 hg clone -r 04e544 experimental/ good/
1406 1406
1407 1407 - clone (and track) a particular named branch::
1408 1408
1409 1409 hg clone https://www.mercurial-scm.org/repo/hg/#stable
1410 1410
1411 1411 See :hg:`help urls` for details on specifying URLs.
1412 1412
1413 1413 Returns 0 on success.
1414 1414 """
1415 1415 opts = pycompat.byteskwargs(opts)
1416 1416 if opts.get('noupdate') and opts.get('updaterev'):
1417 1417 raise error.Abort(_("cannot specify both --noupdate and --updaterev"))
1418 1418
1419 1419 r = hg.clone(ui, opts, source, dest,
1420 1420 pull=opts.get('pull'),
1421 1421 stream=opts.get('stream') or opts.get('uncompressed'),
1422 1422 rev=opts.get('rev'),
1423 1423 update=opts.get('updaterev') or not opts.get('noupdate'),
1424 1424 branch=opts.get('branch'),
1425 1425 shareopts=opts.get('shareopts'))
1426 1426
1427 1427 return r is None
1428 1428
1429 1429 @command('^commit|ci',
1430 1430 [('A', 'addremove', None,
1431 1431 _('mark new/missing files as added/removed before committing')),
1432 1432 ('', 'close-branch', None,
1433 1433 _('mark a branch head as closed')),
1434 1434 ('', 'amend', None, _('amend the parent of the working directory')),
1435 1435 ('s', 'secret', None, _('use the secret phase for committing')),
1436 1436 ('e', 'edit', None, _('invoke editor on commit messages')),
1437 1437 ('i', 'interactive', None, _('use interactive mode')),
1438 1438 ] + walkopts + commitopts + commitopts2 + subrepoopts,
1439 1439 _('[OPTION]... [FILE]...'),
1440 1440 inferrepo=True)
1441 1441 def commit(ui, repo, *pats, **opts):
1442 1442 """commit the specified files or all outstanding changes
1443 1443
1444 1444 Commit changes to the given files into the repository. Unlike a
1445 1445 centralized SCM, this operation is a local operation. See
1446 1446 :hg:`push` for a way to actively distribute your changes.
1447 1447
1448 1448 If a list of files is omitted, all changes reported by :hg:`status`
1449 1449 will be committed.
1450 1450
1451 1451 If you are committing the result of a merge, do not provide any
1452 1452 filenames or -I/-X filters.
1453 1453
1454 1454 If no commit message is specified, Mercurial starts your
1455 1455 configured editor where you can enter a message. In case your
1456 1456 commit fails, you will find a backup of your message in
1457 1457 ``.hg/last-message.txt``.
1458 1458
1459 1459 The --close-branch flag can be used to mark the current branch
1460 1460 head closed. When all heads of a branch are closed, the branch
1461 1461 will be considered closed and no longer listed.
1462 1462
1463 1463 The --amend flag can be used to amend the parent of the
1464 1464 working directory with a new commit that contains the changes
1465 1465 in the parent in addition to those currently reported by :hg:`status`,
1466 1466 if there are any. The old commit is stored in a backup bundle in
1467 1467 ``.hg/strip-backup`` (see :hg:`help bundle` and :hg:`help unbundle`
1468 1468 on how to restore it).
1469 1469
1470 1470 Message, user and date are taken from the amended commit unless
1471 1471 specified. When a message isn't specified on the command line,
1472 1472 the editor will open with the message of the amended commit.
1473 1473
1474 1474 It is not possible to amend public changesets (see :hg:`help phases`)
1475 1475 or changesets that have children.
1476 1476
1477 1477 See :hg:`help dates` for a list of formats valid for -d/--date.
1478 1478
1479 1479 Returns 0 on success, 1 if nothing changed.
1480 1480
1481 1481 .. container:: verbose
1482 1482
1483 1483 Examples:
1484 1484
1485 1485 - commit all files ending in .py::
1486 1486
1487 1487 hg commit --include "set:**.py"
1488 1488
1489 1489 - commit all non-binary files::
1490 1490
1491 1491 hg commit --exclude "set:binary()"
1492 1492
1493 1493 - amend the current commit and set the date to now::
1494 1494
1495 1495 hg commit --amend --date now
1496 1496 """
1497 1497 wlock = lock = None
1498 1498 try:
1499 1499 wlock = repo.wlock()
1500 1500 lock = repo.lock()
1501 1501 return _docommit(ui, repo, *pats, **opts)
1502 1502 finally:
1503 1503 release(lock, wlock)
1504 1504
1505 1505 def _docommit(ui, repo, *pats, **opts):
1506 1506 if opts.get(r'interactive'):
1507 1507 opts.pop(r'interactive')
1508 1508 ret = cmdutil.dorecord(ui, repo, commit, None, False,
1509 1509 cmdutil.recordfilter, *pats,
1510 1510 **opts)
1511 1511 # ret can be 0 (no changes to record) or the value returned by
1512 1512 # commit(), 1 if nothing changed or None on success.
1513 1513 return 1 if ret == 0 else ret
1514 1514
1515 1515 opts = pycompat.byteskwargs(opts)
1516 1516 if opts.get('subrepos'):
1517 1517 if opts.get('amend'):
1518 1518 raise error.Abort(_('cannot amend with --subrepos'))
1519 1519 # Let --subrepos on the command line override config setting.
1520 1520 ui.setconfig('ui', 'commitsubrepos', True, 'commit')
1521 1521
1522 1522 cmdutil.checkunfinished(repo, commit=True)
1523 1523
1524 1524 branch = repo[None].branch()
1525 1525 bheads = repo.branchheads(branch)
1526 1526
1527 1527 extra = {}
1528 1528 if opts.get('close_branch'):
1529 1529 extra['close'] = 1
1530 1530
1531 1531 if not bheads:
1532 1532 raise error.Abort(_('can only close branch heads'))
1533 1533 elif opts.get('amend'):
1534 1534 if repo[None].parents()[0].p1().branch() != branch and \
1535 1535 repo[None].parents()[0].p2().branch() != branch:
1536 1536 raise error.Abort(_('can only close branch heads'))
1537 1537
1538 1538 if opts.get('amend'):
1539 1539 if ui.configbool('ui', 'commitsubrepos'):
1540 1540 raise error.Abort(_('cannot amend with ui.commitsubrepos enabled'))
1541 1541
1542 1542 old = repo['.']
1543 1543 if not old.mutable():
1544 1544 raise error.Abort(_('cannot amend public changesets'))
1545 1545 if len(repo[None].parents()) > 1:
1546 1546 raise error.Abort(_('cannot amend while merging'))
1547 1547 allowunstable = obsolete.isenabled(repo, obsolete.allowunstableopt)
1548 1548 if not allowunstable and old.children():
1549 1549 raise error.Abort(_('cannot amend changeset with children'))
1550 1550
1551 1551 # Currently histedit gets confused if an amend happens while histedit
1552 1552 # is in progress. Since we have a checkunfinished command, we are
1553 1553 # temporarily honoring it.
1554 1554 #
1555 1555 # Note: eventually this guard will be removed. Please do not expect
1556 1556 # this behavior to remain.
1557 1557 if not obsolete.isenabled(repo, obsolete.createmarkersopt):
1558 1558 cmdutil.checkunfinished(repo)
1559 1559
1560 1560 node = cmdutil.amend(ui, repo, old, extra, pats, opts)
1561 1561 if node == old.node():
1562 1562 ui.status(_("nothing changed\n"))
1563 1563 return 1
1564 1564 else:
1565 1565 def commitfunc(ui, repo, message, match, opts):
1566 1566 overrides = {}
1567 1567 if opts.get('secret'):
1568 1568 overrides[('phases', 'new-commit')] = 'secret'
1569 1569
1570 1570 baseui = repo.baseui
1571 1571 with baseui.configoverride(overrides, 'commit'):
1572 1572 with ui.configoverride(overrides, 'commit'):
1573 1573 editform = cmdutil.mergeeditform(repo[None],
1574 1574 'commit.normal')
1575 1575 editor = cmdutil.getcommiteditor(
1576 1576 editform=editform, **pycompat.strkwargs(opts))
1577 1577 return repo.commit(message,
1578 1578 opts.get('user'),
1579 1579 opts.get('date'),
1580 1580 match,
1581 1581 editor=editor,
1582 1582 extra=extra)
1583 1583
1584 1584 node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
1585 1585
1586 1586 if not node:
1587 1587 stat = cmdutil.postcommitstatus(repo, pats, opts)
1588 1588 if stat[3]:
1589 1589 ui.status(_("nothing changed (%d missing files, see "
1590 1590 "'hg status')\n") % len(stat[3]))
1591 1591 else:
1592 1592 ui.status(_("nothing changed\n"))
1593 1593 return 1
1594 1594
1595 1595 cmdutil.commitstatus(repo, node, branch, bheads, opts)
1596 1596
1597 1597 @command('config|showconfig|debugconfig',
1598 1598 [('u', 'untrusted', None, _('show untrusted configuration options')),
1599 1599 ('e', 'edit', None, _('edit user config')),
1600 1600 ('l', 'local', None, _('edit repository config')),
1601 1601 ('g', 'global', None, _('edit global config'))] + formatteropts,
1602 1602 _('[-u] [NAME]...'),
1603 1603 optionalrepo=True)
1604 1604 def config(ui, repo, *values, **opts):
1605 1605 """show combined config settings from all hgrc files
1606 1606
1607 1607 With no arguments, print names and values of all config items.
1608 1608
1609 1609 With one argument of the form section.name, print just the value
1610 1610 of that config item.
1611 1611
1612 1612 With multiple arguments, print names and values of all config
1613 1613 items with matching section names.
1614 1614
1615 1615 With --edit, start an editor on the user-level config file. With
1616 1616 --global, edit the system-wide config file. With --local, edit the
1617 1617 repository-level config file.
1618 1618
1619 1619 With --debug, the source (filename and line number) is printed
1620 1620 for each config item.
1621 1621
1622 1622 See :hg:`help config` for more information about config files.
1623 1623
1624 1624 Returns 0 on success, 1 if NAME does not exist.
1625 1625
1626 1626 """
1627 1627
1628 1628 opts = pycompat.byteskwargs(opts)
1629 1629 if opts.get('edit') or opts.get('local') or opts.get('global'):
1630 1630 if opts.get('local') and opts.get('global'):
1631 1631 raise error.Abort(_("can't use --local and --global together"))
1632 1632
1633 1633 if opts.get('local'):
1634 1634 if not repo:
1635 1635 raise error.Abort(_("can't use --local outside a repository"))
1636 1636 paths = [repo.vfs.join('hgrc')]
1637 1637 elif opts.get('global'):
1638 1638 paths = rcutil.systemrcpath()
1639 1639 else:
1640 1640 paths = rcutil.userrcpath()
1641 1641
1642 1642 for f in paths:
1643 1643 if os.path.exists(f):
1644 1644 break
1645 1645 else:
1646 1646 if opts.get('global'):
1647 1647 samplehgrc = uimod.samplehgrcs['global']
1648 1648 elif opts.get('local'):
1649 1649 samplehgrc = uimod.samplehgrcs['local']
1650 1650 else:
1651 1651 samplehgrc = uimod.samplehgrcs['user']
1652 1652
1653 1653 f = paths[0]
1654 1654 fp = open(f, "wb")
1655 1655 fp.write(util.tonativeeol(samplehgrc))
1656 1656 fp.close()
1657 1657
1658 1658 editor = ui.geteditor()
1659 1659 ui.system("%s \"%s\"" % (editor, f),
1660 1660 onerr=error.Abort, errprefix=_("edit failed"),
1661 1661 blockedtag='config_edit')
1662 1662 return
1663 1663 ui.pager('config')
1664 1664 fm = ui.formatter('config', opts)
1665 1665 for t, f in rcutil.rccomponents():
1666 1666 if t == 'path':
1667 1667 ui.debug('read config from: %s\n' % f)
1668 1668 elif t == 'items':
1669 1669 for section, name, value, source in f:
1670 1670 ui.debug('set config by: %s\n' % source)
1671 1671 else:
1672 1672 raise error.ProgrammingError('unknown rctype: %s' % t)
1673 1673 untrusted = bool(opts.get('untrusted'))
1674 1674 if values:
1675 1675 sections = [v for v in values if '.' not in v]
1676 1676 items = [v for v in values if '.' in v]
1677 1677 if len(items) > 1 or items and sections:
1678 1678 raise error.Abort(_('only one config item permitted'))
1679 1679 matched = False
1680 1680 for section, name, value in ui.walkconfig(untrusted=untrusted):
1681 1681 source = ui.configsource(section, name, untrusted)
1682 1682 value = pycompat.bytestr(value)
1683 1683 if fm.isplain():
1684 1684 source = source or 'none'
1685 1685 value = value.replace('\n', '\\n')
1686 1686 entryname = section + '.' + name
1687 1687 if values:
1688 1688 for v in values:
1689 1689 if v == section:
1690 1690 fm.startitem()
1691 1691 fm.condwrite(ui.debugflag, 'source', '%s: ', source)
1692 1692 fm.write('name value', '%s=%s\n', entryname, value)
1693 1693 matched = True
1694 1694 elif v == entryname:
1695 1695 fm.startitem()
1696 1696 fm.condwrite(ui.debugflag, 'source', '%s: ', source)
1697 1697 fm.write('value', '%s\n', value)
1698 1698 fm.data(name=entryname)
1699 1699 matched = True
1700 1700 else:
1701 1701 fm.startitem()
1702 1702 fm.condwrite(ui.debugflag, 'source', '%s: ', source)
1703 1703 fm.write('name value', '%s=%s\n', entryname, value)
1704 1704 matched = True
1705 1705 fm.end()
1706 1706 if matched:
1707 1707 return 0
1708 1708 return 1
1709 1709
1710 1710 @command('copy|cp',
1711 1711 [('A', 'after', None, _('record a copy that has already occurred')),
1712 1712 ('f', 'force', None, _('forcibly copy over an existing managed file')),
1713 1713 ] + walkopts + dryrunopts,
1714 1714 _('[OPTION]... [SOURCE]... DEST'))
1715 1715 def copy(ui, repo, *pats, **opts):
1716 1716 """mark files as copied for the next commit
1717 1717
1718 1718 Mark dest as having copies of source files. If dest is a
1719 1719 directory, copies are put in that directory. If dest is a file,
1720 1720 the source must be a single file.
1721 1721
1722 1722 By default, this command copies the contents of files as they
1723 1723 exist in the working directory. If invoked with -A/--after, the
1724 1724 operation is recorded, but no copying is performed.
1725 1725
1726 1726 This command takes effect with the next commit. To undo a copy
1727 1727 before that, see :hg:`revert`.
1728 1728
1729 1729 Returns 0 on success, 1 if errors are encountered.
1730 1730 """
1731 1731 opts = pycompat.byteskwargs(opts)
1732 1732 with repo.wlock(False):
1733 1733 return cmdutil.copy(ui, repo, pats, opts)
1734 1734
1735 1735 @command('debugcommands', [], _('[COMMAND]'), norepo=True)
1736 1736 def debugcommands(ui, cmd='', *args):
1737 1737 """list all available commands and options"""
1738 1738 for cmd, vals in sorted(table.iteritems()):
1739 1739 cmd = cmd.split('|')[0].strip('^')
1740 1740 opts = ', '.join([i[1] for i in vals[1]])
1741 1741 ui.write('%s: %s\n' % (cmd, opts))
1742 1742
1743 1743 @command('debugcomplete',
1744 1744 [('o', 'options', None, _('show the command options'))],
1745 1745 _('[-o] CMD'),
1746 1746 norepo=True)
1747 1747 def debugcomplete(ui, cmd='', **opts):
1748 1748 """returns the completion list associated with the given command"""
1749 1749
1750 1750 if opts.get('options'):
1751 1751 options = []
1752 1752 otables = [globalopts]
1753 1753 if cmd:
1754 1754 aliases, entry = cmdutil.findcmd(cmd, table, False)
1755 1755 otables.append(entry[1])
1756 1756 for t in otables:
1757 1757 for o in t:
1758 1758 if "(DEPRECATED)" in o[3]:
1759 1759 continue
1760 1760 if o[0]:
1761 1761 options.append('-%s' % o[0])
1762 1762 options.append('--%s' % o[1])
1763 1763 ui.write("%s\n" % "\n".join(options))
1764 1764 return
1765 1765
1766 1766 cmdlist, unused_allcmds = cmdutil.findpossible(cmd, table)
1767 1767 if ui.verbose:
1768 1768 cmdlist = [' '.join(c[0]) for c in cmdlist.values()]
1769 1769 ui.write("%s\n" % "\n".join(sorted(cmdlist)))
1770 1770
1771 1771 @command('^diff',
1772 1772 [('r', 'rev', [], _('revision'), _('REV')),
1773 1773 ('c', 'change', '', _('change made by revision'), _('REV'))
1774 1774 ] + diffopts + diffopts2 + walkopts + subrepoopts,
1775 1775 _('[OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...'),
1776 1776 inferrepo=True)
1777 1777 def diff(ui, repo, *pats, **opts):
1778 1778 """diff repository (or selected files)
1779 1779
1780 1780 Show differences between revisions for the specified files.
1781 1781
1782 1782 Differences between files are shown using the unified diff format.
1783 1783
1784 1784 .. note::
1785 1785
1786 1786 :hg:`diff` may generate unexpected results for merges, as it will
1787 1787 default to comparing against the working directory's first
1788 1788 parent changeset if no revisions are specified.
1789 1789
1790 1790 When two revision arguments are given, then changes are shown
1791 1791 between those revisions. If only one revision is specified then
1792 1792 that revision is compared to the working directory, and, when no
1793 1793 revisions are specified, the working directory files are compared
1794 1794 to its first parent.
1795 1795
1796 1796 Alternatively you can specify -c/--change with a revision to see
1797 1797 the changes in that changeset relative to its first parent.
1798 1798
1799 1799 Without the -a/--text option, diff will avoid generating diffs of
1800 1800 files it detects as binary. With -a, diff will generate a diff
1801 1801 anyway, probably with undesirable results.
1802 1802
1803 1803 Use the -g/--git option to generate diffs in the git extended diff
1804 1804 format. For more information, read :hg:`help diffs`.
1805 1805
1806 1806 .. container:: verbose
1807 1807
1808 1808 Examples:
1809 1809
1810 1810 - compare a file in the current working directory to its parent::
1811 1811
1812 1812 hg diff foo.c
1813 1813
1814 1814 - compare two historical versions of a directory, with rename info::
1815 1815
1816 1816 hg diff --git -r 1.0:1.2 lib/
1817 1817
1818 1818 - get change stats relative to the last change on some date::
1819 1819
1820 1820 hg diff --stat -r "date('may 2')"
1821 1821
1822 1822 - diff all newly-added files that contain a keyword::
1823 1823
1824 1824 hg diff "set:added() and grep(GNU)"
1825 1825
1826 1826 - compare a revision and its parents::
1827 1827
1828 1828 hg diff -c 9353 # compare against first parent
1829 1829 hg diff -r 9353^:9353 # same using revset syntax
1830 1830 hg diff -r 9353^2:9353 # compare against the second parent
1831 1831
1832 1832 Returns 0 on success.
1833 1833 """
1834 1834
1835 1835 opts = pycompat.byteskwargs(opts)
1836 1836 revs = opts.get('rev')
1837 1837 change = opts.get('change')
1838 1838 stat = opts.get('stat')
1839 1839 reverse = opts.get('reverse')
1840 1840
1841 1841 if revs and change:
1842 1842 msg = _('cannot specify --rev and --change at the same time')
1843 1843 raise error.Abort(msg)
1844 1844 elif change:
1845 1845 node2 = scmutil.revsingle(repo, change, None).node()
1846 1846 node1 = repo[node2].p1().node()
1847 1847 else:
1848 1848 node1, node2 = scmutil.revpair(repo, revs)
1849 1849
1850 1850 if reverse:
1851 1851 node1, node2 = node2, node1
1852 1852
1853 1853 diffopts = patch.diffallopts(ui, opts)
1854 1854 m = scmutil.match(repo[node2], pats, opts)
1855 1855 ui.pager('diff')
1856 1856 cmdutil.diffordiffstat(ui, repo, diffopts, node1, node2, m, stat=stat,
1857 1857 listsubrepos=opts.get('subrepos'),
1858 1858 root=opts.get('root'))
1859 1859
1860 1860 @command('^export',
1861 1861 [('o', 'output', '',
1862 1862 _('print output to file with formatted name'), _('FORMAT')),
1863 1863 ('', 'switch-parent', None, _('diff against the second parent')),
1864 1864 ('r', 'rev', [], _('revisions to export'), _('REV')),
1865 1865 ] + diffopts,
1866 1866 _('[OPTION]... [-o OUTFILESPEC] [-r] [REV]...'))
1867 1867 def export(ui, repo, *changesets, **opts):
1868 1868 """dump the header and diffs for one or more changesets
1869 1869
1870 1870 Print the changeset header and diffs for one or more revisions.
1871 1871 If no revision is given, the parent of the working directory is used.
1872 1872
1873 1873 The information shown in the changeset header is: author, date,
1874 1874 branch name (if non-default), changeset hash, parent(s) and commit
1875 1875 comment.
1876 1876
1877 1877 .. note::
1878 1878
1879 1879 :hg:`export` may generate unexpected diff output for merge
1880 1880 changesets, as it will compare the merge changeset against its
1881 1881 first parent only.
1882 1882
1883 1883 Output may be to a file, in which case the name of the file is
1884 1884 given using a format string. The formatting rules are as follows:
1885 1885
1886 1886 :``%%``: literal "%" character
1887 1887 :``%H``: changeset hash (40 hexadecimal digits)
1888 1888 :``%N``: number of patches being generated
1889 1889 :``%R``: changeset revision number
1890 1890 :``%b``: basename of the exporting repository
1891 1891 :``%h``: short-form changeset hash (12 hexadecimal digits)
1892 1892 :``%m``: first line of the commit message (only alphanumeric characters)
1893 1893 :``%n``: zero-padded sequence number, starting at 1
1894 1894 :``%r``: zero-padded changeset revision number
1895 1895
1896 1896 Without the -a/--text option, export will avoid generating diffs
1897 1897 of files it detects as binary. With -a, export will generate a
1898 1898 diff anyway, probably with undesirable results.
1899 1899
1900 1900 Use the -g/--git option to generate diffs in the git extended diff
1901 1901 format. See :hg:`help diffs` for more information.
1902 1902
1903 1903 With the --switch-parent option, the diff will be against the
1904 1904 second parent. It can be useful to review a merge.
1905 1905
1906 1906 .. container:: verbose
1907 1907
1908 1908 Examples:
1909 1909
1910 1910 - use export and import to transplant a bugfix to the current
1911 1911 branch::
1912 1912
1913 1913 hg export -r 9353 | hg import -
1914 1914
1915 1915 - export all the changesets between two revisions to a file with
1916 1916 rename information::
1917 1917
1918 1918 hg export --git -r 123:150 > changes.txt
1919 1919
1920 1920 - split outgoing changes into a series of patches with
1921 1921 descriptive names::
1922 1922
1923 1923 hg export -r "outgoing()" -o "%n-%m.patch"
1924 1924
1925 1925 Returns 0 on success.
1926 1926 """
1927 1927 opts = pycompat.byteskwargs(opts)
1928 1928 changesets += tuple(opts.get('rev', []))
1929 1929 if not changesets:
1930 1930 changesets = ['.']
1931 1931 revs = scmutil.revrange(repo, changesets)
1932 1932 if not revs:
1933 1933 raise error.Abort(_("export requires at least one changeset"))
1934 1934 if len(revs) > 1:
1935 1935 ui.note(_('exporting patches:\n'))
1936 1936 else:
1937 1937 ui.note(_('exporting patch:\n'))
1938 1938 ui.pager('export')
1939 1939 cmdutil.export(repo, revs, fntemplate=opts.get('output'),
1940 1940 switch_parent=opts.get('switch_parent'),
1941 1941 opts=patch.diffallopts(ui, opts))
1942 1942
1943 1943 @command('files',
1944 1944 [('r', 'rev', '', _('search the repository as it is in REV'), _('REV')),
1945 1945 ('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
1946 1946 ] + walkopts + formatteropts + subrepoopts,
1947 1947 _('[OPTION]... [FILE]...'))
1948 1948 def files(ui, repo, *pats, **opts):
1949 1949 """list tracked files
1950 1950
1951 1951 Print files under Mercurial control in the working directory or
1952 1952 specified revision for given files (excluding removed files).
1953 1953 Files can be specified as filenames or filesets.
1954 1954
1955 1955 If no files are given to match, this command prints the names
1956 1956 of all files under Mercurial control.
1957 1957
1958 1958 .. container:: verbose
1959 1959
1960 1960 Examples:
1961 1961
1962 1962 - list all files under the current directory::
1963 1963
1964 1964 hg files .
1965 1965
1966 1966 - shows sizes and flags for current revision::
1967 1967
1968 1968 hg files -vr .
1969 1969
1970 1970 - list all files named README::
1971 1971
1972 1972 hg files -I "**/README"
1973 1973
1974 1974 - list all binary files::
1975 1975
1976 1976 hg files "set:binary()"
1977 1977
1978 1978 - find files containing a regular expression::
1979 1979
1980 1980 hg files "set:grep('bob')"
1981 1981
1982 1982 - search tracked file contents with xargs and grep::
1983 1983
1984 1984 hg files -0 | xargs -0 grep foo
1985 1985
1986 1986 See :hg:`help patterns` and :hg:`help filesets` for more information
1987 1987 on specifying file patterns.
1988 1988
1989 1989 Returns 0 if a match is found, 1 otherwise.
1990 1990
1991 1991 """
1992 1992
1993 1993 opts = pycompat.byteskwargs(opts)
1994 1994 ctx = scmutil.revsingle(repo, opts.get('rev'), None)
1995 1995
1996 1996 end = '\n'
1997 1997 if opts.get('print0'):
1998 1998 end = '\0'
1999 1999 fmt = '%s' + end
2000 2000
2001 2001 m = scmutil.match(ctx, pats, opts)
2002 2002 ui.pager('files')
2003 2003 with ui.formatter('files', opts) as fm:
2004 2004 return cmdutil.files(ui, ctx, m, fm, fmt, opts.get('subrepos'))
2005 2005
2006 2006 @command('^forget', walkopts, _('[OPTION]... FILE...'), inferrepo=True)
2007 2007 def forget(ui, repo, *pats, **opts):
2008 2008 """forget the specified files on the next commit
2009 2009
2010 2010 Mark the specified files so they will no longer be tracked
2011 2011 after the next commit.
2012 2012
2013 2013 This only removes files from the current branch, not from the
2014 2014 entire project history, and it does not delete them from the
2015 2015 working directory.
2016 2016
2017 2017 To delete the file from the working directory, see :hg:`remove`.
2018 2018
2019 2019 To undo a forget before the next commit, see :hg:`add`.
2020 2020
2021 2021 .. container:: verbose
2022 2022
2023 2023 Examples:
2024 2024
2025 2025 - forget newly-added binary files::
2026 2026
2027 2027 hg forget "set:added() and binary()"
2028 2028
2029 2029 - forget files that would be excluded by .hgignore::
2030 2030
2031 2031 hg forget "set:hgignore()"
2032 2032
2033 2033 Returns 0 on success.
2034 2034 """
2035 2035
2036 2036 opts = pycompat.byteskwargs(opts)
2037 2037 if not pats:
2038 2038 raise error.Abort(_('no files specified'))
2039 2039
2040 2040 m = scmutil.match(repo[None], pats, opts)
2041 2041 rejected = cmdutil.forget(ui, repo, m, prefix="", explicitonly=False)[0]
2042 2042 return rejected and 1 or 0
2043 2043
2044 2044 @command(
2045 2045 'graft',
2046 2046 [('r', 'rev', [], _('revisions to graft'), _('REV')),
2047 2047 ('c', 'continue', False, _('resume interrupted graft')),
2048 2048 ('e', 'edit', False, _('invoke editor on commit messages')),
2049 2049 ('', 'log', None, _('append graft info to log message')),
2050 2050 ('f', 'force', False, _('force graft')),
2051 2051 ('D', 'currentdate', False,
2052 2052 _('record the current date as commit date')),
2053 2053 ('U', 'currentuser', False,
2054 2054 _('record the current user as committer'), _('DATE'))]
2055 2055 + commitopts2 + mergetoolopts + dryrunopts,
2056 2056 _('[OPTION]... [-r REV]... REV...'))
2057 2057 def graft(ui, repo, *revs, **opts):
2058 2058 '''copy changes from other branches onto the current branch
2059 2059
2060 2060 This command uses Mercurial's merge logic to copy individual
2061 2061 changes from other branches without merging branches in the
2062 2062 history graph. This is sometimes known as 'backporting' or
2063 2063 'cherry-picking'. By default, graft will copy user, date, and
2064 2064 description from the source changesets.
2065 2065
2066 2066 Changesets that are ancestors of the current revision, that have
2067 2067 already been grafted, or that are merges will be skipped.
2068 2068
2069 2069 If --log is specified, log messages will have a comment appended
2070 2070 of the form::
2071 2071
2072 2072 (grafted from CHANGESETHASH)
2073 2073
2074 2074 If --force is specified, revisions will be grafted even if they
2075 are already ancestors of or have been grafted to the destination.
2075 are already ancestors of, or have been grafted to, the destination.
2076 2076 This is useful when the revisions have since been backed out.
2077 2077
2078 2078 If a graft merge results in conflicts, the graft process is
2079 2079 interrupted so that the current merge can be manually resolved.
2080 2080 Once all conflicts are addressed, the graft process can be
2081 2081 continued with the -c/--continue option.
2082 2082
2083 2083 .. note::
2084 2084
2085 2085 The -c/--continue option does not reapply earlier options, except
2086 2086 for --force.
2087 2087
2088 2088 .. container:: verbose
2089 2089
2090 2090 Examples:
2091 2091
2092 2092 - copy a single change to the stable branch and edit its description::
2093 2093
2094 2094 hg update stable
2095 2095 hg graft --edit 9393
2096 2096
2097 2097 - graft a range of changesets with one exception, updating dates::
2098 2098
2099 2099 hg graft -D "2085::2093 and not 2091"
2100 2100
2101 2101 - continue a graft after resolving conflicts::
2102 2102
2103 2103 hg graft -c
2104 2104
2105 2105 - show the source of a grafted changeset::
2106 2106
2107 2107 hg log --debug -r .
2108 2108
2109 2109 - show revisions sorted by date::
2110 2110
2111 2111 hg log -r "sort(all(), date)"
2112 2112
2113 2113 See :hg:`help revisions` for more about specifying revisions.
2114 2114
2115 2115 Returns 0 on successful completion.
2116 2116 '''
2117 2117 with repo.wlock():
2118 2118 return _dograft(ui, repo, *revs, **opts)
2119 2119
2120 2120 def _dograft(ui, repo, *revs, **opts):
2121 2121 opts = pycompat.byteskwargs(opts)
2122 2122 if revs and opts.get('rev'):
2123 2123 ui.warn(_('warning: inconsistent use of --rev might give unexpected '
2124 2124 'revision ordering!\n'))
2125 2125
2126 2126 revs = list(revs)
2127 2127 revs.extend(opts.get('rev'))
2128 2128
2129 2129 if not opts.get('user') and opts.get('currentuser'):
2130 2130 opts['user'] = ui.username()
2131 2131 if not opts.get('date') and opts.get('currentdate'):
2132 2132 opts['date'] = "%d %d" % util.makedate()
2133 2133
2134 2134 editor = cmdutil.getcommiteditor(editform='graft',
2135 2135 **pycompat.strkwargs(opts))
2136 2136
2137 2137 cont = False
2138 2138 if opts.get('continue'):
2139 2139 cont = True
2140 2140 if revs:
2141 2141 raise error.Abort(_("can't specify --continue and revisions"))
2142 2142 # read in unfinished revisions
2143 2143 try:
2144 2144 nodes = repo.vfs.read('graftstate').splitlines()
2145 2145 revs = [repo[node].rev() for node in nodes]
2146 2146 except IOError as inst:
2147 2147 if inst.errno != errno.ENOENT:
2148 2148 raise
2149 2149 cmdutil.wrongtooltocontinue(repo, _('graft'))
2150 2150 else:
2151 2151 cmdutil.checkunfinished(repo)
2152 2152 cmdutil.bailifchanged(repo)
2153 2153 if not revs:
2154 2154 raise error.Abort(_('no revisions specified'))
2155 2155 revs = scmutil.revrange(repo, revs)
2156 2156
2157 2157 skipped = set()
2158 2158 # check for merges
2159 2159 for rev in repo.revs('%ld and merge()', revs):
2160 2160 ui.warn(_('skipping ungraftable merge revision %d\n') % rev)
2161 2161 skipped.add(rev)
2162 2162 revs = [r for r in revs if r not in skipped]
2163 2163 if not revs:
2164 2164 return -1
2165 2165
2166 2166 # Don't check in the --continue case, in effect retaining --force across
2167 2167 # --continues. That's because without --force, any revisions we decided to
2168 2168 # skip would have been filtered out here, so they wouldn't have made their
2169 2169 # way to the graftstate. With --force, any revisions we would have otherwise
2170 2170 # skipped would not have been filtered out, and if they hadn't been applied
2171 2171 # already, they'd have been in the graftstate.
2172 2172 if not (cont or opts.get('force')):
2173 2173 # check for ancestors of dest branch
2174 2174 crev = repo['.'].rev()
2175 2175 ancestors = repo.changelog.ancestors([crev], inclusive=True)
2176 2176 # XXX make this lazy in the future
2177 2177 # don't mutate while iterating, create a copy
2178 2178 for rev in list(revs):
2179 2179 if rev in ancestors:
2180 2180 ui.warn(_('skipping ancestor revision %d:%s\n') %
2181 2181 (rev, repo[rev]))
2182 2182 # XXX remove on list is slow
2183 2183 revs.remove(rev)
2184 2184 if not revs:
2185 2185 return -1
2186 2186
2187 2187 # analyze revs for earlier grafts
2188 2188 ids = {}
2189 2189 for ctx in repo.set("%ld", revs):
2190 2190 ids[ctx.hex()] = ctx.rev()
2191 2191 n = ctx.extra().get('source')
2192 2192 if n:
2193 2193 ids[n] = ctx.rev()
2194 2194
2195 2195 # check ancestors for earlier grafts
2196 2196 ui.debug('scanning for duplicate grafts\n')
2197 2197
2198 2198 # The only changesets we can be sure doesn't contain grafts of any
2199 2199 # revs, are the ones that are common ancestors of *all* revs:
2200 2200 for rev in repo.revs('only(%d,ancestor(%ld))', crev, revs):
2201 2201 ctx = repo[rev]
2202 2202 n = ctx.extra().get('source')
2203 2203 if n in ids:
2204 2204 try:
2205 2205 r = repo[n].rev()
2206 2206 except error.RepoLookupError:
2207 2207 r = None
2208 2208 if r in revs:
2209 2209 ui.warn(_('skipping revision %d:%s '
2210 2210 '(already grafted to %d:%s)\n')
2211 2211 % (r, repo[r], rev, ctx))
2212 2212 revs.remove(r)
2213 2213 elif ids[n] in revs:
2214 2214 if r is None:
2215 2215 ui.warn(_('skipping already grafted revision %d:%s '
2216 2216 '(%d:%s also has unknown origin %s)\n')
2217 2217 % (ids[n], repo[ids[n]], rev, ctx, n[:12]))
2218 2218 else:
2219 2219 ui.warn(_('skipping already grafted revision %d:%s '
2220 2220 '(%d:%s also has origin %d:%s)\n')
2221 2221 % (ids[n], repo[ids[n]], rev, ctx, r, n[:12]))
2222 2222 revs.remove(ids[n])
2223 2223 elif ctx.hex() in ids:
2224 2224 r = ids[ctx.hex()]
2225 2225 ui.warn(_('skipping already grafted revision %d:%s '
2226 2226 '(was grafted from %d:%s)\n') %
2227 2227 (r, repo[r], rev, ctx))
2228 2228 revs.remove(r)
2229 2229 if not revs:
2230 2230 return -1
2231 2231
2232 2232 for pos, ctx in enumerate(repo.set("%ld", revs)):
2233 2233 desc = '%d:%s "%s"' % (ctx.rev(), ctx,
2234 2234 ctx.description().split('\n', 1)[0])
2235 2235 names = repo.nodetags(ctx.node()) + repo.nodebookmarks(ctx.node())
2236 2236 if names:
2237 2237 desc += ' (%s)' % ' '.join(names)
2238 2238 ui.status(_('grafting %s\n') % desc)
2239 2239 if opts.get('dry_run'):
2240 2240 continue
2241 2241
2242 2242 source = ctx.extra().get('source')
2243 2243 extra = {}
2244 2244 if source:
2245 2245 extra['source'] = source
2246 2246 extra['intermediate-source'] = ctx.hex()
2247 2247 else:
2248 2248 extra['source'] = ctx.hex()
2249 2249 user = ctx.user()
2250 2250 if opts.get('user'):
2251 2251 user = opts['user']
2252 2252 date = ctx.date()
2253 2253 if opts.get('date'):
2254 2254 date = opts['date']
2255 2255 message = ctx.description()
2256 2256 if opts.get('log'):
2257 2257 message += '\n(grafted from %s)' % ctx.hex()
2258 2258
2259 2259 # we don't merge the first commit when continuing
2260 2260 if not cont:
2261 2261 # perform the graft merge with p1(rev) as 'ancestor'
2262 2262 try:
2263 2263 # ui.forcemerge is an internal variable, do not document
2264 2264 repo.ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
2265 2265 'graft')
2266 2266 stats = mergemod.graft(repo, ctx, ctx.p1(),
2267 2267 ['local', 'graft'])
2268 2268 finally:
2269 2269 repo.ui.setconfig('ui', 'forcemerge', '', 'graft')
2270 2270 # report any conflicts
2271 2271 if stats and stats[3] > 0:
2272 2272 # write out state for --continue
2273 2273 nodelines = [repo[rev].hex() + "\n" for rev in revs[pos:]]
2274 2274 repo.vfs.write('graftstate', ''.join(nodelines))
2275 2275 extra = ''
2276 2276 if opts.get('user'):
2277 2277 extra += ' --user %s' % util.shellquote(opts['user'])
2278 2278 if opts.get('date'):
2279 2279 extra += ' --date %s' % util.shellquote(opts['date'])
2280 2280 if opts.get('log'):
2281 2281 extra += ' --log'
2282 2282 hint=_("use 'hg resolve' and 'hg graft --continue%s'") % extra
2283 2283 raise error.Abort(
2284 2284 _("unresolved conflicts, can't continue"),
2285 2285 hint=hint)
2286 2286 else:
2287 2287 cont = False
2288 2288
2289 2289 # commit
2290 2290 node = repo.commit(text=message, user=user,
2291 2291 date=date, extra=extra, editor=editor)
2292 2292 if node is None:
2293 2293 ui.warn(
2294 2294 _('note: graft of %d:%s created no changes to commit\n') %
2295 2295 (ctx.rev(), ctx))
2296 2296
2297 2297 # remove state when we complete successfully
2298 2298 if not opts.get('dry_run'):
2299 2299 repo.vfs.unlinkpath('graftstate', ignoremissing=True)
2300 2300
2301 2301 return 0
2302 2302
2303 2303 @command('grep',
2304 2304 [('0', 'print0', None, _('end fields with NUL')),
2305 2305 ('', 'all', None, _('print all revisions that match')),
2306 2306 ('a', 'text', None, _('treat all files as text')),
2307 2307 ('f', 'follow', None,
2308 2308 _('follow changeset history,'
2309 2309 ' or file history across copies and renames')),
2310 2310 ('i', 'ignore-case', None, _('ignore case when matching')),
2311 2311 ('l', 'files-with-matches', None,
2312 2312 _('print only filenames and revisions that match')),
2313 2313 ('n', 'line-number', None, _('print matching line numbers')),
2314 2314 ('r', 'rev', [],
2315 2315 _('only search files changed within revision range'), _('REV')),
2316 2316 ('u', 'user', None, _('list the author (long with -v)')),
2317 2317 ('d', 'date', None, _('list the date (short with -q)')),
2318 2318 ] + formatteropts + walkopts,
2319 2319 _('[OPTION]... PATTERN [FILE]...'),
2320 2320 inferrepo=True)
2321 2321 def grep(ui, repo, pattern, *pats, **opts):
2322 2322 """search revision history for a pattern in specified files
2323 2323
2324 2324 Search revision history for a regular expression in the specified
2325 2325 files or the entire project.
2326 2326
2327 2327 By default, grep prints the most recent revision number for each
2328 2328 file in which it finds a match. To get it to print every revision
2329 2329 that contains a change in match status ("-" for a match that becomes
2330 2330 a non-match, or "+" for a non-match that becomes a match), use the
2331 2331 --all flag.
2332 2332
2333 2333 PATTERN can be any Python (roughly Perl-compatible) regular
2334 2334 expression.
2335 2335
2336 2336 If no FILEs are specified (and -f/--follow isn't set), all files in
2337 2337 the repository are searched, including those that don't exist in the
2338 2338 current branch or have been deleted in a prior changeset.
2339 2339
2340 2340 Returns 0 if a match is found, 1 otherwise.
2341 2341 """
2342 2342 opts = pycompat.byteskwargs(opts)
2343 2343 reflags = re.M
2344 2344 if opts.get('ignore_case'):
2345 2345 reflags |= re.I
2346 2346 try:
2347 2347 regexp = util.re.compile(pattern, reflags)
2348 2348 except re.error as inst:
2349 2349 ui.warn(_("grep: invalid match pattern: %s\n") % inst)
2350 2350 return 1
2351 2351 sep, eol = ':', '\n'
2352 2352 if opts.get('print0'):
2353 2353 sep = eol = '\0'
2354 2354
2355 2355 getfile = util.lrucachefunc(repo.file)
2356 2356
2357 2357 def matchlines(body):
2358 2358 begin = 0
2359 2359 linenum = 0
2360 2360 while begin < len(body):
2361 2361 match = regexp.search(body, begin)
2362 2362 if not match:
2363 2363 break
2364 2364 mstart, mend = match.span()
2365 2365 linenum += body.count('\n', begin, mstart) + 1
2366 2366 lstart = body.rfind('\n', begin, mstart) + 1 or begin
2367 2367 begin = body.find('\n', mend) + 1 or len(body) + 1
2368 2368 lend = begin - 1
2369 2369 yield linenum, mstart - lstart, mend - lstart, body[lstart:lend]
2370 2370
2371 2371 class linestate(object):
2372 2372 def __init__(self, line, linenum, colstart, colend):
2373 2373 self.line = line
2374 2374 self.linenum = linenum
2375 2375 self.colstart = colstart
2376 2376 self.colend = colend
2377 2377
2378 2378 def __hash__(self):
2379 2379 return hash((self.linenum, self.line))
2380 2380
2381 2381 def __eq__(self, other):
2382 2382 return self.line == other.line
2383 2383
2384 2384 def findpos(self):
2385 2385 """Iterate all (start, end) indices of matches"""
2386 2386 yield self.colstart, self.colend
2387 2387 p = self.colend
2388 2388 while p < len(self.line):
2389 2389 m = regexp.search(self.line, p)
2390 2390 if not m:
2391 2391 break
2392 2392 yield m.span()
2393 2393 p = m.end()
2394 2394
2395 2395 matches = {}
2396 2396 copies = {}
2397 2397 def grepbody(fn, rev, body):
2398 2398 matches[rev].setdefault(fn, [])
2399 2399 m = matches[rev][fn]
2400 2400 for lnum, cstart, cend, line in matchlines(body):
2401 2401 s = linestate(line, lnum, cstart, cend)
2402 2402 m.append(s)
2403 2403
2404 2404 def difflinestates(a, b):
2405 2405 sm = difflib.SequenceMatcher(None, a, b)
2406 2406 for tag, alo, ahi, blo, bhi in sm.get_opcodes():
2407 2407 if tag == 'insert':
2408 2408 for i in xrange(blo, bhi):
2409 2409 yield ('+', b[i])
2410 2410 elif tag == 'delete':
2411 2411 for i in xrange(alo, ahi):
2412 2412 yield ('-', a[i])
2413 2413 elif tag == 'replace':
2414 2414 for i in xrange(alo, ahi):
2415 2415 yield ('-', a[i])
2416 2416 for i in xrange(blo, bhi):
2417 2417 yield ('+', b[i])
2418 2418
2419 2419 def display(fm, fn, ctx, pstates, states):
2420 2420 rev = ctx.rev()
2421 2421 if fm.isplain():
2422 2422 formatuser = ui.shortuser
2423 2423 else:
2424 2424 formatuser = str
2425 2425 if ui.quiet:
2426 2426 datefmt = '%Y-%m-%d'
2427 2427 else:
2428 2428 datefmt = '%a %b %d %H:%M:%S %Y %1%2'
2429 2429 found = False
2430 2430 @util.cachefunc
2431 2431 def binary():
2432 2432 flog = getfile(fn)
2433 2433 return util.binary(flog.read(ctx.filenode(fn)))
2434 2434
2435 2435 fieldnamemap = {'filename': 'file', 'linenumber': 'line_number'}
2436 2436 if opts.get('all'):
2437 2437 iter = difflinestates(pstates, states)
2438 2438 else:
2439 2439 iter = [('', l) for l in states]
2440 2440 for change, l in iter:
2441 2441 fm.startitem()
2442 2442 fm.data(node=fm.hexfunc(ctx.node()))
2443 2443 cols = [
2444 2444 ('filename', fn, True),
2445 2445 ('rev', rev, True),
2446 2446 ('linenumber', l.linenum, opts.get('line_number')),
2447 2447 ]
2448 2448 if opts.get('all'):
2449 2449 cols.append(('change', change, True))
2450 2450 cols.extend([
2451 2451 ('user', formatuser(ctx.user()), opts.get('user')),
2452 2452 ('date', fm.formatdate(ctx.date(), datefmt), opts.get('date')),
2453 2453 ])
2454 2454 lastcol = next(name for name, data, cond in reversed(cols) if cond)
2455 2455 for name, data, cond in cols:
2456 2456 field = fieldnamemap.get(name, name)
2457 2457 fm.condwrite(cond, field, '%s', data, label='grep.%s' % name)
2458 2458 if cond and name != lastcol:
2459 2459 fm.plain(sep, label='grep.sep')
2460 2460 if not opts.get('files_with_matches'):
2461 2461 fm.plain(sep, label='grep.sep')
2462 2462 if not opts.get('text') and binary():
2463 2463 fm.plain(_(" Binary file matches"))
2464 2464 else:
2465 2465 displaymatches(fm.nested('texts'), l)
2466 2466 fm.plain(eol)
2467 2467 found = True
2468 2468 if opts.get('files_with_matches'):
2469 2469 break
2470 2470 return found
2471 2471
2472 2472 def displaymatches(fm, l):
2473 2473 p = 0
2474 2474 for s, e in l.findpos():
2475 2475 if p < s:
2476 2476 fm.startitem()
2477 2477 fm.write('text', '%s', l.line[p:s])
2478 2478 fm.data(matched=False)
2479 2479 fm.startitem()
2480 2480 fm.write('text', '%s', l.line[s:e], label='grep.match')
2481 2481 fm.data(matched=True)
2482 2482 p = e
2483 2483 if p < len(l.line):
2484 2484 fm.startitem()
2485 2485 fm.write('text', '%s', l.line[p:])
2486 2486 fm.data(matched=False)
2487 2487 fm.end()
2488 2488
2489 2489 skip = {}
2490 2490 revfiles = {}
2491 2491 match = scmutil.match(repo[None], pats, opts)
2492 2492 found = False
2493 2493 follow = opts.get('follow')
2494 2494
2495 2495 def prep(ctx, fns):
2496 2496 rev = ctx.rev()
2497 2497 pctx = ctx.p1()
2498 2498 parent = pctx.rev()
2499 2499 matches.setdefault(rev, {})
2500 2500 matches.setdefault(parent, {})
2501 2501 files = revfiles.setdefault(rev, [])
2502 2502 for fn in fns:
2503 2503 flog = getfile(fn)
2504 2504 try:
2505 2505 fnode = ctx.filenode(fn)
2506 2506 except error.LookupError:
2507 2507 continue
2508 2508
2509 2509 copied = flog.renamed(fnode)
2510 2510 copy = follow and copied and copied[0]
2511 2511 if copy:
2512 2512 copies.setdefault(rev, {})[fn] = copy
2513 2513 if fn in skip:
2514 2514 if copy:
2515 2515 skip[copy] = True
2516 2516 continue
2517 2517 files.append(fn)
2518 2518
2519 2519 if fn not in matches[rev]:
2520 2520 grepbody(fn, rev, flog.read(fnode))
2521 2521
2522 2522 pfn = copy or fn
2523 2523 if pfn not in matches[parent]:
2524 2524 try:
2525 2525 fnode = pctx.filenode(pfn)
2526 2526 grepbody(pfn, parent, flog.read(fnode))
2527 2527 except error.LookupError:
2528 2528 pass
2529 2529
2530 2530 ui.pager('grep')
2531 2531 fm = ui.formatter('grep', opts)
2532 2532 for ctx in cmdutil.walkchangerevs(repo, match, opts, prep):
2533 2533 rev = ctx.rev()
2534 2534 parent = ctx.p1().rev()
2535 2535 for fn in sorted(revfiles.get(rev, [])):
2536 2536 states = matches[rev][fn]
2537 2537 copy = copies.get(rev, {}).get(fn)
2538 2538 if fn in skip:
2539 2539 if copy:
2540 2540 skip[copy] = True
2541 2541 continue
2542 2542 pstates = matches.get(parent, {}).get(copy or fn, [])
2543 2543 if pstates or states:
2544 2544 r = display(fm, fn, ctx, pstates, states)
2545 2545 found = found or r
2546 2546 if r and not opts.get('all'):
2547 2547 skip[fn] = True
2548 2548 if copy:
2549 2549 skip[copy] = True
2550 2550 del matches[rev]
2551 2551 del revfiles[rev]
2552 2552 fm.end()
2553 2553
2554 2554 return not found
2555 2555
2556 2556 @command('heads',
2557 2557 [('r', 'rev', '',
2558 2558 _('show only heads which are descendants of STARTREV'), _('STARTREV')),
2559 2559 ('t', 'topo', False, _('show topological heads only')),
2560 2560 ('a', 'active', False, _('show active branchheads only (DEPRECATED)')),
2561 2561 ('c', 'closed', False, _('show normal and closed branch heads')),
2562 2562 ] + templateopts,
2563 2563 _('[-ct] [-r STARTREV] [REV]...'))
2564 2564 def heads(ui, repo, *branchrevs, **opts):
2565 2565 """show branch heads
2566 2566
2567 2567 With no arguments, show all open branch heads in the repository.
2568 2568 Branch heads are changesets that have no descendants on the
2569 2569 same branch. They are where development generally takes place and
2570 2570 are the usual targets for update and merge operations.
2571 2571
2572 2572 If one or more REVs are given, only open branch heads on the
2573 2573 branches associated with the specified changesets are shown. This
2574 2574 means that you can use :hg:`heads .` to see the heads on the
2575 2575 currently checked-out branch.
2576 2576
2577 2577 If -c/--closed is specified, also show branch heads marked closed
2578 2578 (see :hg:`commit --close-branch`).
2579 2579
2580 2580 If STARTREV is specified, only those heads that are descendants of
2581 2581 STARTREV will be displayed.
2582 2582
2583 2583 If -t/--topo is specified, named branch mechanics will be ignored and only
2584 2584 topological heads (changesets with no children) will be shown.
2585 2585
2586 2586 Returns 0 if matching heads are found, 1 if not.
2587 2587 """
2588 2588
2589 2589 opts = pycompat.byteskwargs(opts)
2590 2590 start = None
2591 2591 if 'rev' in opts:
2592 2592 start = scmutil.revsingle(repo, opts['rev'], None).node()
2593 2593
2594 2594 if opts.get('topo'):
2595 2595 heads = [repo[h] for h in repo.heads(start)]
2596 2596 else:
2597 2597 heads = []
2598 2598 for branch in repo.branchmap():
2599 2599 heads += repo.branchheads(branch, start, opts.get('closed'))
2600 2600 heads = [repo[h] for h in heads]
2601 2601
2602 2602 if branchrevs:
2603 2603 branches = set(repo[br].branch() for br in branchrevs)
2604 2604 heads = [h for h in heads if h.branch() in branches]
2605 2605
2606 2606 if opts.get('active') and branchrevs:
2607 2607 dagheads = repo.heads(start)
2608 2608 heads = [h for h in heads if h.node() in dagheads]
2609 2609
2610 2610 if branchrevs:
2611 2611 haveheads = set(h.branch() for h in heads)
2612 2612 if branches - haveheads:
2613 2613 headless = ', '.join(b for b in branches - haveheads)
2614 2614 msg = _('no open branch heads found on branches %s')
2615 2615 if opts.get('rev'):
2616 2616 msg += _(' (started at %s)') % opts['rev']
2617 2617 ui.warn((msg + '\n') % headless)
2618 2618
2619 2619 if not heads:
2620 2620 return 1
2621 2621
2622 2622 ui.pager('heads')
2623 2623 heads = sorted(heads, key=lambda x: -x.rev())
2624 2624 displayer = cmdutil.show_changeset(ui, repo, opts)
2625 2625 for ctx in heads:
2626 2626 displayer.show(ctx)
2627 2627 displayer.close()
2628 2628
2629 2629 @command('help',
2630 2630 [('e', 'extension', None, _('show only help for extensions')),
2631 2631 ('c', 'command', None, _('show only help for commands')),
2632 2632 ('k', 'keyword', None, _('show topics matching keyword')),
2633 2633 ('s', 'system', [], _('show help for specific platform(s)')),
2634 2634 ],
2635 2635 _('[-ecks] [TOPIC]'),
2636 2636 norepo=True)
2637 2637 def help_(ui, name=None, **opts):
2638 2638 """show help for a given topic or a help overview
2639 2639
2640 2640 With no arguments, print a list of commands with short help messages.
2641 2641
2642 2642 Given a topic, extension, or command name, print help for that
2643 2643 topic.
2644 2644
2645 2645 Returns 0 if successful.
2646 2646 """
2647 2647
2648 2648 keep = opts.get(r'system') or []
2649 2649 if len(keep) == 0:
2650 2650 if pycompat.sysplatform.startswith('win'):
2651 2651 keep.append('windows')
2652 2652 elif pycompat.sysplatform == 'OpenVMS':
2653 2653 keep.append('vms')
2654 2654 elif pycompat.sysplatform == 'plan9':
2655 2655 keep.append('plan9')
2656 2656 else:
2657 2657 keep.append('unix')
2658 2658 keep.append(pycompat.sysplatform.lower())
2659 2659 if ui.verbose:
2660 2660 keep.append('verbose')
2661 2661
2662 2662 commands = sys.modules[__name__]
2663 2663 formatted = help.formattedhelp(ui, commands, name, keep=keep, **opts)
2664 2664 ui.pager('help')
2665 2665 ui.write(formatted)
2666 2666
2667 2667
2668 2668 @command('identify|id',
2669 2669 [('r', 'rev', '',
2670 2670 _('identify the specified revision'), _('REV')),
2671 2671 ('n', 'num', None, _('show local revision number')),
2672 2672 ('i', 'id', None, _('show global revision id')),
2673 2673 ('b', 'branch', None, _('show branch')),
2674 2674 ('t', 'tags', None, _('show tags')),
2675 2675 ('B', 'bookmarks', None, _('show bookmarks')),
2676 2676 ] + remoteopts + formatteropts,
2677 2677 _('[-nibtB] [-r REV] [SOURCE]'),
2678 2678 optionalrepo=True)
2679 2679 def identify(ui, repo, source=None, rev=None,
2680 2680 num=None, id=None, branch=None, tags=None, bookmarks=None, **opts):
2681 2681 """identify the working directory or specified revision
2682 2682
2683 2683 Print a summary identifying the repository state at REV using one or
2684 2684 two parent hash identifiers, followed by a "+" if the working
2685 2685 directory has uncommitted changes, the branch name (if not default),
2686 2686 a list of tags, and a list of bookmarks.
2687 2687
2688 2688 When REV is not given, print a summary of the current state of the
2689 2689 repository.
2690 2690
2691 2691 Specifying a path to a repository root or Mercurial bundle will
2692 2692 cause lookup to operate on that repository/bundle.
2693 2693
2694 2694 .. container:: verbose
2695 2695
2696 2696 Examples:
2697 2697
2698 2698 - generate a build identifier for the working directory::
2699 2699
2700 2700 hg id --id > build-id.dat
2701 2701
2702 2702 - find the revision corresponding to a tag::
2703 2703
2704 2704 hg id -n -r 1.3
2705 2705
2706 2706 - check the most recent revision of a remote repository::
2707 2707
2708 2708 hg id -r tip https://www.mercurial-scm.org/repo/hg/
2709 2709
2710 2710 See :hg:`log` for generating more information about specific revisions,
2711 2711 including full hash identifiers.
2712 2712
2713 2713 Returns 0 if successful.
2714 2714 """
2715 2715
2716 2716 opts = pycompat.byteskwargs(opts)
2717 2717 if not repo and not source:
2718 2718 raise error.Abort(_("there is no Mercurial repository here "
2719 2719 "(.hg not found)"))
2720 2720
2721 2721 if ui.debugflag:
2722 2722 hexfunc = hex
2723 2723 else:
2724 2724 hexfunc = short
2725 2725 default = not (num or id or branch or tags or bookmarks)
2726 2726 output = []
2727 2727 revs = []
2728 2728
2729 2729 if source:
2730 2730 source, branches = hg.parseurl(ui.expandpath(source))
2731 2731 peer = hg.peer(repo or ui, opts, source) # only pass ui when no repo
2732 2732 repo = peer.local()
2733 2733 revs, checkout = hg.addbranchrevs(repo, peer, branches, None)
2734 2734
2735 2735 fm = ui.formatter('identify', opts)
2736 2736 fm.startitem()
2737 2737
2738 2738 if not repo:
2739 2739 if num or branch or tags:
2740 2740 raise error.Abort(
2741 2741 _("can't query remote revision number, branch, or tags"))
2742 2742 if not rev and revs:
2743 2743 rev = revs[0]
2744 2744 if not rev:
2745 2745 rev = "tip"
2746 2746
2747 2747 remoterev = peer.lookup(rev)
2748 2748 hexrev = hexfunc(remoterev)
2749 2749 if default or id:
2750 2750 output = [hexrev]
2751 2751 fm.data(id=hexrev)
2752 2752
2753 2753 def getbms():
2754 2754 bms = []
2755 2755
2756 2756 if 'bookmarks' in peer.listkeys('namespaces'):
2757 2757 hexremoterev = hex(remoterev)
2758 2758 bms = [bm for bm, bmr in peer.listkeys('bookmarks').iteritems()
2759 2759 if bmr == hexremoterev]
2760 2760
2761 2761 return sorted(bms)
2762 2762
2763 2763 bms = getbms()
2764 2764 if bookmarks:
2765 2765 output.extend(bms)
2766 2766 elif default and not ui.quiet:
2767 2767 # multiple bookmarks for a single parent separated by '/'
2768 2768 bm = '/'.join(bms)
2769 2769 if bm:
2770 2770 output.append(bm)
2771 2771
2772 2772 fm.data(node=hex(remoterev))
2773 2773 fm.data(bookmarks=fm.formatlist(bms, name='bookmark'))
2774 2774 else:
2775 2775 ctx = scmutil.revsingle(repo, rev, None)
2776 2776
2777 2777 if ctx.rev() is None:
2778 2778 ctx = repo[None]
2779 2779 parents = ctx.parents()
2780 2780 taglist = []
2781 2781 for p in parents:
2782 2782 taglist.extend(p.tags())
2783 2783
2784 2784 dirty = ""
2785 2785 if ctx.dirty(missing=True, merge=False, branch=False):
2786 2786 dirty = '+'
2787 2787 fm.data(dirty=dirty)
2788 2788
2789 2789 hexoutput = [hexfunc(p.node()) for p in parents]
2790 2790 if default or id:
2791 2791 output = ["%s%s" % ('+'.join(hexoutput), dirty)]
2792 2792 fm.data(id="%s%s" % ('+'.join(hexoutput), dirty))
2793 2793
2794 2794 if num:
2795 2795 numoutput = ["%d" % p.rev() for p in parents]
2796 2796 output.append("%s%s" % ('+'.join(numoutput), dirty))
2797 2797
2798 2798 fn = fm.nested('parents')
2799 2799 for p in parents:
2800 2800 fn.startitem()
2801 2801 fn.data(rev=p.rev())
2802 2802 fn.data(node=p.hex())
2803 2803 fn.context(ctx=p)
2804 2804 fn.end()
2805 2805 else:
2806 2806 hexoutput = hexfunc(ctx.node())
2807 2807 if default or id:
2808 2808 output = [hexoutput]
2809 2809 fm.data(id=hexoutput)
2810 2810
2811 2811 if num:
2812 2812 output.append(pycompat.bytestr(ctx.rev()))
2813 2813 taglist = ctx.tags()
2814 2814
2815 2815 if default and not ui.quiet:
2816 2816 b = ctx.branch()
2817 2817 if b != 'default':
2818 2818 output.append("(%s)" % b)
2819 2819
2820 2820 # multiple tags for a single parent separated by '/'
2821 2821 t = '/'.join(taglist)
2822 2822 if t:
2823 2823 output.append(t)
2824 2824
2825 2825 # multiple bookmarks for a single parent separated by '/'
2826 2826 bm = '/'.join(ctx.bookmarks())
2827 2827 if bm:
2828 2828 output.append(bm)
2829 2829 else:
2830 2830 if branch:
2831 2831 output.append(ctx.branch())
2832 2832
2833 2833 if tags:
2834 2834 output.extend(taglist)
2835 2835
2836 2836 if bookmarks:
2837 2837 output.extend(ctx.bookmarks())
2838 2838
2839 2839 fm.data(node=ctx.hex())
2840 2840 fm.data(branch=ctx.branch())
2841 2841 fm.data(tags=fm.formatlist(taglist, name='tag', sep=':'))
2842 2842 fm.data(bookmarks=fm.formatlist(ctx.bookmarks(), name='bookmark'))
2843 2843 fm.context(ctx=ctx)
2844 2844
2845 2845 fm.plain("%s\n" % ' '.join(output))
2846 2846 fm.end()
2847 2847
2848 2848 @command('import|patch',
2849 2849 [('p', 'strip', 1,
2850 2850 _('directory strip option for patch. This has the same '
2851 2851 'meaning as the corresponding patch option'), _('NUM')),
2852 2852 ('b', 'base', '', _('base path (DEPRECATED)'), _('PATH')),
2853 2853 ('e', 'edit', False, _('invoke editor on commit messages')),
2854 2854 ('f', 'force', None,
2855 2855 _('skip check for outstanding uncommitted changes (DEPRECATED)')),
2856 2856 ('', 'no-commit', None,
2857 2857 _("don't commit, just update the working directory")),
2858 2858 ('', 'bypass', None,
2859 2859 _("apply patch without touching the working directory")),
2860 2860 ('', 'partial', None,
2861 2861 _('commit even if some hunks fail')),
2862 2862 ('', 'exact', None,
2863 2863 _('abort if patch would apply lossily')),
2864 2864 ('', 'prefix', '',
2865 2865 _('apply patch to subdirectory'), _('DIR')),
2866 2866 ('', 'import-branch', None,
2867 2867 _('use any branch information in patch (implied by --exact)'))] +
2868 2868 commitopts + commitopts2 + similarityopts,
2869 2869 _('[OPTION]... PATCH...'))
2870 2870 def import_(ui, repo, patch1=None, *patches, **opts):
2871 2871 """import an ordered set of patches
2872 2872
2873 2873 Import a list of patches and commit them individually (unless
2874 2874 --no-commit is specified).
2875 2875
2876 2876 To read a patch from standard input (stdin), use "-" as the patch
2877 2877 name. If a URL is specified, the patch will be downloaded from
2878 2878 there.
2879 2879
2880 2880 Import first applies changes to the working directory (unless
2881 2881 --bypass is specified), import will abort if there are outstanding
2882 2882 changes.
2883 2883
2884 2884 Use --bypass to apply and commit patches directly to the
2885 2885 repository, without affecting the working directory. Without
2886 2886 --exact, patches will be applied on top of the working directory
2887 2887 parent revision.
2888 2888
2889 2889 You can import a patch straight from a mail message. Even patches
2890 2890 as attachments work (to use the body part, it must have type
2891 2891 text/plain or text/x-patch). From and Subject headers of email
2892 2892 message are used as default committer and commit message. All
2893 2893 text/plain body parts before first diff are added to the commit
2894 2894 message.
2895 2895
2896 2896 If the imported patch was generated by :hg:`export`, user and
2897 2897 description from patch override values from message headers and
2898 2898 body. Values given on command line with -m/--message and -u/--user
2899 2899 override these.
2900 2900
2901 2901 If --exact is specified, import will set the working directory to
2902 2902 the parent of each patch before applying it, and will abort if the
2903 2903 resulting changeset has a different ID than the one recorded in
2904 2904 the patch. This will guard against various ways that portable
2905 2905 patch formats and mail systems might fail to transfer Mercurial
2906 2906 data or metadata. See :hg:`bundle` for lossless transmission.
2907 2907
2908 2908 Use --partial to ensure a changeset will be created from the patch
2909 2909 even if some hunks fail to apply. Hunks that fail to apply will be
2910 2910 written to a <target-file>.rej file. Conflicts can then be resolved
2911 2911 by hand before :hg:`commit --amend` is run to update the created
2912 2912 changeset. This flag exists to let people import patches that
2913 2913 partially apply without losing the associated metadata (author,
2914 2914 date, description, ...).
2915 2915
2916 2916 .. note::
2917 2917
2918 2918 When no hunks apply cleanly, :hg:`import --partial` will create
2919 2919 an empty changeset, importing only the patch metadata.
2920 2920
2921 2921 With -s/--similarity, hg will attempt to discover renames and
2922 2922 copies in the patch in the same way as :hg:`addremove`.
2923 2923
2924 2924 It is possible to use external patch programs to perform the patch
2925 2925 by setting the ``ui.patch`` configuration option. For the default
2926 2926 internal tool, the fuzz can also be configured via ``patch.fuzz``.
2927 2927 See :hg:`help config` for more information about configuration
2928 2928 files and how to use these options.
2929 2929
2930 2930 See :hg:`help dates` for a list of formats valid for -d/--date.
2931 2931
2932 2932 .. container:: verbose
2933 2933
2934 2934 Examples:
2935 2935
2936 2936 - import a traditional patch from a website and detect renames::
2937 2937
2938 2938 hg import -s 80 http://example.com/bugfix.patch
2939 2939
2940 2940 - import a changeset from an hgweb server::
2941 2941
2942 2942 hg import https://www.mercurial-scm.org/repo/hg/rev/5ca8c111e9aa
2943 2943
2944 2944 - import all the patches in an Unix-style mbox::
2945 2945
2946 2946 hg import incoming-patches.mbox
2947 2947
2948 2948 - import patches from stdin::
2949 2949
2950 2950 hg import -
2951 2951
2952 2952 - attempt to exactly restore an exported changeset (not always
2953 2953 possible)::
2954 2954
2955 2955 hg import --exact proposed-fix.patch
2956 2956
2957 2957 - use an external tool to apply a patch which is too fuzzy for
2958 2958 the default internal tool.
2959 2959
2960 2960 hg import --config ui.patch="patch --merge" fuzzy.patch
2961 2961
2962 2962 - change the default fuzzing from 2 to a less strict 7
2963 2963
2964 2964 hg import --config ui.fuzz=7 fuzz.patch
2965 2965
2966 2966 Returns 0 on success, 1 on partial success (see --partial).
2967 2967 """
2968 2968
2969 2969 opts = pycompat.byteskwargs(opts)
2970 2970 if not patch1:
2971 2971 raise error.Abort(_('need at least one patch to import'))
2972 2972
2973 2973 patches = (patch1,) + patches
2974 2974
2975 2975 date = opts.get('date')
2976 2976 if date:
2977 2977 opts['date'] = util.parsedate(date)
2978 2978
2979 2979 exact = opts.get('exact')
2980 2980 update = not opts.get('bypass')
2981 2981 if not update and opts.get('no_commit'):
2982 2982 raise error.Abort(_('cannot use --no-commit with --bypass'))
2983 2983 try:
2984 2984 sim = float(opts.get('similarity') or 0)
2985 2985 except ValueError:
2986 2986 raise error.Abort(_('similarity must be a number'))
2987 2987 if sim < 0 or sim > 100:
2988 2988 raise error.Abort(_('similarity must be between 0 and 100'))
2989 2989 if sim and not update:
2990 2990 raise error.Abort(_('cannot use --similarity with --bypass'))
2991 2991 if exact:
2992 2992 if opts.get('edit'):
2993 2993 raise error.Abort(_('cannot use --exact with --edit'))
2994 2994 if opts.get('prefix'):
2995 2995 raise error.Abort(_('cannot use --exact with --prefix'))
2996 2996
2997 2997 base = opts["base"]
2998 2998 wlock = dsguard = lock = tr = None
2999 2999 msgs = []
3000 3000 ret = 0
3001 3001
3002 3002
3003 3003 try:
3004 3004 wlock = repo.wlock()
3005 3005
3006 3006 if update:
3007 3007 cmdutil.checkunfinished(repo)
3008 3008 if (exact or not opts.get('force')):
3009 3009 cmdutil.bailifchanged(repo)
3010 3010
3011 3011 if not opts.get('no_commit'):
3012 3012 lock = repo.lock()
3013 3013 tr = repo.transaction('import')
3014 3014 else:
3015 3015 dsguard = dirstateguard.dirstateguard(repo, 'import')
3016 3016 parents = repo[None].parents()
3017 3017 for patchurl in patches:
3018 3018 if patchurl == '-':
3019 3019 ui.status(_('applying patch from stdin\n'))
3020 3020 patchfile = ui.fin
3021 3021 patchurl = 'stdin' # for error message
3022 3022 else:
3023 3023 patchurl = os.path.join(base, patchurl)
3024 3024 ui.status(_('applying %s\n') % patchurl)
3025 3025 patchfile = hg.openpath(ui, patchurl)
3026 3026
3027 3027 haspatch = False
3028 3028 for hunk in patch.split(patchfile):
3029 3029 (msg, node, rej) = cmdutil.tryimportone(ui, repo, hunk,
3030 3030 parents, opts,
3031 3031 msgs, hg.clean)
3032 3032 if msg:
3033 3033 haspatch = True
3034 3034 ui.note(msg + '\n')
3035 3035 if update or exact:
3036 3036 parents = repo[None].parents()
3037 3037 else:
3038 3038 parents = [repo[node]]
3039 3039 if rej:
3040 3040 ui.write_err(_("patch applied partially\n"))
3041 3041 ui.write_err(_("(fix the .rej files and run "
3042 3042 "`hg commit --amend`)\n"))
3043 3043 ret = 1
3044 3044 break
3045 3045
3046 3046 if not haspatch:
3047 3047 raise error.Abort(_('%s: no diffs found') % patchurl)
3048 3048
3049 3049 if tr:
3050 3050 tr.close()
3051 3051 if msgs:
3052 3052 repo.savecommitmessage('\n* * *\n'.join(msgs))
3053 3053 if dsguard:
3054 3054 dsguard.close()
3055 3055 return ret
3056 3056 finally:
3057 3057 if tr:
3058 3058 tr.release()
3059 3059 release(lock, dsguard, wlock)
3060 3060
3061 3061 @command('incoming|in',
3062 3062 [('f', 'force', None,
3063 3063 _('run even if remote repository is unrelated')),
3064 3064 ('n', 'newest-first', None, _('show newest record first')),
3065 3065 ('', 'bundle', '',
3066 3066 _('file to store the bundles into'), _('FILE')),
3067 3067 ('r', 'rev', [], _('a remote changeset intended to be added'), _('REV')),
3068 3068 ('B', 'bookmarks', False, _("compare bookmarks")),
3069 3069 ('b', 'branch', [],
3070 3070 _('a specific branch you would like to pull'), _('BRANCH')),
3071 3071 ] + logopts + remoteopts + subrepoopts,
3072 3072 _('[-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]'))
3073 3073 def incoming(ui, repo, source="default", **opts):
3074 3074 """show new changesets found in source
3075 3075
3076 3076 Show new changesets found in the specified path/URL or the default
3077 3077 pull location. These are the changesets that would have been pulled
3078 if a pull at the time you issued this command.
3078 by :hg:`pull` at the time you issued this command.
3079 3079
3080 3080 See pull for valid source format details.
3081 3081
3082 3082 .. container:: verbose
3083 3083
3084 3084 With -B/--bookmarks, the result of bookmark comparison between
3085 3085 local and remote repositories is displayed. With -v/--verbose,
3086 3086 status is also displayed for each bookmark like below::
3087 3087
3088 3088 BM1 01234567890a added
3089 3089 BM2 1234567890ab advanced
3090 3090 BM3 234567890abc diverged
3091 3091 BM4 34567890abcd changed
3092 3092
3093 3093 The action taken locally when pulling depends on the
3094 3094 status of each bookmark:
3095 3095
3096 3096 :``added``: pull will create it
3097 3097 :``advanced``: pull will update it
3098 3098 :``diverged``: pull will create a divergent bookmark
3099 3099 :``changed``: result depends on remote changesets
3100 3100
3101 3101 From the point of view of pulling behavior, bookmark
3102 3102 existing only in the remote repository are treated as ``added``,
3103 3103 even if it is in fact locally deleted.
3104 3104
3105 3105 .. container:: verbose
3106 3106
3107 3107 For remote repository, using --bundle avoids downloading the
3108 3108 changesets twice if the incoming is followed by a pull.
3109 3109
3110 3110 Examples:
3111 3111
3112 3112 - show incoming changes with patches and full description::
3113 3113
3114 3114 hg incoming -vp
3115 3115
3116 3116 - show incoming changes excluding merges, store a bundle::
3117 3117
3118 3118 hg in -vpM --bundle incoming.hg
3119 3119 hg pull incoming.hg
3120 3120
3121 3121 - briefly list changes inside a bundle::
3122 3122
3123 3123 hg in changes.hg -T "{desc|firstline}\\n"
3124 3124
3125 3125 Returns 0 if there are incoming changes, 1 otherwise.
3126 3126 """
3127 3127 opts = pycompat.byteskwargs(opts)
3128 3128 if opts.get('graph'):
3129 3129 cmdutil.checkunsupportedgraphflags([], opts)
3130 3130 def display(other, chlist, displayer):
3131 3131 revdag = cmdutil.graphrevs(other, chlist, opts)
3132 3132 cmdutil.displaygraph(ui, repo, revdag, displayer,
3133 3133 graphmod.asciiedges)
3134 3134
3135 3135 hg._incoming(display, lambda: 1, ui, repo, source, opts, buffered=True)
3136 3136 return 0
3137 3137
3138 3138 if opts.get('bundle') and opts.get('subrepos'):
3139 3139 raise error.Abort(_('cannot combine --bundle and --subrepos'))
3140 3140
3141 3141 if opts.get('bookmarks'):
3142 3142 source, branches = hg.parseurl(ui.expandpath(source),
3143 3143 opts.get('branch'))
3144 3144 other = hg.peer(repo, opts, source)
3145 3145 if 'bookmarks' not in other.listkeys('namespaces'):
3146 3146 ui.warn(_("remote doesn't support bookmarks\n"))
3147 3147 return 0
3148 3148 ui.pager('incoming')
3149 3149 ui.status(_('comparing with %s\n') % util.hidepassword(source))
3150 3150 return bookmarks.incoming(ui, repo, other)
3151 3151
3152 3152 repo._subtoppath = ui.expandpath(source)
3153 3153 try:
3154 3154 return hg.incoming(ui, repo, source, opts)
3155 3155 finally:
3156 3156 del repo._subtoppath
3157 3157
3158 3158
3159 3159 @command('^init', remoteopts, _('[-e CMD] [--remotecmd CMD] [DEST]'),
3160 3160 norepo=True)
3161 3161 def init(ui, dest=".", **opts):
3162 3162 """create a new repository in the given directory
3163 3163
3164 3164 Initialize a new repository in the given directory. If the given
3165 3165 directory does not exist, it will be created.
3166 3166
3167 3167 If no directory is given, the current directory is used.
3168 3168
3169 3169 It is possible to specify an ``ssh://`` URL as the destination.
3170 3170 See :hg:`help urls` for more information.
3171 3171
3172 3172 Returns 0 on success.
3173 3173 """
3174 3174 opts = pycompat.byteskwargs(opts)
3175 3175 hg.peer(ui, opts, ui.expandpath(dest), create=True)
3176 3176
3177 3177 @command('locate',
3178 3178 [('r', 'rev', '', _('search the repository as it is in REV'), _('REV')),
3179 3179 ('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
3180 3180 ('f', 'fullpath', None, _('print complete paths from the filesystem root')),
3181 3181 ] + walkopts,
3182 3182 _('[OPTION]... [PATTERN]...'))
3183 3183 def locate(ui, repo, *pats, **opts):
3184 3184 """locate files matching specific patterns (DEPRECATED)
3185 3185
3186 3186 Print files under Mercurial control in the working directory whose
3187 3187 names match the given patterns.
3188 3188
3189 3189 By default, this command searches all directories in the working
3190 3190 directory. To search just the current directory and its
3191 3191 subdirectories, use "--include .".
3192 3192
3193 3193 If no patterns are given to match, this command prints the names
3194 3194 of all files under Mercurial control in the working directory.
3195 3195
3196 3196 If you want to feed the output of this command into the "xargs"
3197 3197 command, use the -0 option to both this command and "xargs". This
3198 3198 will avoid the problem of "xargs" treating single filenames that
3199 3199 contain whitespace as multiple filenames.
3200 3200
3201 3201 See :hg:`help files` for a more versatile command.
3202 3202
3203 3203 Returns 0 if a match is found, 1 otherwise.
3204 3204 """
3205 3205 opts = pycompat.byteskwargs(opts)
3206 3206 if opts.get('print0'):
3207 3207 end = '\0'
3208 3208 else:
3209 3209 end = '\n'
3210 3210 rev = scmutil.revsingle(repo, opts.get('rev'), None).node()
3211 3211
3212 3212 ret = 1
3213 3213 ctx = repo[rev]
3214 3214 m = scmutil.match(ctx, pats, opts, default='relglob',
3215 3215 badfn=lambda x, y: False)
3216 3216
3217 3217 ui.pager('locate')
3218 3218 for abs in ctx.matches(m):
3219 3219 if opts.get('fullpath'):
3220 3220 ui.write(repo.wjoin(abs), end)
3221 3221 else:
3222 3222 ui.write(((pats and m.rel(abs)) or abs), end)
3223 3223 ret = 0
3224 3224
3225 3225 return ret
3226 3226
3227 3227 @command('^log|history',
3228 3228 [('f', 'follow', None,
3229 3229 _('follow changeset history, or file history across copies and renames')),
3230 3230 ('', 'follow-first', None,
3231 3231 _('only follow the first parent of merge changesets (DEPRECATED)')),
3232 3232 ('d', 'date', '', _('show revisions matching date spec'), _('DATE')),
3233 3233 ('C', 'copies', None, _('show copied files')),
3234 3234 ('k', 'keyword', [],
3235 3235 _('do case-insensitive search for a given text'), _('TEXT')),
3236 3236 ('r', 'rev', [], _('show the specified revision or revset'), _('REV')),
3237 3237 ('L', 'line-range', [],
3238 3238 _('follow line range of specified file (EXPERIMENTAL)'),
3239 3239 _('FILE,RANGE')),
3240 3240 ('', 'removed', None, _('include revisions where files were removed')),
3241 3241 ('m', 'only-merges', None, _('show only merges (DEPRECATED)')),
3242 3242 ('u', 'user', [], _('revisions committed by user'), _('USER')),
3243 3243 ('', 'only-branch', [],
3244 3244 _('show only changesets within the given named branch (DEPRECATED)'),
3245 3245 _('BRANCH')),
3246 3246 ('b', 'branch', [],
3247 3247 _('show changesets within the given named branch'), _('BRANCH')),
3248 3248 ('P', 'prune', [],
3249 3249 _('do not display revision or any of its ancestors'), _('REV')),
3250 3250 ] + logopts + walkopts,
3251 3251 _('[OPTION]... [FILE]'),
3252 3252 inferrepo=True)
3253 3253 def log(ui, repo, *pats, **opts):
3254 3254 """show revision history of entire repository or files
3255 3255
3256 3256 Print the revision history of the specified files or the entire
3257 3257 project.
3258 3258
3259 3259 If no revision range is specified, the default is ``tip:0`` unless
3260 3260 --follow is set, in which case the working directory parent is
3261 3261 used as the starting revision.
3262 3262
3263 3263 File history is shown without following rename or copy history of
3264 3264 files. Use -f/--follow with a filename to follow history across
3265 3265 renames and copies. --follow without a filename will only show
3266 3266 ancestors or descendants of the starting revision.
3267 3267
3268 3268 By default this command prints revision number and changeset id,
3269 3269 tags, non-trivial parents, user, date and time, and a summary for
3270 3270 each commit. When the -v/--verbose switch is used, the list of
3271 3271 changed files and full commit message are shown.
3272 3272
3273 3273 With --graph the revisions are shown as an ASCII art DAG with the most
3274 3274 recent changeset at the top.
3275 3275 'o' is a changeset, '@' is a working directory parent, 'x' is obsolete,
3276 3276 and '+' represents a fork where the changeset from the lines below is a
3277 3277 parent of the 'o' merge on the same line.
3278 3278 Paths in the DAG are represented with '|', '/' and so forth. ':' in place
3279 3279 of a '|' indicates one or more revisions in a path are omitted.
3280 3280
3281 3281 .. container:: verbose
3282 3282
3283 3283 Use -L/--line-range FILE,M:N options to follow the history of lines
3284 3284 from M to N in FILE. With -p/--patch only diff hunks affecting
3285 3285 specified line range will be shown. This option requires --follow;
3286 3286 it can be specified multiple times. Currently, this option is not
3287 3287 compatible with --graph. This option is experimental.
3288 3288
3289 3289 .. note::
3290 3290
3291 3291 :hg:`log --patch` may generate unexpected diff output for merge
3292 3292 changesets, as it will only compare the merge changeset against
3293 3293 its first parent. Also, only files different from BOTH parents
3294 3294 will appear in files:.
3295 3295
3296 3296 .. note::
3297 3297
3298 3298 For performance reasons, :hg:`log FILE` may omit duplicate changes
3299 3299 made on branches and will not show removals or mode changes. To
3300 3300 see all such changes, use the --removed switch.
3301 3301
3302 3302 .. container:: verbose
3303 3303
3304 3304 .. note::
3305 3305
3306 3306 The history resulting from -L/--line-range options depends on diff
3307 3307 options; for instance if white-spaces are ignored, respective changes
3308 3308 with only white-spaces in specified line range will not be listed.
3309 3309
3310 3310 .. container:: verbose
3311 3311
3312 3312 Some examples:
3313 3313
3314 3314 - changesets with full descriptions and file lists::
3315 3315
3316 3316 hg log -v
3317 3317
3318 3318 - changesets ancestral to the working directory::
3319 3319
3320 3320 hg log -f
3321 3321
3322 3322 - last 10 commits on the current branch::
3323 3323
3324 3324 hg log -l 10 -b .
3325 3325
3326 3326 - changesets showing all modifications of a file, including removals::
3327 3327
3328 3328 hg log --removed file.c
3329 3329
3330 3330 - all changesets that touch a directory, with diffs, excluding merges::
3331 3331
3332 3332 hg log -Mp lib/
3333 3333
3334 3334 - all revision numbers that match a keyword::
3335 3335
3336 3336 hg log -k bug --template "{rev}\\n"
3337 3337
3338 3338 - the full hash identifier of the working directory parent::
3339 3339
3340 3340 hg log -r . --template "{node}\\n"
3341 3341
3342 3342 - list available log templates::
3343 3343
3344 3344 hg log -T list
3345 3345
3346 3346 - check if a given changeset is included in a tagged release::
3347 3347
3348 3348 hg log -r "a21ccf and ancestor(1.9)"
3349 3349
3350 3350 - find all changesets by some user in a date range::
3351 3351
3352 3352 hg log -k alice -d "may 2008 to jul 2008"
3353 3353
3354 3354 - summary of all changesets after the last tag::
3355 3355
3356 3356 hg log -r "last(tagged())::" --template "{desc|firstline}\\n"
3357 3357
3358 3358 - changesets touching lines 13 to 23 for file.c::
3359 3359
3360 3360 hg log -L file.c,13:23
3361 3361
3362 3362 - changesets touching lines 13 to 23 for file.c and lines 2 to 6 of
3363 3363 main.c with patch::
3364 3364
3365 3365 hg log -L file.c,13:23 -L main.c,2:6 -p
3366 3366
3367 3367 See :hg:`help dates` for a list of formats valid for -d/--date.
3368 3368
3369 3369 See :hg:`help revisions` for more about specifying and ordering
3370 3370 revisions.
3371 3371
3372 3372 See :hg:`help templates` for more about pre-packaged styles and
3373 3373 specifying custom templates. The default template used by the log
3374 3374 command can be customized via the ``ui.logtemplate`` configuration
3375 3375 setting.
3376 3376
3377 3377 Returns 0 on success.
3378 3378
3379 3379 """
3380 3380 opts = pycompat.byteskwargs(opts)
3381 3381 linerange = opts.get('line_range')
3382 3382
3383 3383 if linerange and not opts.get('follow'):
3384 3384 raise error.Abort(_('--line-range requires --follow'))
3385 3385
3386 3386 if linerange and pats:
3387 3387 raise error.Abort(
3388 3388 _('FILE arguments are not compatible with --line-range option')
3389 3389 )
3390 3390
3391 3391 if opts.get('follow') and opts.get('rev'):
3392 3392 opts['rev'] = [revsetlang.formatspec('reverse(::%lr)', opts.get('rev'))]
3393 3393 del opts['follow']
3394 3394
3395 3395 if opts.get('graph'):
3396 3396 if linerange:
3397 3397 raise error.Abort(_('graph not supported with line range patterns'))
3398 3398 return cmdutil.graphlog(ui, repo, pats, opts)
3399 3399
3400 3400 revs, expr, filematcher = cmdutil.getlogrevs(repo, pats, opts)
3401 3401 hunksfilter = None
3402 3402
3403 3403 if linerange:
3404 3404 revs, lrfilematcher, hunksfilter = cmdutil.getloglinerangerevs(
3405 3405 repo, revs, opts)
3406 3406
3407 3407 if filematcher is not None and lrfilematcher is not None:
3408 3408 basefilematcher = filematcher
3409 3409
3410 3410 def filematcher(rev):
3411 3411 files = (basefilematcher(rev).files()
3412 3412 + lrfilematcher(rev).files())
3413 3413 return scmutil.matchfiles(repo, files)
3414 3414
3415 3415 elif filematcher is None:
3416 3416 filematcher = lrfilematcher
3417 3417
3418 3418 limit = cmdutil.loglimit(opts)
3419 3419 count = 0
3420 3420
3421 3421 getrenamed = None
3422 3422 if opts.get('copies'):
3423 3423 endrev = None
3424 3424 if opts.get('rev'):
3425 3425 endrev = scmutil.revrange(repo, opts.get('rev')).max() + 1
3426 3426 getrenamed = templatekw.getrenamedfn(repo, endrev=endrev)
3427 3427
3428 3428 ui.pager('log')
3429 3429 displayer = cmdutil.show_changeset(ui, repo, opts, buffered=True)
3430 3430 for rev in revs:
3431 3431 if count == limit:
3432 3432 break
3433 3433 ctx = repo[rev]
3434 3434 copies = None
3435 3435 if getrenamed is not None and rev:
3436 3436 copies = []
3437 3437 for fn in ctx.files():
3438 3438 rename = getrenamed(fn, rev)
3439 3439 if rename:
3440 3440 copies.append((fn, rename[0]))
3441 3441 if filematcher:
3442 3442 revmatchfn = filematcher(ctx.rev())
3443 3443 else:
3444 3444 revmatchfn = None
3445 3445 if hunksfilter:
3446 3446 revhunksfilter = hunksfilter(rev)
3447 3447 else:
3448 3448 revhunksfilter = None
3449 3449 displayer.show(ctx, copies=copies, matchfn=revmatchfn,
3450 3450 hunksfilterfn=revhunksfilter)
3451 3451 if displayer.flush(ctx):
3452 3452 count += 1
3453 3453
3454 3454 displayer.close()
3455 3455
3456 3456 @command('manifest',
3457 3457 [('r', 'rev', '', _('revision to display'), _('REV')),
3458 3458 ('', 'all', False, _("list files from all revisions"))]
3459 3459 + formatteropts,
3460 3460 _('[-r REV]'))
3461 3461 def manifest(ui, repo, node=None, rev=None, **opts):
3462 3462 """output the current or given revision of the project manifest
3463 3463
3464 3464 Print a list of version controlled files for the given revision.
3465 3465 If no revision is given, the first parent of the working directory
3466 3466 is used, or the null revision if no revision is checked out.
3467 3467
3468 3468 With -v, print file permissions, symlink and executable bits.
3469 3469 With --debug, print file revision hashes.
3470 3470
3471 3471 If option --all is specified, the list of all files from all revisions
3472 3472 is printed. This includes deleted and renamed files.
3473 3473
3474 3474 Returns 0 on success.
3475 3475 """
3476 3476 opts = pycompat.byteskwargs(opts)
3477 3477 fm = ui.formatter('manifest', opts)
3478 3478
3479 3479 if opts.get('all'):
3480 3480 if rev or node:
3481 3481 raise error.Abort(_("can't specify a revision with --all"))
3482 3482
3483 3483 res = []
3484 3484 prefix = "data/"
3485 3485 suffix = ".i"
3486 3486 plen = len(prefix)
3487 3487 slen = len(suffix)
3488 3488 with repo.lock():
3489 3489 for fn, b, size in repo.store.datafiles():
3490 3490 if size != 0 and fn[-slen:] == suffix and fn[:plen] == prefix:
3491 3491 res.append(fn[plen:-slen])
3492 3492 ui.pager('manifest')
3493 3493 for f in res:
3494 3494 fm.startitem()
3495 3495 fm.write("path", '%s\n', f)
3496 3496 fm.end()
3497 3497 return
3498 3498
3499 3499 if rev and node:
3500 3500 raise error.Abort(_("please specify just one revision"))
3501 3501
3502 3502 if not node:
3503 3503 node = rev
3504 3504
3505 3505 char = {'l': '@', 'x': '*', '': ''}
3506 3506 mode = {'l': '644', 'x': '755', '': '644'}
3507 3507 ctx = scmutil.revsingle(repo, node)
3508 3508 mf = ctx.manifest()
3509 3509 ui.pager('manifest')
3510 3510 for f in ctx:
3511 3511 fm.startitem()
3512 3512 fl = ctx[f].flags()
3513 3513 fm.condwrite(ui.debugflag, 'hash', '%s ', hex(mf[f]))
3514 3514 fm.condwrite(ui.verbose, 'mode type', '%s %1s ', mode[fl], char[fl])
3515 3515 fm.write('path', '%s\n', f)
3516 3516 fm.end()
3517 3517
3518 3518 @command('^merge',
3519 3519 [('f', 'force', None,
3520 3520 _('force a merge including outstanding changes (DEPRECATED)')),
3521 3521 ('r', 'rev', '', _('revision to merge'), _('REV')),
3522 3522 ('P', 'preview', None,
3523 3523 _('review revisions to merge (no merge is performed)'))
3524 3524 ] + mergetoolopts,
3525 3525 _('[-P] [[-r] REV]'))
3526 3526 def merge(ui, repo, node=None, **opts):
3527 3527 """merge another revision into working directory
3528 3528
3529 3529 The current working directory is updated with all changes made in
3530 3530 the requested revision since the last common predecessor revision.
3531 3531
3532 3532 Files that changed between either parent are marked as changed for
3533 3533 the next commit and a commit must be performed before any further
3534 3534 updates to the repository are allowed. The next commit will have
3535 3535 two parents.
3536 3536
3537 3537 ``--tool`` can be used to specify the merge tool used for file
3538 3538 merges. It overrides the HGMERGE environment variable and your
3539 3539 configuration files. See :hg:`help merge-tools` for options.
3540 3540
3541 3541 If no revision is specified, the working directory's parent is a
3542 3542 head revision, and the current branch contains exactly one other
3543 3543 head, the other head is merged with by default. Otherwise, an
3544 3544 explicit revision with which to merge with must be provided.
3545 3545
3546 3546 See :hg:`help resolve` for information on handling file conflicts.
3547 3547
3548 3548 To undo an uncommitted merge, use :hg:`update --clean .` which
3549 3549 will check out a clean copy of the original merge parent, losing
3550 3550 all changes.
3551 3551
3552 3552 Returns 0 on success, 1 if there are unresolved files.
3553 3553 """
3554 3554
3555 3555 opts = pycompat.byteskwargs(opts)
3556 3556 if opts.get('rev') and node:
3557 3557 raise error.Abort(_("please specify just one revision"))
3558 3558 if not node:
3559 3559 node = opts.get('rev')
3560 3560
3561 3561 if node:
3562 3562 node = scmutil.revsingle(repo, node).node()
3563 3563
3564 3564 if not node:
3565 3565 node = repo[destutil.destmerge(repo)].node()
3566 3566
3567 3567 if opts.get('preview'):
3568 3568 # find nodes that are ancestors of p2 but not of p1
3569 3569 p1 = repo.lookup('.')
3570 3570 p2 = repo.lookup(node)
3571 3571 nodes = repo.changelog.findmissing(common=[p1], heads=[p2])
3572 3572
3573 3573 displayer = cmdutil.show_changeset(ui, repo, opts)
3574 3574 for node in nodes:
3575 3575 displayer.show(repo[node])
3576 3576 displayer.close()
3577 3577 return 0
3578 3578
3579 3579 try:
3580 3580 # ui.forcemerge is an internal variable, do not document
3581 3581 repo.ui.setconfig('ui', 'forcemerge', opts.get('tool', ''), 'merge')
3582 3582 force = opts.get('force')
3583 3583 labels = ['working copy', 'merge rev']
3584 3584 return hg.merge(repo, node, force=force, mergeforce=force,
3585 3585 labels=labels)
3586 3586 finally:
3587 3587 ui.setconfig('ui', 'forcemerge', '', 'merge')
3588 3588
3589 3589 @command('outgoing|out',
3590 3590 [('f', 'force', None, _('run even when the destination is unrelated')),
3591 3591 ('r', 'rev', [],
3592 3592 _('a changeset intended to be included in the destination'), _('REV')),
3593 3593 ('n', 'newest-first', None, _('show newest record first')),
3594 3594 ('B', 'bookmarks', False, _('compare bookmarks')),
3595 3595 ('b', 'branch', [], _('a specific branch you would like to push'),
3596 3596 _('BRANCH')),
3597 3597 ] + logopts + remoteopts + subrepoopts,
3598 3598 _('[-M] [-p] [-n] [-f] [-r REV]... [DEST]'))
3599 3599 def outgoing(ui, repo, dest=None, **opts):
3600 3600 """show changesets not found in the destination
3601 3601
3602 3602 Show changesets not found in the specified destination repository
3603 3603 or the default push location. These are the changesets that would
3604 3604 be pushed if a push was requested.
3605 3605
3606 3606 See pull for details of valid destination formats.
3607 3607
3608 3608 .. container:: verbose
3609 3609
3610 3610 With -B/--bookmarks, the result of bookmark comparison between
3611 3611 local and remote repositories is displayed. With -v/--verbose,
3612 3612 status is also displayed for each bookmark like below::
3613 3613
3614 3614 BM1 01234567890a added
3615 3615 BM2 deleted
3616 3616 BM3 234567890abc advanced
3617 3617 BM4 34567890abcd diverged
3618 3618 BM5 4567890abcde changed
3619 3619
3620 3620 The action taken when pushing depends on the
3621 3621 status of each bookmark:
3622 3622
3623 3623 :``added``: push with ``-B`` will create it
3624 3624 :``deleted``: push with ``-B`` will delete it
3625 3625 :``advanced``: push will update it
3626 3626 :``diverged``: push with ``-B`` will update it
3627 3627 :``changed``: push with ``-B`` will update it
3628 3628
3629 3629 From the point of view of pushing behavior, bookmarks
3630 3630 existing only in the remote repository are treated as
3631 3631 ``deleted``, even if it is in fact added remotely.
3632 3632
3633 3633 Returns 0 if there are outgoing changes, 1 otherwise.
3634 3634 """
3635 3635 opts = pycompat.byteskwargs(opts)
3636 3636 if opts.get('graph'):
3637 3637 cmdutil.checkunsupportedgraphflags([], opts)
3638 3638 o, other = hg._outgoing(ui, repo, dest, opts)
3639 3639 if not o:
3640 3640 cmdutil.outgoinghooks(ui, repo, other, opts, o)
3641 3641 return
3642 3642
3643 3643 revdag = cmdutil.graphrevs(repo, o, opts)
3644 3644 ui.pager('outgoing')
3645 3645 displayer = cmdutil.show_changeset(ui, repo, opts, buffered=True)
3646 3646 cmdutil.displaygraph(ui, repo, revdag, displayer, graphmod.asciiedges)
3647 3647 cmdutil.outgoinghooks(ui, repo, other, opts, o)
3648 3648 return 0
3649 3649
3650 3650 if opts.get('bookmarks'):
3651 3651 dest = ui.expandpath(dest or 'default-push', dest or 'default')
3652 3652 dest, branches = hg.parseurl(dest, opts.get('branch'))
3653 3653 other = hg.peer(repo, opts, dest)
3654 3654 if 'bookmarks' not in other.listkeys('namespaces'):
3655 3655 ui.warn(_("remote doesn't support bookmarks\n"))
3656 3656 return 0
3657 3657 ui.status(_('comparing with %s\n') % util.hidepassword(dest))
3658 3658 ui.pager('outgoing')
3659 3659 return bookmarks.outgoing(ui, repo, other)
3660 3660
3661 3661 repo._subtoppath = ui.expandpath(dest or 'default-push', dest or 'default')
3662 3662 try:
3663 3663 return hg.outgoing(ui, repo, dest, opts)
3664 3664 finally:
3665 3665 del repo._subtoppath
3666 3666
3667 3667 @command('parents',
3668 3668 [('r', 'rev', '', _('show parents of the specified revision'), _('REV')),
3669 3669 ] + templateopts,
3670 3670 _('[-r REV] [FILE]'),
3671 3671 inferrepo=True)
3672 3672 def parents(ui, repo, file_=None, **opts):
3673 3673 """show the parents of the working directory or revision (DEPRECATED)
3674 3674
3675 3675 Print the working directory's parent revisions. If a revision is
3676 3676 given via -r/--rev, the parent of that revision will be printed.
3677 3677 If a file argument is given, the revision in which the file was
3678 3678 last changed (before the working directory revision or the
3679 3679 argument to --rev if given) is printed.
3680 3680
3681 3681 This command is equivalent to::
3682 3682
3683 3683 hg log -r "p1()+p2()" or
3684 3684 hg log -r "p1(REV)+p2(REV)" or
3685 3685 hg log -r "max(::p1() and file(FILE))+max(::p2() and file(FILE))" or
3686 3686 hg log -r "max(::p1(REV) and file(FILE))+max(::p2(REV) and file(FILE))"
3687 3687
3688 3688 See :hg:`summary` and :hg:`help revsets` for related information.
3689 3689
3690 3690 Returns 0 on success.
3691 3691 """
3692 3692
3693 3693 opts = pycompat.byteskwargs(opts)
3694 3694 ctx = scmutil.revsingle(repo, opts.get('rev'), None)
3695 3695
3696 3696 if file_:
3697 3697 m = scmutil.match(ctx, (file_,), opts)
3698 3698 if m.anypats() or len(m.files()) != 1:
3699 3699 raise error.Abort(_('can only specify an explicit filename'))
3700 3700 file_ = m.files()[0]
3701 3701 filenodes = []
3702 3702 for cp in ctx.parents():
3703 3703 if not cp:
3704 3704 continue
3705 3705 try:
3706 3706 filenodes.append(cp.filenode(file_))
3707 3707 except error.LookupError:
3708 3708 pass
3709 3709 if not filenodes:
3710 3710 raise error.Abort(_("'%s' not found in manifest!") % file_)
3711 3711 p = []
3712 3712 for fn in filenodes:
3713 3713 fctx = repo.filectx(file_, fileid=fn)
3714 3714 p.append(fctx.node())
3715 3715 else:
3716 3716 p = [cp.node() for cp in ctx.parents()]
3717 3717
3718 3718 displayer = cmdutil.show_changeset(ui, repo, opts)
3719 3719 for n in p:
3720 3720 if n != nullid:
3721 3721 displayer.show(repo[n])
3722 3722 displayer.close()
3723 3723
3724 3724 @command('paths', formatteropts, _('[NAME]'), optionalrepo=True)
3725 3725 def paths(ui, repo, search=None, **opts):
3726 3726 """show aliases for remote repositories
3727 3727
3728 3728 Show definition of symbolic path name NAME. If no name is given,
3729 3729 show definition of all available names.
3730 3730
3731 3731 Option -q/--quiet suppresses all output when searching for NAME
3732 3732 and shows only the path names when listing all definitions.
3733 3733
3734 3734 Path names are defined in the [paths] section of your
3735 3735 configuration file and in ``/etc/mercurial/hgrc``. If run inside a
3736 3736 repository, ``.hg/hgrc`` is used, too.
3737 3737
3738 3738 The path names ``default`` and ``default-push`` have a special
3739 3739 meaning. When performing a push or pull operation, they are used
3740 3740 as fallbacks if no location is specified on the command-line.
3741 3741 When ``default-push`` is set, it will be used for push and
3742 3742 ``default`` will be used for pull; otherwise ``default`` is used
3743 3743 as the fallback for both. When cloning a repository, the clone
3744 3744 source is written as ``default`` in ``.hg/hgrc``.
3745 3745
3746 3746 .. note::
3747 3747
3748 3748 ``default`` and ``default-push`` apply to all inbound (e.g.
3749 3749 :hg:`incoming`) and outbound (e.g. :hg:`outgoing`, :hg:`email`
3750 3750 and :hg:`bundle`) operations.
3751 3751
3752 3752 See :hg:`help urls` for more information.
3753 3753
3754 3754 Returns 0 on success.
3755 3755 """
3756 3756
3757 3757 opts = pycompat.byteskwargs(opts)
3758 3758 ui.pager('paths')
3759 3759 if search:
3760 3760 pathitems = [(name, path) for name, path in ui.paths.iteritems()
3761 3761 if name == search]
3762 3762 else:
3763 3763 pathitems = sorted(ui.paths.iteritems())
3764 3764
3765 3765 fm = ui.formatter('paths', opts)
3766 3766 if fm.isplain():
3767 3767 hidepassword = util.hidepassword
3768 3768 else:
3769 3769 hidepassword = str
3770 3770 if ui.quiet:
3771 3771 namefmt = '%s\n'
3772 3772 else:
3773 3773 namefmt = '%s = '
3774 3774 showsubopts = not search and not ui.quiet
3775 3775
3776 3776 for name, path in pathitems:
3777 3777 fm.startitem()
3778 3778 fm.condwrite(not search, 'name', namefmt, name)
3779 3779 fm.condwrite(not ui.quiet, 'url', '%s\n', hidepassword(path.rawloc))
3780 3780 for subopt, value in sorted(path.suboptions.items()):
3781 3781 assert subopt not in ('name', 'url')
3782 3782 if showsubopts:
3783 3783 fm.plain('%s:%s = ' % (name, subopt))
3784 3784 fm.condwrite(showsubopts, subopt, '%s\n', value)
3785 3785
3786 3786 fm.end()
3787 3787
3788 3788 if search and not pathitems:
3789 3789 if not ui.quiet:
3790 3790 ui.warn(_("not found!\n"))
3791 3791 return 1
3792 3792 else:
3793 3793 return 0
3794 3794
3795 3795 @command('phase',
3796 3796 [('p', 'public', False, _('set changeset phase to public')),
3797 3797 ('d', 'draft', False, _('set changeset phase to draft')),
3798 3798 ('s', 'secret', False, _('set changeset phase to secret')),
3799 3799 ('f', 'force', False, _('allow to move boundary backward')),
3800 3800 ('r', 'rev', [], _('target revision'), _('REV')),
3801 3801 ],
3802 3802 _('[-p|-d|-s] [-f] [-r] [REV...]'))
3803 3803 def phase(ui, repo, *revs, **opts):
3804 3804 """set or show the current phase name
3805 3805
3806 3806 With no argument, show the phase name of the current revision(s).
3807 3807
3808 3808 With one of -p/--public, -d/--draft or -s/--secret, change the
3809 3809 phase value of the specified revisions.
3810 3810
3811 Unless -f/--force is specified, :hg:`phase` won't move changeset from a
3812 lower phase to an higher phase. Phases are ordered as follows::
3811 Unless -f/--force is specified, :hg:`phase` won't move changesets from a
3812 lower phase to a higher phase. Phases are ordered as follows::
3813 3813
3814 3814 public < draft < secret
3815 3815
3816 3816 Returns 0 on success, 1 if some phases could not be changed.
3817 3817
3818 3818 (For more information about the phases concept, see :hg:`help phases`.)
3819 3819 """
3820 3820 opts = pycompat.byteskwargs(opts)
3821 3821 # search for a unique phase argument
3822 3822 targetphase = None
3823 3823 for idx, name in enumerate(phases.phasenames):
3824 3824 if opts[name]:
3825 3825 if targetphase is not None:
3826 3826 raise error.Abort(_('only one phase can be specified'))
3827 3827 targetphase = idx
3828 3828
3829 3829 # look for specified revision
3830 3830 revs = list(revs)
3831 3831 revs.extend(opts['rev'])
3832 3832 if not revs:
3833 3833 # display both parents as the second parent phase can influence
3834 3834 # the phase of a merge commit
3835 3835 revs = [c.rev() for c in repo[None].parents()]
3836 3836
3837 3837 revs = scmutil.revrange(repo, revs)
3838 3838
3839 3839 lock = None
3840 3840 ret = 0
3841 3841 if targetphase is None:
3842 3842 # display
3843 3843 for r in revs:
3844 3844 ctx = repo[r]
3845 3845 ui.write('%i: %s\n' % (ctx.rev(), ctx.phasestr()))
3846 3846 else:
3847 3847 tr = None
3848 3848 lock = repo.lock()
3849 3849 try:
3850 3850 tr = repo.transaction("phase")
3851 3851 # set phase
3852 3852 if not revs:
3853 3853 raise error.Abort(_('empty revision set'))
3854 3854 nodes = [repo[r].node() for r in revs]
3855 3855 # moving revision from public to draft may hide them
3856 3856 # We have to check result on an unfiltered repository
3857 3857 unfi = repo.unfiltered()
3858 3858 getphase = unfi._phasecache.phase
3859 3859 olddata = [getphase(unfi, r) for r in unfi]
3860 3860 phases.advanceboundary(repo, tr, targetphase, nodes)
3861 3861 if opts['force']:
3862 3862 phases.retractboundary(repo, tr, targetphase, nodes)
3863 3863 tr.close()
3864 3864 finally:
3865 3865 if tr is not None:
3866 3866 tr.release()
3867 3867 lock.release()
3868 3868 getphase = unfi._phasecache.phase
3869 3869 newdata = [getphase(unfi, r) for r in unfi]
3870 3870 changes = sum(newdata[r] != olddata[r] for r in unfi)
3871 3871 cl = unfi.changelog
3872 3872 rejected = [n for n in nodes
3873 3873 if newdata[cl.rev(n)] < targetphase]
3874 3874 if rejected:
3875 3875 ui.warn(_('cannot move %i changesets to a higher '
3876 3876 'phase, use --force\n') % len(rejected))
3877 3877 ret = 1
3878 3878 if changes:
3879 3879 msg = _('phase changed for %i changesets\n') % changes
3880 3880 if ret:
3881 3881 ui.status(msg)
3882 3882 else:
3883 3883 ui.note(msg)
3884 3884 else:
3885 3885 ui.warn(_('no phases changed\n'))
3886 3886 return ret
3887 3887
3888 3888 def postincoming(ui, repo, modheads, optupdate, checkout, brev):
3889 3889 """Run after a changegroup has been added via pull/unbundle
3890 3890
3891 3891 This takes arguments below:
3892 3892
3893 3893 :modheads: change of heads by pull/unbundle
3894 3894 :optupdate: updating working directory is needed or not
3895 3895 :checkout: update destination revision (or None to default destination)
3896 3896 :brev: a name, which might be a bookmark to be activated after updating
3897 3897 """
3898 3898 if modheads == 0:
3899 3899 return
3900 3900 if optupdate:
3901 3901 try:
3902 3902 return hg.updatetotally(ui, repo, checkout, brev)
3903 3903 except error.UpdateAbort as inst:
3904 3904 msg = _("not updating: %s") % str(inst)
3905 3905 hint = inst.hint
3906 3906 raise error.UpdateAbort(msg, hint=hint)
3907 3907 if modheads > 1:
3908 3908 currentbranchheads = len(repo.branchheads())
3909 3909 if currentbranchheads == modheads:
3910 3910 ui.status(_("(run 'hg heads' to see heads, 'hg merge' to merge)\n"))
3911 3911 elif currentbranchheads > 1:
3912 3912 ui.status(_("(run 'hg heads .' to see heads, 'hg merge' to "
3913 3913 "merge)\n"))
3914 3914 else:
3915 3915 ui.status(_("(run 'hg heads' to see heads)\n"))
3916 3916 elif not ui.configbool('commands', 'update.requiredest'):
3917 3917 ui.status(_("(run 'hg update' to get a working copy)\n"))
3918 3918
3919 3919 @command('^pull',
3920 3920 [('u', 'update', None,
3921 3921 _('update to new branch head if changesets were pulled')),
3922 3922 ('f', 'force', None, _('run even when remote repository is unrelated')),
3923 3923 ('r', 'rev', [], _('a remote changeset intended to be added'), _('REV')),
3924 3924 ('B', 'bookmark', [], _("bookmark to pull"), _('BOOKMARK')),
3925 3925 ('b', 'branch', [], _('a specific branch you would like to pull'),
3926 3926 _('BRANCH')),
3927 3927 ] + remoteopts,
3928 3928 _('[-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]'))
3929 3929 def pull(ui, repo, source="default", **opts):
3930 3930 """pull changes from the specified source
3931 3931
3932 3932 Pull changes from a remote repository to a local one.
3933 3933
3934 3934 This finds all changes from the repository at the specified path
3935 3935 or URL and adds them to a local repository (the current one unless
3936 3936 -R is specified). By default, this does not update the copy of the
3937 3937 project in the working directory.
3938 3938
3939 3939 Use :hg:`incoming` if you want to see what would have been added
3940 3940 by a pull at the time you issued this command. If you then decide
3941 3941 to add those changes to the repository, you should use :hg:`pull
3942 3942 -r X` where ``X`` is the last changeset listed by :hg:`incoming`.
3943 3943
3944 3944 If SOURCE is omitted, the 'default' path will be used.
3945 3945 See :hg:`help urls` for more information.
3946 3946
3947 3947 Specifying bookmark as ``.`` is equivalent to specifying the active
3948 3948 bookmark's name.
3949 3949
3950 3950 Returns 0 on success, 1 if an update had unresolved files.
3951 3951 """
3952 3952
3953 3953 opts = pycompat.byteskwargs(opts)
3954 3954 if ui.configbool('commands', 'update.requiredest') and opts.get('update'):
3955 3955 msg = _('update destination required by configuration')
3956 3956 hint = _('use hg pull followed by hg update DEST')
3957 3957 raise error.Abort(msg, hint=hint)
3958 3958
3959 3959 source, branches = hg.parseurl(ui.expandpath(source), opts.get('branch'))
3960 3960 ui.status(_('pulling from %s\n') % util.hidepassword(source))
3961 3961 other = hg.peer(repo, opts, source)
3962 3962 try:
3963 3963 revs, checkout = hg.addbranchrevs(repo, other, branches,
3964 3964 opts.get('rev'))
3965 3965
3966 3966
3967 3967 pullopargs = {}
3968 3968 if opts.get('bookmark'):
3969 3969 if not revs:
3970 3970 revs = []
3971 3971 # The list of bookmark used here is not the one used to actually
3972 3972 # update the bookmark name. This can result in the revision pulled
3973 3973 # not ending up with the name of the bookmark because of a race
3974 3974 # condition on the server. (See issue 4689 for details)
3975 3975 remotebookmarks = other.listkeys('bookmarks')
3976 3976 pullopargs['remotebookmarks'] = remotebookmarks
3977 3977 for b in opts['bookmark']:
3978 3978 b = repo._bookmarks.expandname(b)
3979 3979 if b not in remotebookmarks:
3980 3980 raise error.Abort(_('remote bookmark %s not found!') % b)
3981 3981 revs.append(remotebookmarks[b])
3982 3982
3983 3983 if revs:
3984 3984 try:
3985 3985 # When 'rev' is a bookmark name, we cannot guarantee that it
3986 3986 # will be updated with that name because of a race condition
3987 3987 # server side. (See issue 4689 for details)
3988 3988 oldrevs = revs
3989 3989 revs = [] # actually, nodes
3990 3990 for r in oldrevs:
3991 3991 node = other.lookup(r)
3992 3992 revs.append(node)
3993 3993 if r == checkout:
3994 3994 checkout = node
3995 3995 except error.CapabilityError:
3996 3996 err = _("other repository doesn't support revision lookup, "
3997 3997 "so a rev cannot be specified.")
3998 3998 raise error.Abort(err)
3999 3999
4000 4000 pullopargs.update(opts.get('opargs', {}))
4001 4001 modheads = exchange.pull(repo, other, heads=revs,
4002 4002 force=opts.get('force'),
4003 4003 bookmarks=opts.get('bookmark', ()),
4004 4004 opargs=pullopargs).cgresult
4005 4005
4006 4006 # brev is a name, which might be a bookmark to be activated at
4007 4007 # the end of the update. In other words, it is an explicit
4008 4008 # destination of the update
4009 4009 brev = None
4010 4010
4011 4011 if checkout:
4012 4012 checkout = str(repo.changelog.rev(checkout))
4013 4013
4014 4014 # order below depends on implementation of
4015 4015 # hg.addbranchrevs(). opts['bookmark'] is ignored,
4016 4016 # because 'checkout' is determined without it.
4017 4017 if opts.get('rev'):
4018 4018 brev = opts['rev'][0]
4019 4019 elif opts.get('branch'):
4020 4020 brev = opts['branch'][0]
4021 4021 else:
4022 4022 brev = branches[0]
4023 4023 repo._subtoppath = source
4024 4024 try:
4025 4025 ret = postincoming(ui, repo, modheads, opts.get('update'),
4026 4026 checkout, brev)
4027 4027
4028 4028 finally:
4029 4029 del repo._subtoppath
4030 4030
4031 4031 finally:
4032 4032 other.close()
4033 4033 return ret
4034 4034
4035 4035 @command('^push',
4036 4036 [('f', 'force', None, _('force push')),
4037 4037 ('r', 'rev', [],
4038 4038 _('a changeset intended to be included in the destination'),
4039 4039 _('REV')),
4040 4040 ('B', 'bookmark', [], _("bookmark to push"), _('BOOKMARK')),
4041 4041 ('b', 'branch', [],
4042 4042 _('a specific branch you would like to push'), _('BRANCH')),
4043 4043 ('', 'new-branch', False, _('allow pushing a new branch')),
4044 4044 ('', 'pushvars', [], _('variables that can be sent to server (ADVANCED)')),
4045 4045 ] + remoteopts,
4046 4046 _('[-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]'))
4047 4047 def push(ui, repo, dest=None, **opts):
4048 4048 """push changes to the specified destination
4049 4049
4050 4050 Push changesets from the local repository to the specified
4051 4051 destination.
4052 4052
4053 4053 This operation is symmetrical to pull: it is identical to a pull
4054 4054 in the destination repository from the current one.
4055 4055
4056 4056 By default, push will not allow creation of new heads at the
4057 4057 destination, since multiple heads would make it unclear which head
4058 4058 to use. In this situation, it is recommended to pull and merge
4059 4059 before pushing.
4060 4060
4061 4061 Use --new-branch if you want to allow push to create a new named
4062 4062 branch that is not present at the destination. This allows you to
4063 4063 only create a new branch without forcing other changes.
4064 4064
4065 4065 .. note::
4066 4066
4067 4067 Extra care should be taken with the -f/--force option,
4068 4068 which will push all new heads on all branches, an action which will
4069 4069 almost always cause confusion for collaborators.
4070 4070
4071 4071 If -r/--rev is used, the specified revision and all its ancestors
4072 4072 will be pushed to the remote repository.
4073 4073
4074 4074 If -B/--bookmark is used, the specified bookmarked revision, its
4075 4075 ancestors, and the bookmark will be pushed to the remote
4076 4076 repository. Specifying ``.`` is equivalent to specifying the active
4077 4077 bookmark's name.
4078 4078
4079 4079 Please see :hg:`help urls` for important details about ``ssh://``
4080 4080 URLs. If DESTINATION is omitted, a default path will be used.
4081 4081
4082 4082 .. container:: verbose
4083 4083
4084 4084 The --pushvars option sends strings to the server that become
4085 4085 environment variables prepended with ``HG_USERVAR_``. For example,
4086 4086 ``--pushvars ENABLE_FEATURE=true``, provides the server side hooks with
4087 4087 ``HG_USERVAR_ENABLE_FEATURE=true`` as part of their environment.
4088 4088
4089 4089 pushvars can provide for user-overridable hooks as well as set debug
4090 4090 levels. One example is having a hook that blocks commits containing
4091 4091 conflict markers, but enables the user to override the hook if the file
4092 4092 is using conflict markers for testing purposes or the file format has
4093 4093 strings that look like conflict markers.
4094 4094
4095 4095 By default, servers will ignore `--pushvars`. To enable it add the
4096 4096 following to your configuration file::
4097 4097
4098 4098 [push]
4099 4099 pushvars.server = true
4100 4100
4101 4101 Returns 0 if push was successful, 1 if nothing to push.
4102 4102 """
4103 4103
4104 4104 opts = pycompat.byteskwargs(opts)
4105 4105 if opts.get('bookmark'):
4106 4106 ui.setconfig('bookmarks', 'pushing', opts['bookmark'], 'push')
4107 4107 for b in opts['bookmark']:
4108 4108 # translate -B options to -r so changesets get pushed
4109 4109 b = repo._bookmarks.expandname(b)
4110 4110 if b in repo._bookmarks:
4111 4111 opts.setdefault('rev', []).append(b)
4112 4112 else:
4113 4113 # if we try to push a deleted bookmark, translate it to null
4114 4114 # this lets simultaneous -r, -b options continue working
4115 4115 opts.setdefault('rev', []).append("null")
4116 4116
4117 4117 path = ui.paths.getpath(dest, default=('default-push', 'default'))
4118 4118 if not path:
4119 4119 raise error.Abort(_('default repository not configured!'),
4120 4120 hint=_("see 'hg help config.paths'"))
4121 4121 dest = path.pushloc or path.loc
4122 4122 branches = (path.branch, opts.get('branch') or [])
4123 4123 ui.status(_('pushing to %s\n') % util.hidepassword(dest))
4124 4124 revs, checkout = hg.addbranchrevs(repo, repo, branches, opts.get('rev'))
4125 4125 other = hg.peer(repo, opts, dest)
4126 4126
4127 4127 if revs:
4128 4128 revs = [repo.lookup(r) for r in scmutil.revrange(repo, revs)]
4129 4129 if not revs:
4130 4130 raise error.Abort(_("specified revisions evaluate to an empty set"),
4131 4131 hint=_("use different revision arguments"))
4132 4132 elif path.pushrev:
4133 4133 # It doesn't make any sense to specify ancestor revisions. So limit
4134 4134 # to DAG heads to make discovery simpler.
4135 4135 expr = revsetlang.formatspec('heads(%r)', path.pushrev)
4136 4136 revs = scmutil.revrange(repo, [expr])
4137 4137 revs = [repo[rev].node() for rev in revs]
4138 4138 if not revs:
4139 4139 raise error.Abort(_('default push revset for path evaluates to an '
4140 4140 'empty set'))
4141 4141
4142 4142 repo._subtoppath = dest
4143 4143 try:
4144 4144 # push subrepos depth-first for coherent ordering
4145 4145 c = repo['']
4146 4146 subs = c.substate # only repos that are committed
4147 4147 for s in sorted(subs):
4148 4148 result = c.sub(s).push(opts)
4149 4149 if result == 0:
4150 4150 return not result
4151 4151 finally:
4152 4152 del repo._subtoppath
4153 4153
4154 4154 opargs = dict(opts.get('opargs', {})) # copy opargs since we may mutate it
4155 4155 opargs.setdefault('pushvars', []).extend(opts.get('pushvars', []))
4156 4156
4157 4157 pushop = exchange.push(repo, other, opts.get('force'), revs=revs,
4158 4158 newbranch=opts.get('new_branch'),
4159 4159 bookmarks=opts.get('bookmark', ()),
4160 4160 opargs=opargs)
4161 4161
4162 4162 result = not pushop.cgresult
4163 4163
4164 4164 if pushop.bkresult is not None:
4165 4165 if pushop.bkresult == 2:
4166 4166 result = 2
4167 4167 elif not result and pushop.bkresult:
4168 4168 result = 2
4169 4169
4170 4170 return result
4171 4171
4172 4172 @command('recover', [])
4173 4173 def recover(ui, repo):
4174 4174 """roll back an interrupted transaction
4175 4175
4176 4176 Recover from an interrupted commit or pull.
4177 4177
4178 4178 This command tries to fix the repository status after an
4179 4179 interrupted operation. It should only be necessary when Mercurial
4180 4180 suggests it.
4181 4181
4182 4182 Returns 0 if successful, 1 if nothing to recover or verify fails.
4183 4183 """
4184 4184 if repo.recover():
4185 4185 return hg.verify(repo)
4186 4186 return 1
4187 4187
4188 4188 @command('^remove|rm',
4189 4189 [('A', 'after', None, _('record delete for missing files')),
4190 4190 ('f', 'force', None,
4191 4191 _('forget added files, delete modified files')),
4192 4192 ] + subrepoopts + walkopts,
4193 4193 _('[OPTION]... FILE...'),
4194 4194 inferrepo=True)
4195 4195 def remove(ui, repo, *pats, **opts):
4196 4196 """remove the specified files on the next commit
4197 4197
4198 4198 Schedule the indicated files for removal from the current branch.
4199 4199
4200 4200 This command schedules the files to be removed at the next commit.
4201 4201 To undo a remove before that, see :hg:`revert`. To undo added
4202 4202 files, see :hg:`forget`.
4203 4203
4204 4204 .. container:: verbose
4205 4205
4206 4206 -A/--after can be used to remove only files that have already
4207 4207 been deleted, -f/--force can be used to force deletion, and -Af
4208 4208 can be used to remove files from the next revision without
4209 4209 deleting them from the working directory.
4210 4210
4211 4211 The following table details the behavior of remove for different
4212 4212 file states (columns) and option combinations (rows). The file
4213 4213 states are Added [A], Clean [C], Modified [M] and Missing [!]
4214 4214 (as reported by :hg:`status`). The actions are Warn, Remove
4215 4215 (from branch) and Delete (from disk):
4216 4216
4217 4217 ========= == == == ==
4218 4218 opt/state A C M !
4219 4219 ========= == == == ==
4220 4220 none W RD W R
4221 4221 -f R RD RD R
4222 4222 -A W W W R
4223 4223 -Af R R R R
4224 4224 ========= == == == ==
4225 4225
4226 4226 .. note::
4227 4227
4228 4228 :hg:`remove` never deletes files in Added [A] state from the
4229 4229 working directory, not even if ``--force`` is specified.
4230 4230
4231 4231 Returns 0 on success, 1 if any warnings encountered.
4232 4232 """
4233 4233
4234 4234 opts = pycompat.byteskwargs(opts)
4235 4235 after, force = opts.get('after'), opts.get('force')
4236 4236 if not pats and not after:
4237 4237 raise error.Abort(_('no files specified'))
4238 4238
4239 4239 m = scmutil.match(repo[None], pats, opts)
4240 4240 subrepos = opts.get('subrepos')
4241 4241 return cmdutil.remove(ui, repo, m, "", after, force, subrepos)
4242 4242
4243 4243 @command('rename|move|mv',
4244 4244 [('A', 'after', None, _('record a rename that has already occurred')),
4245 4245 ('f', 'force', None, _('forcibly copy over an existing managed file')),
4246 4246 ] + walkopts + dryrunopts,
4247 4247 _('[OPTION]... SOURCE... DEST'))
4248 4248 def rename(ui, repo, *pats, **opts):
4249 4249 """rename files; equivalent of copy + remove
4250 4250
4251 4251 Mark dest as copies of sources; mark sources for deletion. If dest
4252 4252 is a directory, copies are put in that directory. If dest is a
4253 4253 file, there can only be one source.
4254 4254
4255 4255 By default, this command copies the contents of files as they
4256 4256 exist in the working directory. If invoked with -A/--after, the
4257 4257 operation is recorded, but no copying is performed.
4258 4258
4259 4259 This command takes effect at the next commit. To undo a rename
4260 4260 before that, see :hg:`revert`.
4261 4261
4262 4262 Returns 0 on success, 1 if errors are encountered.
4263 4263 """
4264 4264 opts = pycompat.byteskwargs(opts)
4265 4265 with repo.wlock(False):
4266 4266 return cmdutil.copy(ui, repo, pats, opts, rename=True)
4267 4267
4268 4268 @command('resolve',
4269 4269 [('a', 'all', None, _('select all unresolved files')),
4270 4270 ('l', 'list', None, _('list state of files needing merge')),
4271 4271 ('m', 'mark', None, _('mark files as resolved')),
4272 4272 ('u', 'unmark', None, _('mark files as unresolved')),
4273 4273 ('n', 'no-status', None, _('hide status prefix'))]
4274 4274 + mergetoolopts + walkopts + formatteropts,
4275 4275 _('[OPTION]... [FILE]...'),
4276 4276 inferrepo=True)
4277 4277 def resolve(ui, repo, *pats, **opts):
4278 4278 """redo merges or set/view the merge status of files
4279 4279
4280 4280 Merges with unresolved conflicts are often the result of
4281 4281 non-interactive merging using the ``internal:merge`` configuration
4282 4282 setting, or a command-line merge tool like ``diff3``. The resolve
4283 4283 command is used to manage the files involved in a merge, after
4284 4284 :hg:`merge` has been run, and before :hg:`commit` is run (i.e. the
4285 4285 working directory must have two parents). See :hg:`help
4286 4286 merge-tools` for information on configuring merge tools.
4287 4287
4288 4288 The resolve command can be used in the following ways:
4289 4289
4290 4290 - :hg:`resolve [--tool TOOL] FILE...`: attempt to re-merge the specified
4291 4291 files, discarding any previous merge attempts. Re-merging is not
4292 4292 performed for files already marked as resolved. Use ``--all/-a``
4293 4293 to select all unresolved files. ``--tool`` can be used to specify
4294 4294 the merge tool used for the given files. It overrides the HGMERGE
4295 4295 environment variable and your configuration files. Previous file
4296 4296 contents are saved with a ``.orig`` suffix.
4297 4297
4298 4298 - :hg:`resolve -m [FILE]`: mark a file as having been resolved
4299 4299 (e.g. after having manually fixed-up the files). The default is
4300 4300 to mark all unresolved files.
4301 4301
4302 4302 - :hg:`resolve -u [FILE]...`: mark a file as unresolved. The
4303 4303 default is to mark all resolved files.
4304 4304
4305 4305 - :hg:`resolve -l`: list files which had or still have conflicts.
4306 4306 In the printed list, ``U`` = unresolved and ``R`` = resolved.
4307 4307 You can use ``set:unresolved()`` or ``set:resolved()`` to filter
4308 4308 the list. See :hg:`help filesets` for details.
4309 4309
4310 4310 .. note::
4311 4311
4312 4312 Mercurial will not let you commit files with unresolved merge
4313 4313 conflicts. You must use :hg:`resolve -m ...` before you can
4314 4314 commit after a conflicting merge.
4315 4315
4316 4316 Returns 0 on success, 1 if any files fail a resolve attempt.
4317 4317 """
4318 4318
4319 4319 opts = pycompat.byteskwargs(opts)
4320 4320 flaglist = 'all mark unmark list no_status'.split()
4321 4321 all, mark, unmark, show, nostatus = \
4322 4322 [opts.get(o) for o in flaglist]
4323 4323
4324 4324 if (show and (mark or unmark)) or (mark and unmark):
4325 4325 raise error.Abort(_("too many options specified"))
4326 4326 if pats and all:
4327 4327 raise error.Abort(_("can't specify --all and patterns"))
4328 4328 if not (all or pats or show or mark or unmark):
4329 4329 raise error.Abort(_('no files or directories specified'),
4330 4330 hint=('use --all to re-merge all unresolved files'))
4331 4331
4332 4332 if show:
4333 4333 ui.pager('resolve')
4334 4334 fm = ui.formatter('resolve', opts)
4335 4335 ms = mergemod.mergestate.read(repo)
4336 4336 m = scmutil.match(repo[None], pats, opts)
4337 4337
4338 4338 # Labels and keys based on merge state. Unresolved path conflicts show
4339 4339 # as 'P'. Resolved path conflicts show as 'R', the same as normal
4340 4340 # resolved conflicts.
4341 4341 mergestateinfo = {
4342 4342 'u': ('resolve.unresolved', 'U'),
4343 4343 'r': ('resolve.resolved', 'R'),
4344 4344 'pu': ('resolve.unresolved', 'P'),
4345 4345 'pr': ('resolve.resolved', 'R'),
4346 4346 'd': ('resolve.driverresolved', 'D'),
4347 4347 }
4348 4348
4349 4349 for f in ms:
4350 4350 if not m(f):
4351 4351 continue
4352 4352
4353 4353 label, key = mergestateinfo[ms[f]]
4354 4354 fm.startitem()
4355 4355 fm.condwrite(not nostatus, 'status', '%s ', key, label=label)
4356 4356 fm.write('path', '%s\n', f, label=label)
4357 4357 fm.end()
4358 4358 return 0
4359 4359
4360 4360 with repo.wlock():
4361 4361 ms = mergemod.mergestate.read(repo)
4362 4362
4363 4363 if not (ms.active() or repo.dirstate.p2() != nullid):
4364 4364 raise error.Abort(
4365 4365 _('resolve command not applicable when not merging'))
4366 4366
4367 4367 wctx = repo[None]
4368 4368
4369 4369 if ms.mergedriver and ms.mdstate() == 'u':
4370 4370 proceed = mergemod.driverpreprocess(repo, ms, wctx)
4371 4371 ms.commit()
4372 4372 # allow mark and unmark to go through
4373 4373 if not mark and not unmark and not proceed:
4374 4374 return 1
4375 4375
4376 4376 m = scmutil.match(wctx, pats, opts)
4377 4377 ret = 0
4378 4378 didwork = False
4379 4379 runconclude = False
4380 4380
4381 4381 tocomplete = []
4382 4382 for f in ms:
4383 4383 if not m(f):
4384 4384 continue
4385 4385
4386 4386 didwork = True
4387 4387
4388 4388 # don't let driver-resolved files be marked, and run the conclude
4389 4389 # step if asked to resolve
4390 4390 if ms[f] == "d":
4391 4391 exact = m.exact(f)
4392 4392 if mark:
4393 4393 if exact:
4394 4394 ui.warn(_('not marking %s as it is driver-resolved\n')
4395 4395 % f)
4396 4396 elif unmark:
4397 4397 if exact:
4398 4398 ui.warn(_('not unmarking %s as it is driver-resolved\n')
4399 4399 % f)
4400 4400 else:
4401 4401 runconclude = True
4402 4402 continue
4403 4403
4404 4404 # path conflicts must be resolved manually
4405 4405 if ms[f] in ("pu", "pr"):
4406 4406 if mark:
4407 4407 ms.mark(f, "pr")
4408 4408 elif unmark:
4409 4409 ms.mark(f, "pu")
4410 4410 elif ms[f] == "pu":
4411 4411 ui.warn(_('%s: path conflict must be resolved manually\n')
4412 4412 % f)
4413 4413 continue
4414 4414
4415 4415 if mark:
4416 4416 ms.mark(f, "r")
4417 4417 elif unmark:
4418 4418 ms.mark(f, "u")
4419 4419 else:
4420 4420 # backup pre-resolve (merge uses .orig for its own purposes)
4421 4421 a = repo.wjoin(f)
4422 4422 try:
4423 4423 util.copyfile(a, a + ".resolve")
4424 4424 except (IOError, OSError) as inst:
4425 4425 if inst.errno != errno.ENOENT:
4426 4426 raise
4427 4427
4428 4428 try:
4429 4429 # preresolve file
4430 4430 ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
4431 4431 'resolve')
4432 4432 complete, r = ms.preresolve(f, wctx)
4433 4433 if not complete:
4434 4434 tocomplete.append(f)
4435 4435 elif r:
4436 4436 ret = 1
4437 4437 finally:
4438 4438 ui.setconfig('ui', 'forcemerge', '', 'resolve')
4439 4439 ms.commit()
4440 4440
4441 4441 # replace filemerge's .orig file with our resolve file, but only
4442 4442 # for merges that are complete
4443 4443 if complete:
4444 4444 try:
4445 4445 util.rename(a + ".resolve",
4446 4446 scmutil.origpath(ui, repo, a))
4447 4447 except OSError as inst:
4448 4448 if inst.errno != errno.ENOENT:
4449 4449 raise
4450 4450
4451 4451 for f in tocomplete:
4452 4452 try:
4453 4453 # resolve file
4454 4454 ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
4455 4455 'resolve')
4456 4456 r = ms.resolve(f, wctx)
4457 4457 if r:
4458 4458 ret = 1
4459 4459 finally:
4460 4460 ui.setconfig('ui', 'forcemerge', '', 'resolve')
4461 4461 ms.commit()
4462 4462
4463 4463 # replace filemerge's .orig file with our resolve file
4464 4464 a = repo.wjoin(f)
4465 4465 try:
4466 4466 util.rename(a + ".resolve", scmutil.origpath(ui, repo, a))
4467 4467 except OSError as inst:
4468 4468 if inst.errno != errno.ENOENT:
4469 4469 raise
4470 4470
4471 4471 ms.commit()
4472 4472 ms.recordactions()
4473 4473
4474 4474 if not didwork and pats:
4475 4475 hint = None
4476 4476 if not any([p for p in pats if p.find(':') >= 0]):
4477 4477 pats = ['path:%s' % p for p in pats]
4478 4478 m = scmutil.match(wctx, pats, opts)
4479 4479 for f in ms:
4480 4480 if not m(f):
4481 4481 continue
4482 4482 flags = ''.join(['-%s ' % o[0] for o in flaglist
4483 4483 if opts.get(o)])
4484 4484 hint = _("(try: hg resolve %s%s)\n") % (
4485 4485 flags,
4486 4486 ' '.join(pats))
4487 4487 break
4488 4488 ui.warn(_("arguments do not match paths that need resolving\n"))
4489 4489 if hint:
4490 4490 ui.warn(hint)
4491 4491 elif ms.mergedriver and ms.mdstate() != 's':
4492 4492 # run conclude step when either a driver-resolved file is requested
4493 4493 # or there are no driver-resolved files
4494 4494 # we can't use 'ret' to determine whether any files are unresolved
4495 4495 # because we might not have tried to resolve some
4496 4496 if ((runconclude or not list(ms.driverresolved()))
4497 4497 and not list(ms.unresolved())):
4498 4498 proceed = mergemod.driverconclude(repo, ms, wctx)
4499 4499 ms.commit()
4500 4500 if not proceed:
4501 4501 return 1
4502 4502
4503 4503 # Nudge users into finishing an unfinished operation
4504 4504 unresolvedf = list(ms.unresolved())
4505 4505 driverresolvedf = list(ms.driverresolved())
4506 4506 if not unresolvedf and not driverresolvedf:
4507 4507 ui.status(_('(no more unresolved files)\n'))
4508 4508 cmdutil.checkafterresolved(repo)
4509 4509 elif not unresolvedf:
4510 4510 ui.status(_('(no more unresolved files -- '
4511 4511 'run "hg resolve --all" to conclude)\n'))
4512 4512
4513 4513 return ret
4514 4514
4515 4515 @command('revert',
4516 4516 [('a', 'all', None, _('revert all changes when no arguments given')),
4517 4517 ('d', 'date', '', _('tipmost revision matching date'), _('DATE')),
4518 4518 ('r', 'rev', '', _('revert to the specified revision'), _('REV')),
4519 4519 ('C', 'no-backup', None, _('do not save backup copies of files')),
4520 4520 ('i', 'interactive', None,
4521 4521 _('interactively select the changes (EXPERIMENTAL)')),
4522 4522 ] + walkopts + dryrunopts,
4523 4523 _('[OPTION]... [-r REV] [NAME]...'))
4524 4524 def revert(ui, repo, *pats, **opts):
4525 4525 """restore files to their checkout state
4526 4526
4527 4527 .. note::
4528 4528
4529 4529 To check out earlier revisions, you should use :hg:`update REV`.
4530 4530 To cancel an uncommitted merge (and lose your changes),
4531 4531 use :hg:`update --clean .`.
4532 4532
4533 4533 With no revision specified, revert the specified files or directories
4534 4534 to the contents they had in the parent of the working directory.
4535 4535 This restores the contents of files to an unmodified
4536 4536 state and unschedules adds, removes, copies, and renames. If the
4537 4537 working directory has two parents, you must explicitly specify a
4538 4538 revision.
4539 4539
4540 4540 Using the -r/--rev or -d/--date options, revert the given files or
4541 4541 directories to their states as of a specific revision. Because
4542 4542 revert does not change the working directory parents, this will
4543 4543 cause these files to appear modified. This can be helpful to "back
4544 4544 out" some or all of an earlier change. See :hg:`backout` for a
4545 4545 related method.
4546 4546
4547 4547 Modified files are saved with a .orig suffix before reverting.
4548 4548 To disable these backups, use --no-backup. It is possible to store
4549 4549 the backup files in a custom directory relative to the root of the
4550 4550 repository by setting the ``ui.origbackuppath`` configuration
4551 4551 option.
4552 4552
4553 4553 See :hg:`help dates` for a list of formats valid for -d/--date.
4554 4554
4555 4555 See :hg:`help backout` for a way to reverse the effect of an
4556 4556 earlier changeset.
4557 4557
4558 4558 Returns 0 on success.
4559 4559 """
4560 4560
4561 4561 if opts.get("date"):
4562 4562 if opts.get("rev"):
4563 4563 raise error.Abort(_("you can't specify a revision and a date"))
4564 4564 opts["rev"] = cmdutil.finddate(ui, repo, opts["date"])
4565 4565
4566 4566 parent, p2 = repo.dirstate.parents()
4567 4567 if not opts.get('rev') and p2 != nullid:
4568 4568 # revert after merge is a trap for new users (issue2915)
4569 4569 raise error.Abort(_('uncommitted merge with no revision specified'),
4570 4570 hint=_("use 'hg update' or see 'hg help revert'"))
4571 4571
4572 4572 ctx = scmutil.revsingle(repo, opts.get('rev'))
4573 4573
4574 4574 if (not (pats or opts.get('include') or opts.get('exclude') or
4575 4575 opts.get('all') or opts.get('interactive'))):
4576 4576 msg = _("no files or directories specified")
4577 4577 if p2 != nullid:
4578 4578 hint = _("uncommitted merge, use --all to discard all changes,"
4579 4579 " or 'hg update -C .' to abort the merge")
4580 4580 raise error.Abort(msg, hint=hint)
4581 4581 dirty = any(repo.status())
4582 4582 node = ctx.node()
4583 4583 if node != parent:
4584 4584 if dirty:
4585 4585 hint = _("uncommitted changes, use --all to discard all"
4586 4586 " changes, or 'hg update %s' to update") % ctx.rev()
4587 4587 else:
4588 4588 hint = _("use --all to revert all files,"
4589 4589 " or 'hg update %s' to update") % ctx.rev()
4590 4590 elif dirty:
4591 4591 hint = _("uncommitted changes, use --all to discard all changes")
4592 4592 else:
4593 4593 hint = _("use --all to revert all files")
4594 4594 raise error.Abort(msg, hint=hint)
4595 4595
4596 4596 return cmdutil.revert(ui, repo, ctx, (parent, p2), *pats, **opts)
4597 4597
4598 4598 @command('rollback', dryrunopts +
4599 4599 [('f', 'force', False, _('ignore safety measures'))])
4600 4600 def rollback(ui, repo, **opts):
4601 4601 """roll back the last transaction (DANGEROUS) (DEPRECATED)
4602 4602
4603 4603 Please use :hg:`commit --amend` instead of rollback to correct
4604 4604 mistakes in the last commit.
4605 4605
4606 4606 This command should be used with care. There is only one level of
4607 4607 rollback, and there is no way to undo a rollback. It will also
4608 4608 restore the dirstate at the time of the last transaction, losing
4609 4609 any dirstate changes since that time. This command does not alter
4610 4610 the working directory.
4611 4611
4612 4612 Transactions are used to encapsulate the effects of all commands
4613 4613 that create new changesets or propagate existing changesets into a
4614 4614 repository.
4615 4615
4616 4616 .. container:: verbose
4617 4617
4618 4618 For example, the following commands are transactional, and their
4619 4619 effects can be rolled back:
4620 4620
4621 4621 - commit
4622 4622 - import
4623 4623 - pull
4624 4624 - push (with this repository as the destination)
4625 4625 - unbundle
4626 4626
4627 4627 To avoid permanent data loss, rollback will refuse to rollback a
4628 4628 commit transaction if it isn't checked out. Use --force to
4629 4629 override this protection.
4630 4630
4631 4631 The rollback command can be entirely disabled by setting the
4632 4632 ``ui.rollback`` configuration setting to false. If you're here
4633 4633 because you want to use rollback and it's disabled, you can
4634 4634 re-enable the command by setting ``ui.rollback`` to true.
4635 4635
4636 4636 This command is not intended for use on public repositories. Once
4637 4637 changes are visible for pull by other users, rolling a transaction
4638 4638 back locally is ineffective (someone else may already have pulled
4639 4639 the changes). Furthermore, a race is possible with readers of the
4640 4640 repository; for example an in-progress pull from the repository
4641 4641 may fail if a rollback is performed.
4642 4642
4643 4643 Returns 0 on success, 1 if no rollback data is available.
4644 4644 """
4645 4645 if not ui.configbool('ui', 'rollback'):
4646 4646 raise error.Abort(_('rollback is disabled because it is unsafe'),
4647 4647 hint=('see `hg help -v rollback` for information'))
4648 4648 return repo.rollback(dryrun=opts.get(r'dry_run'),
4649 4649 force=opts.get(r'force'))
4650 4650
4651 4651 @command('root', [])
4652 4652 def root(ui, repo):
4653 4653 """print the root (top) of the current working directory
4654 4654
4655 4655 Print the root directory of the current repository.
4656 4656
4657 4657 Returns 0 on success.
4658 4658 """
4659 4659 ui.write(repo.root + "\n")
4660 4660
4661 4661 @command('^serve',
4662 4662 [('A', 'accesslog', '', _('name of access log file to write to'),
4663 4663 _('FILE')),
4664 4664 ('d', 'daemon', None, _('run server in background')),
4665 4665 ('', 'daemon-postexec', [], _('used internally by daemon mode')),
4666 4666 ('E', 'errorlog', '', _('name of error log file to write to'), _('FILE')),
4667 4667 # use string type, then we can check if something was passed
4668 4668 ('p', 'port', '', _('port to listen on (default: 8000)'), _('PORT')),
4669 4669 ('a', 'address', '', _('address to listen on (default: all interfaces)'),
4670 4670 _('ADDR')),
4671 4671 ('', 'prefix', '', _('prefix path to serve from (default: server root)'),
4672 4672 _('PREFIX')),
4673 4673 ('n', 'name', '',
4674 4674 _('name to show in web pages (default: working directory)'), _('NAME')),
4675 4675 ('', 'web-conf', '',
4676 4676 _("name of the hgweb config file (see 'hg help hgweb')"), _('FILE')),
4677 4677 ('', 'webdir-conf', '', _('name of the hgweb config file (DEPRECATED)'),
4678 4678 _('FILE')),
4679 4679 ('', 'pid-file', '', _('name of file to write process ID to'), _('FILE')),
4680 4680 ('', 'stdio', None, _('for remote clients (ADVANCED)')),
4681 4681 ('', 'cmdserver', '', _('for remote clients (ADVANCED)'), _('MODE')),
4682 4682 ('t', 'templates', '', _('web templates to use'), _('TEMPLATE')),
4683 4683 ('', 'style', '', _('template style to use'), _('STYLE')),
4684 4684 ('6', 'ipv6', None, _('use IPv6 in addition to IPv4')),
4685 4685 ('', 'certificate', '', _('SSL certificate file'), _('FILE'))]
4686 4686 + subrepoopts,
4687 4687 _('[OPTION]...'),
4688 4688 optionalrepo=True)
4689 4689 def serve(ui, repo, **opts):
4690 4690 """start stand-alone webserver
4691 4691
4692 4692 Start a local HTTP repository browser and pull server. You can use
4693 4693 this for ad-hoc sharing and browsing of repositories. It is
4694 4694 recommended to use a real web server to serve a repository for
4695 4695 longer periods of time.
4696 4696
4697 4697 Please note that the server does not implement access control.
4698 4698 This means that, by default, anybody can read from the server and
4699 4699 nobody can write to it by default. Set the ``web.allow_push``
4700 4700 option to ``*`` to allow everybody to push to the server. You
4701 4701 should use a real web server if you need to authenticate users.
4702 4702
4703 4703 By default, the server logs accesses to stdout and errors to
4704 4704 stderr. Use the -A/--accesslog and -E/--errorlog options to log to
4705 4705 files.
4706 4706
4707 4707 To have the server choose a free port number to listen on, specify
4708 4708 a port number of 0; in this case, the server will print the port
4709 4709 number it uses.
4710 4710
4711 4711 Returns 0 on success.
4712 4712 """
4713 4713
4714 4714 opts = pycompat.byteskwargs(opts)
4715 4715 if opts["stdio"] and opts["cmdserver"]:
4716 4716 raise error.Abort(_("cannot use --stdio with --cmdserver"))
4717 4717
4718 4718 if opts["stdio"]:
4719 4719 if repo is None:
4720 4720 raise error.RepoError(_("there is no Mercurial repository here"
4721 4721 " (.hg not found)"))
4722 4722 s = sshserver.sshserver(ui, repo)
4723 4723 s.serve_forever()
4724 4724
4725 4725 service = server.createservice(ui, repo, opts)
4726 4726 return server.runservice(opts, initfn=service.init, runfn=service.run)
4727 4727
4728 4728 @command('^status|st',
4729 4729 [('A', 'all', None, _('show status of all files')),
4730 4730 ('m', 'modified', None, _('show only modified files')),
4731 4731 ('a', 'added', None, _('show only added files')),
4732 4732 ('r', 'removed', None, _('show only removed files')),
4733 4733 ('d', 'deleted', None, _('show only deleted (but tracked) files')),
4734 4734 ('c', 'clean', None, _('show only files without changes')),
4735 4735 ('u', 'unknown', None, _('show only unknown (not tracked) files')),
4736 4736 ('i', 'ignored', None, _('show only ignored files')),
4737 4737 ('n', 'no-status', None, _('hide status prefix')),
4738 4738 ('t', 'terse', '', _('show the terse output (EXPERIMENTAL)')),
4739 4739 ('C', 'copies', None, _('show source of copied files')),
4740 4740 ('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
4741 4741 ('', 'rev', [], _('show difference from revision'), _('REV')),
4742 4742 ('', 'change', '', _('list the changed files of a revision'), _('REV')),
4743 4743 ] + walkopts + subrepoopts + formatteropts,
4744 4744 _('[OPTION]... [FILE]...'),
4745 4745 inferrepo=True)
4746 4746 def status(ui, repo, *pats, **opts):
4747 4747 """show changed files in the working directory
4748 4748
4749 4749 Show status of files in the repository. If names are given, only
4750 4750 files that match are shown. Files that are clean or ignored or
4751 4751 the source of a copy/move operation, are not listed unless
4752 4752 -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
4753 4753 Unless options described with "show only ..." are given, the
4754 4754 options -mardu are used.
4755 4755
4756 4756 Option -q/--quiet hides untracked (unknown and ignored) files
4757 4757 unless explicitly requested with -u/--unknown or -i/--ignored.
4758 4758
4759 4759 .. note::
4760 4760
4761 4761 :hg:`status` may appear to disagree with diff if permissions have
4762 4762 changed or a merge has occurred. The standard diff format does
4763 4763 not report permission changes and diff only reports changes
4764 4764 relative to one merge parent.
4765 4765
4766 4766 If one revision is given, it is used as the base revision.
4767 4767 If two revisions are given, the differences between them are
4768 4768 shown. The --change option can also be used as a shortcut to list
4769 4769 the changed files of a revision from its first parent.
4770 4770
4771 4771 The codes used to show the status of files are::
4772 4772
4773 4773 M = modified
4774 4774 A = added
4775 4775 R = removed
4776 4776 C = clean
4777 4777 ! = missing (deleted by non-hg command, but still tracked)
4778 4778 ? = not tracked
4779 4779 I = ignored
4780 4780 = origin of the previous file (with --copies)
4781 4781
4782 4782 .. container:: verbose
4783 4783
4784 4784 The -t/--terse option abbreviates the output by showing only the directory
4785 4785 name if all the files in it share the same status. The option takes an
4786 4786 argument indicating the statuses to abbreviate: 'm' for 'modified', 'a'
4787 4787 for 'added', 'r' for 'removed', 'd' for 'deleted', 'u' for 'unknown', 'i'
4788 4788 for 'ignored' and 'c' for clean.
4789 4789
4790 4790 It abbreviates only those statuses which are passed. Note that clean and
4791 4791 ignored files are not displayed with '--terse ic' unless the -c/--clean
4792 4792 and -i/--ignored options are also used.
4793 4793
4794 4794 The -v/--verbose option shows information when the repository is in an
4795 4795 unfinished merge, shelve, rebase state etc. You can have this behavior
4796 4796 turned on by default by enabling the ``commands.status.verbose`` option.
4797 4797
4798 4798 You can skip displaying some of these states by setting
4799 4799 ``commands.status.skipstates`` to one or more of: 'bisect', 'graft',
4800 4800 'histedit', 'merge', 'rebase', or 'unshelve'.
4801 4801
4802 4802 Examples:
4803 4803
4804 4804 - show changes in the working directory relative to a
4805 4805 changeset::
4806 4806
4807 4807 hg status --rev 9353
4808 4808
4809 4809 - show changes in the working directory relative to the
4810 4810 current directory (see :hg:`help patterns` for more information)::
4811 4811
4812 4812 hg status re:
4813 4813
4814 4814 - show all changes including copies in an existing changeset::
4815 4815
4816 4816 hg status --copies --change 9353
4817 4817
4818 4818 - get a NUL separated list of added files, suitable for xargs::
4819 4819
4820 4820 hg status -an0
4821 4821
4822 4822 - show more information about the repository status, abbreviating
4823 4823 added, removed, modified, deleted, and untracked paths::
4824 4824
4825 4825 hg status -v -t mardu
4826 4826
4827 4827 Returns 0 on success.
4828 4828
4829 4829 """
4830 4830
4831 4831 opts = pycompat.byteskwargs(opts)
4832 4832 revs = opts.get('rev')
4833 4833 change = opts.get('change')
4834 4834 terse = opts.get('terse')
4835 4835
4836 4836 if revs and change:
4837 4837 msg = _('cannot specify --rev and --change at the same time')
4838 4838 raise error.Abort(msg)
4839 4839 elif revs and terse:
4840 4840 msg = _('cannot use --terse with --rev')
4841 4841 raise error.Abort(msg)
4842 4842 elif change:
4843 4843 node2 = scmutil.revsingle(repo, change, None).node()
4844 4844 node1 = repo[node2].p1().node()
4845 4845 else:
4846 4846 node1, node2 = scmutil.revpair(repo, revs)
4847 4847
4848 4848 if pats or ui.configbool('commands', 'status.relative'):
4849 4849 cwd = repo.getcwd()
4850 4850 else:
4851 4851 cwd = ''
4852 4852
4853 4853 if opts.get('print0'):
4854 4854 end = '\0'
4855 4855 else:
4856 4856 end = '\n'
4857 4857 copy = {}
4858 4858 states = 'modified added removed deleted unknown ignored clean'.split()
4859 4859 show = [k for k in states if opts.get(k)]
4860 4860 if opts.get('all'):
4861 4861 show += ui.quiet and (states[:4] + ['clean']) or states
4862 4862
4863 4863 if not show:
4864 4864 if ui.quiet:
4865 4865 show = states[:4]
4866 4866 else:
4867 4867 show = states[:5]
4868 4868
4869 4869 m = scmutil.match(repo[node2], pats, opts)
4870 4870 if terse:
4871 4871 # we need to compute clean and unknown to terse
4872 4872 stat = repo.status(node1, node2, m,
4873 4873 'ignored' in show or 'i' in terse,
4874 4874 True, True, opts.get('subrepos'))
4875 4875
4876 4876 stat = cmdutil.tersedir(stat, terse)
4877 4877 else:
4878 4878 stat = repo.status(node1, node2, m,
4879 4879 'ignored' in show, 'clean' in show,
4880 4880 'unknown' in show, opts.get('subrepos'))
4881 4881
4882 4882 changestates = zip(states, pycompat.iterbytestr('MAR!?IC'), stat)
4883 4883
4884 4884 if (opts.get('all') or opts.get('copies')
4885 4885 or ui.configbool('ui', 'statuscopies')) and not opts.get('no_status'):
4886 4886 copy = copies.pathcopies(repo[node1], repo[node2], m)
4887 4887
4888 4888 ui.pager('status')
4889 4889 fm = ui.formatter('status', opts)
4890 4890 fmt = '%s' + end
4891 4891 showchar = not opts.get('no_status')
4892 4892
4893 4893 for state, char, files in changestates:
4894 4894 if state in show:
4895 4895 label = 'status.' + state
4896 4896 for f in files:
4897 4897 fm.startitem()
4898 4898 fm.condwrite(showchar, 'status', '%s ', char, label=label)
4899 4899 fm.write('path', fmt, repo.pathto(f, cwd), label=label)
4900 4900 if f in copy:
4901 4901 fm.write("copy", ' %s' + end, repo.pathto(copy[f], cwd),
4902 4902 label='status.copied')
4903 4903
4904 4904 if ((ui.verbose or ui.configbool('commands', 'status.verbose'))
4905 4905 and not ui.plain()):
4906 4906 cmdutil.morestatus(repo, fm)
4907 4907 fm.end()
4908 4908
4909 4909 @command('^summary|sum',
4910 4910 [('', 'remote', None, _('check for push and pull'))], '[--remote]')
4911 4911 def summary(ui, repo, **opts):
4912 4912 """summarize working directory state
4913 4913
4914 4914 This generates a brief summary of the working directory state,
4915 4915 including parents, branch, commit status, phase and available updates.
4916 4916
4917 4917 With the --remote option, this will check the default paths for
4918 4918 incoming and outgoing changes. This can be time-consuming.
4919 4919
4920 4920 Returns 0 on success.
4921 4921 """
4922 4922
4923 4923 opts = pycompat.byteskwargs(opts)
4924 4924 ui.pager('summary')
4925 4925 ctx = repo[None]
4926 4926 parents = ctx.parents()
4927 4927 pnode = parents[0].node()
4928 4928 marks = []
4929 4929
4930 4930 ms = None
4931 4931 try:
4932 4932 ms = mergemod.mergestate.read(repo)
4933 4933 except error.UnsupportedMergeRecords as e:
4934 4934 s = ' '.join(e.recordtypes)
4935 4935 ui.warn(
4936 4936 _('warning: merge state has unsupported record types: %s\n') % s)
4937 4937 unresolved = []
4938 4938 else:
4939 4939 unresolved = list(ms.unresolved())
4940 4940
4941 4941 for p in parents:
4942 4942 # label with log.changeset (instead of log.parent) since this
4943 4943 # shows a working directory parent *changeset*:
4944 4944 # i18n: column positioning for "hg summary"
4945 4945 ui.write(_('parent: %d:%s ') % (p.rev(), p),
4946 4946 label=cmdutil._changesetlabels(p))
4947 4947 ui.write(' '.join(p.tags()), label='log.tag')
4948 4948 if p.bookmarks():
4949 4949 marks.extend(p.bookmarks())
4950 4950 if p.rev() == -1:
4951 4951 if not len(repo):
4952 4952 ui.write(_(' (empty repository)'))
4953 4953 else:
4954 4954 ui.write(_(' (no revision checked out)'))
4955 4955 if p.obsolete():
4956 4956 ui.write(_(' (obsolete)'))
4957 4957 if p.isunstable():
4958 4958 instabilities = (ui.label(instability, 'trouble.%s' % instability)
4959 4959 for instability in p.instabilities())
4960 4960 ui.write(' ('
4961 4961 + ', '.join(instabilities)
4962 4962 + ')')
4963 4963 ui.write('\n')
4964 4964 if p.description():
4965 4965 ui.status(' ' + p.description().splitlines()[0].strip() + '\n',
4966 4966 label='log.summary')
4967 4967
4968 4968 branch = ctx.branch()
4969 4969 bheads = repo.branchheads(branch)
4970 4970 # i18n: column positioning for "hg summary"
4971 4971 m = _('branch: %s\n') % branch
4972 4972 if branch != 'default':
4973 4973 ui.write(m, label='log.branch')
4974 4974 else:
4975 4975 ui.status(m, label='log.branch')
4976 4976
4977 4977 if marks:
4978 4978 active = repo._activebookmark
4979 4979 # i18n: column positioning for "hg summary"
4980 4980 ui.write(_('bookmarks:'), label='log.bookmark')
4981 4981 if active is not None:
4982 4982 if active in marks:
4983 4983 ui.write(' *' + active, label=bookmarks.activebookmarklabel)
4984 4984 marks.remove(active)
4985 4985 else:
4986 4986 ui.write(' [%s]' % active, label=bookmarks.activebookmarklabel)
4987 4987 for m in marks:
4988 4988 ui.write(' ' + m, label='log.bookmark')
4989 4989 ui.write('\n', label='log.bookmark')
4990 4990
4991 4991 status = repo.status(unknown=True)
4992 4992
4993 4993 c = repo.dirstate.copies()
4994 4994 copied, renamed = [], []
4995 4995 for d, s in c.iteritems():
4996 4996 if s in status.removed:
4997 4997 status.removed.remove(s)
4998 4998 renamed.append(d)
4999 4999 else:
5000 5000 copied.append(d)
5001 5001 if d in status.added:
5002 5002 status.added.remove(d)
5003 5003
5004 5004 subs = [s for s in ctx.substate if ctx.sub(s).dirty()]
5005 5005
5006 5006 labels = [(ui.label(_('%d modified'), 'status.modified'), status.modified),
5007 5007 (ui.label(_('%d added'), 'status.added'), status.added),
5008 5008 (ui.label(_('%d removed'), 'status.removed'), status.removed),
5009 5009 (ui.label(_('%d renamed'), 'status.copied'), renamed),
5010 5010 (ui.label(_('%d copied'), 'status.copied'), copied),
5011 5011 (ui.label(_('%d deleted'), 'status.deleted'), status.deleted),
5012 5012 (ui.label(_('%d unknown'), 'status.unknown'), status.unknown),
5013 5013 (ui.label(_('%d unresolved'), 'resolve.unresolved'), unresolved),
5014 5014 (ui.label(_('%d subrepos'), 'status.modified'), subs)]
5015 5015 t = []
5016 5016 for l, s in labels:
5017 5017 if s:
5018 5018 t.append(l % len(s))
5019 5019
5020 5020 t = ', '.join(t)
5021 5021 cleanworkdir = False
5022 5022
5023 5023 if repo.vfs.exists('graftstate'):
5024 5024 t += _(' (graft in progress)')
5025 5025 if repo.vfs.exists('updatestate'):
5026 5026 t += _(' (interrupted update)')
5027 5027 elif len(parents) > 1:
5028 5028 t += _(' (merge)')
5029 5029 elif branch != parents[0].branch():
5030 5030 t += _(' (new branch)')
5031 5031 elif (parents[0].closesbranch() and
5032 5032 pnode in repo.branchheads(branch, closed=True)):
5033 5033 t += _(' (head closed)')
5034 5034 elif not (status.modified or status.added or status.removed or renamed or
5035 5035 copied or subs):
5036 5036 t += _(' (clean)')
5037 5037 cleanworkdir = True
5038 5038 elif pnode not in bheads:
5039 5039 t += _(' (new branch head)')
5040 5040
5041 5041 if parents:
5042 5042 pendingphase = max(p.phase() for p in parents)
5043 5043 else:
5044 5044 pendingphase = phases.public
5045 5045
5046 5046 if pendingphase > phases.newcommitphase(ui):
5047 5047 t += ' (%s)' % phases.phasenames[pendingphase]
5048 5048
5049 5049 if cleanworkdir:
5050 5050 # i18n: column positioning for "hg summary"
5051 5051 ui.status(_('commit: %s\n') % t.strip())
5052 5052 else:
5053 5053 # i18n: column positioning for "hg summary"
5054 5054 ui.write(_('commit: %s\n') % t.strip())
5055 5055
5056 5056 # all ancestors of branch heads - all ancestors of parent = new csets
5057 5057 new = len(repo.changelog.findmissing([pctx.node() for pctx in parents],
5058 5058 bheads))
5059 5059
5060 5060 if new == 0:
5061 5061 # i18n: column positioning for "hg summary"
5062 5062 ui.status(_('update: (current)\n'))
5063 5063 elif pnode not in bheads:
5064 5064 # i18n: column positioning for "hg summary"
5065 5065 ui.write(_('update: %d new changesets (update)\n') % new)
5066 5066 else:
5067 5067 # i18n: column positioning for "hg summary"
5068 5068 ui.write(_('update: %d new changesets, %d branch heads (merge)\n') %
5069 5069 (new, len(bheads)))
5070 5070
5071 5071 t = []
5072 5072 draft = len(repo.revs('draft()'))
5073 5073 if draft:
5074 5074 t.append(_('%d draft') % draft)
5075 5075 secret = len(repo.revs('secret()'))
5076 5076 if secret:
5077 5077 t.append(_('%d secret') % secret)
5078 5078
5079 5079 if draft or secret:
5080 5080 ui.status(_('phases: %s\n') % ', '.join(t))
5081 5081
5082 5082 if obsolete.isenabled(repo, obsolete.createmarkersopt):
5083 5083 for trouble in ("orphan", "contentdivergent", "phasedivergent"):
5084 5084 numtrouble = len(repo.revs(trouble + "()"))
5085 5085 # We write all the possibilities to ease translation
5086 5086 troublemsg = {
5087 5087 "orphan": _("orphan: %d changesets"),
5088 5088 "contentdivergent": _("content-divergent: %d changesets"),
5089 5089 "phasedivergent": _("phase-divergent: %d changesets"),
5090 5090 }
5091 5091 if numtrouble > 0:
5092 5092 ui.status(troublemsg[trouble] % numtrouble + "\n")
5093 5093
5094 5094 cmdutil.summaryhooks(ui, repo)
5095 5095
5096 5096 if opts.get('remote'):
5097 5097 needsincoming, needsoutgoing = True, True
5098 5098 else:
5099 5099 needsincoming, needsoutgoing = False, False
5100 5100 for i, o in cmdutil.summaryremotehooks(ui, repo, opts, None):
5101 5101 if i:
5102 5102 needsincoming = True
5103 5103 if o:
5104 5104 needsoutgoing = True
5105 5105 if not needsincoming and not needsoutgoing:
5106 5106 return
5107 5107
5108 5108 def getincoming():
5109 5109 source, branches = hg.parseurl(ui.expandpath('default'))
5110 5110 sbranch = branches[0]
5111 5111 try:
5112 5112 other = hg.peer(repo, {}, source)
5113 5113 except error.RepoError:
5114 5114 if opts.get('remote'):
5115 5115 raise
5116 5116 return source, sbranch, None, None, None
5117 5117 revs, checkout = hg.addbranchrevs(repo, other, branches, None)
5118 5118 if revs:
5119 5119 revs = [other.lookup(rev) for rev in revs]
5120 5120 ui.debug('comparing with %s\n' % util.hidepassword(source))
5121 5121 repo.ui.pushbuffer()
5122 5122 commoninc = discovery.findcommonincoming(repo, other, heads=revs)
5123 5123 repo.ui.popbuffer()
5124 5124 return source, sbranch, other, commoninc, commoninc[1]
5125 5125
5126 5126 if needsincoming:
5127 5127 source, sbranch, sother, commoninc, incoming = getincoming()
5128 5128 else:
5129 5129 source = sbranch = sother = commoninc = incoming = None
5130 5130
5131 5131 def getoutgoing():
5132 5132 dest, branches = hg.parseurl(ui.expandpath('default-push', 'default'))
5133 5133 dbranch = branches[0]
5134 5134 revs, checkout = hg.addbranchrevs(repo, repo, branches, None)
5135 5135 if source != dest:
5136 5136 try:
5137 5137 dother = hg.peer(repo, {}, dest)
5138 5138 except error.RepoError:
5139 5139 if opts.get('remote'):
5140 5140 raise
5141 5141 return dest, dbranch, None, None
5142 5142 ui.debug('comparing with %s\n' % util.hidepassword(dest))
5143 5143 elif sother is None:
5144 5144 # there is no explicit destination peer, but source one is invalid
5145 5145 return dest, dbranch, None, None
5146 5146 else:
5147 5147 dother = sother
5148 5148 if (source != dest or (sbranch is not None and sbranch != dbranch)):
5149 5149 common = None
5150 5150 else:
5151 5151 common = commoninc
5152 5152 if revs:
5153 5153 revs = [repo.lookup(rev) for rev in revs]
5154 5154 repo.ui.pushbuffer()
5155 5155 outgoing = discovery.findcommonoutgoing(repo, dother, onlyheads=revs,
5156 5156 commoninc=common)
5157 5157 repo.ui.popbuffer()
5158 5158 return dest, dbranch, dother, outgoing
5159 5159
5160 5160 if needsoutgoing:
5161 5161 dest, dbranch, dother, outgoing = getoutgoing()
5162 5162 else:
5163 5163 dest = dbranch = dother = outgoing = None
5164 5164
5165 5165 if opts.get('remote'):
5166 5166 t = []
5167 5167 if incoming:
5168 5168 t.append(_('1 or more incoming'))
5169 5169 o = outgoing.missing
5170 5170 if o:
5171 5171 t.append(_('%d outgoing') % len(o))
5172 5172 other = dother or sother
5173 5173 if 'bookmarks' in other.listkeys('namespaces'):
5174 5174 counts = bookmarks.summary(repo, other)
5175 5175 if counts[0] > 0:
5176 5176 t.append(_('%d incoming bookmarks') % counts[0])
5177 5177 if counts[1] > 0:
5178 5178 t.append(_('%d outgoing bookmarks') % counts[1])
5179 5179
5180 5180 if t:
5181 5181 # i18n: column positioning for "hg summary"
5182 5182 ui.write(_('remote: %s\n') % (', '.join(t)))
5183 5183 else:
5184 5184 # i18n: column positioning for "hg summary"
5185 5185 ui.status(_('remote: (synced)\n'))
5186 5186
5187 5187 cmdutil.summaryremotehooks(ui, repo, opts,
5188 5188 ((source, sbranch, sother, commoninc),
5189 5189 (dest, dbranch, dother, outgoing)))
5190 5190
5191 5191 @command('tag',
5192 5192 [('f', 'force', None, _('force tag')),
5193 5193 ('l', 'local', None, _('make the tag local')),
5194 5194 ('r', 'rev', '', _('revision to tag'), _('REV')),
5195 5195 ('', 'remove', None, _('remove a tag')),
5196 5196 # -l/--local is already there, commitopts cannot be used
5197 5197 ('e', 'edit', None, _('invoke editor on commit messages')),
5198 5198 ('m', 'message', '', _('use text as commit message'), _('TEXT')),
5199 5199 ] + commitopts2,
5200 5200 _('[-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...'))
5201 5201 def tag(ui, repo, name1, *names, **opts):
5202 5202 """add one or more tags for the current or given revision
5203 5203
5204 5204 Name a particular revision using <name>.
5205 5205
5206 5206 Tags are used to name particular revisions of the repository and are
5207 5207 very useful to compare different revisions, to go back to significant
5208 5208 earlier versions or to mark branch points as releases, etc. Changing
5209 5209 an existing tag is normally disallowed; use -f/--force to override.
5210 5210
5211 5211 If no revision is given, the parent of the working directory is
5212 5212 used.
5213 5213
5214 5214 To facilitate version control, distribution, and merging of tags,
5215 5215 they are stored as a file named ".hgtags" which is managed similarly
5216 5216 to other project files and can be hand-edited if necessary. This
5217 5217 also means that tagging creates a new commit. The file
5218 5218 ".hg/localtags" is used for local tags (not shared among
5219 5219 repositories).
5220 5220
5221 5221 Tag commits are usually made at the head of a branch. If the parent
5222 5222 of the working directory is not a branch head, :hg:`tag` aborts; use
5223 5223 -f/--force to force the tag commit to be based on a non-head
5224 5224 changeset.
5225 5225
5226 5226 See :hg:`help dates` for a list of formats valid for -d/--date.
5227 5227
5228 5228 Since tag names have priority over branch names during revision
5229 5229 lookup, using an existing branch name as a tag name is discouraged.
5230 5230
5231 5231 Returns 0 on success.
5232 5232 """
5233 5233 opts = pycompat.byteskwargs(opts)
5234 5234 wlock = lock = None
5235 5235 try:
5236 5236 wlock = repo.wlock()
5237 5237 lock = repo.lock()
5238 5238 rev_ = "."
5239 5239 names = [t.strip() for t in (name1,) + names]
5240 5240 if len(names) != len(set(names)):
5241 5241 raise error.Abort(_('tag names must be unique'))
5242 5242 for n in names:
5243 5243 scmutil.checknewlabel(repo, n, 'tag')
5244 5244 if not n:
5245 5245 raise error.Abort(_('tag names cannot consist entirely of '
5246 5246 'whitespace'))
5247 5247 if opts.get('rev') and opts.get('remove'):
5248 5248 raise error.Abort(_("--rev and --remove are incompatible"))
5249 5249 if opts.get('rev'):
5250 5250 rev_ = opts['rev']
5251 5251 message = opts.get('message')
5252 5252 if opts.get('remove'):
5253 5253 if opts.get('local'):
5254 5254 expectedtype = 'local'
5255 5255 else:
5256 5256 expectedtype = 'global'
5257 5257
5258 5258 for n in names:
5259 5259 if not repo.tagtype(n):
5260 5260 raise error.Abort(_("tag '%s' does not exist") % n)
5261 5261 if repo.tagtype(n) != expectedtype:
5262 5262 if expectedtype == 'global':
5263 5263 raise error.Abort(_("tag '%s' is not a global tag") % n)
5264 5264 else:
5265 5265 raise error.Abort(_("tag '%s' is not a local tag") % n)
5266 5266 rev_ = 'null'
5267 5267 if not message:
5268 5268 # we don't translate commit messages
5269 5269 message = 'Removed tag %s' % ', '.join(names)
5270 5270 elif not opts.get('force'):
5271 5271 for n in names:
5272 5272 if n in repo.tags():
5273 5273 raise error.Abort(_("tag '%s' already exists "
5274 5274 "(use -f to force)") % n)
5275 5275 if not opts.get('local'):
5276 5276 p1, p2 = repo.dirstate.parents()
5277 5277 if p2 != nullid:
5278 5278 raise error.Abort(_('uncommitted merge'))
5279 5279 bheads = repo.branchheads()
5280 5280 if not opts.get('force') and bheads and p1 not in bheads:
5281 5281 raise error.Abort(_('working directory is not at a branch head '
5282 5282 '(use -f to force)'))
5283 5283 r = scmutil.revsingle(repo, rev_).node()
5284 5284
5285 5285 if not message:
5286 5286 # we don't translate commit messages
5287 5287 message = ('Added tag %s for changeset %s' %
5288 5288 (', '.join(names), short(r)))
5289 5289
5290 5290 date = opts.get('date')
5291 5291 if date:
5292 5292 date = util.parsedate(date)
5293 5293
5294 5294 if opts.get('remove'):
5295 5295 editform = 'tag.remove'
5296 5296 else:
5297 5297 editform = 'tag.add'
5298 5298 editor = cmdutil.getcommiteditor(editform=editform,
5299 5299 **pycompat.strkwargs(opts))
5300 5300
5301 5301 # don't allow tagging the null rev
5302 5302 if (not opts.get('remove') and
5303 5303 scmutil.revsingle(repo, rev_).rev() == nullrev):
5304 5304 raise error.Abort(_("cannot tag null revision"))
5305 5305
5306 5306 tagsmod.tag(repo, names, r, message, opts.get('local'),
5307 5307 opts.get('user'), date, editor=editor)
5308 5308 finally:
5309 5309 release(lock, wlock)
5310 5310
5311 5311 @command('tags', formatteropts, '')
5312 5312 def tags(ui, repo, **opts):
5313 5313 """list repository tags
5314 5314
5315 5315 This lists both regular and local tags. When the -v/--verbose
5316 5316 switch is used, a third column "local" is printed for local tags.
5317 5317 When the -q/--quiet switch is used, only the tag name is printed.
5318 5318
5319 5319 Returns 0 on success.
5320 5320 """
5321 5321
5322 5322 opts = pycompat.byteskwargs(opts)
5323 5323 ui.pager('tags')
5324 5324 fm = ui.formatter('tags', opts)
5325 5325 hexfunc = fm.hexfunc
5326 5326 tagtype = ""
5327 5327
5328 5328 for t, n in reversed(repo.tagslist()):
5329 5329 hn = hexfunc(n)
5330 5330 label = 'tags.normal'
5331 5331 tagtype = ''
5332 5332 if repo.tagtype(t) == 'local':
5333 5333 label = 'tags.local'
5334 5334 tagtype = 'local'
5335 5335
5336 5336 fm.startitem()
5337 5337 fm.write('tag', '%s', t, label=label)
5338 5338 fmt = " " * (30 - encoding.colwidth(t)) + ' %5d:%s'
5339 5339 fm.condwrite(not ui.quiet, 'rev node', fmt,
5340 5340 repo.changelog.rev(n), hn, label=label)
5341 5341 fm.condwrite(ui.verbose and tagtype, 'type', ' %s',
5342 5342 tagtype, label=label)
5343 5343 fm.plain('\n')
5344 5344 fm.end()
5345 5345
5346 5346 @command('tip',
5347 5347 [('p', 'patch', None, _('show patch')),
5348 5348 ('g', 'git', None, _('use git extended diff format')),
5349 5349 ] + templateopts,
5350 5350 _('[-p] [-g]'))
5351 5351 def tip(ui, repo, **opts):
5352 5352 """show the tip revision (DEPRECATED)
5353 5353
5354 5354 The tip revision (usually just called the tip) is the changeset
5355 5355 most recently added to the repository (and therefore the most
5356 5356 recently changed head).
5357 5357
5358 5358 If you have just made a commit, that commit will be the tip. If
5359 5359 you have just pulled changes from another repository, the tip of
5360 5360 that repository becomes the current tip. The "tip" tag is special
5361 5361 and cannot be renamed or assigned to a different changeset.
5362 5362
5363 5363 This command is deprecated, please use :hg:`heads` instead.
5364 5364
5365 5365 Returns 0 on success.
5366 5366 """
5367 5367 opts = pycompat.byteskwargs(opts)
5368 5368 displayer = cmdutil.show_changeset(ui, repo, opts)
5369 5369 displayer.show(repo['tip'])
5370 5370 displayer.close()
5371 5371
5372 5372 @command('unbundle',
5373 5373 [('u', 'update', None,
5374 5374 _('update to new branch head if changesets were unbundled'))],
5375 5375 _('[-u] FILE...'))
5376 5376 def unbundle(ui, repo, fname1, *fnames, **opts):
5377 5377 """apply one or more bundle files
5378 5378
5379 5379 Apply one or more bundle files generated by :hg:`bundle`.
5380 5380
5381 5381 Returns 0 on success, 1 if an update has unresolved files.
5382 5382 """
5383 5383 fnames = (fname1,) + fnames
5384 5384
5385 5385 with repo.lock():
5386 5386 for fname in fnames:
5387 5387 f = hg.openpath(ui, fname)
5388 5388 gen = exchange.readbundle(ui, f, fname)
5389 5389 if isinstance(gen, streamclone.streamcloneapplier):
5390 5390 raise error.Abort(
5391 5391 _('packed bundles cannot be applied with '
5392 5392 '"hg unbundle"'),
5393 5393 hint=_('use "hg debugapplystreamclonebundle"'))
5394 5394 url = 'bundle:' + fname
5395 5395 try:
5396 5396 txnname = 'unbundle'
5397 5397 if not isinstance(gen, bundle2.unbundle20):
5398 5398 txnname = 'unbundle\n%s' % util.hidepassword(url)
5399 5399 with repo.transaction(txnname) as tr:
5400 5400 op = bundle2.applybundle(repo, gen, tr, source='unbundle',
5401 5401 url=url)
5402 5402 except error.BundleUnknownFeatureError as exc:
5403 5403 raise error.Abort(
5404 5404 _('%s: unknown bundle feature, %s') % (fname, exc),
5405 5405 hint=_("see https://mercurial-scm.org/"
5406 5406 "wiki/BundleFeature for more "
5407 5407 "information"))
5408 5408 modheads = bundle2.combinechangegroupresults(op)
5409 5409
5410 5410 return postincoming(ui, repo, modheads, opts.get(r'update'), None, None)
5411 5411
5412 5412 @command('^update|up|checkout|co',
5413 5413 [('C', 'clean', None, _('discard uncommitted changes (no backup)')),
5414 5414 ('c', 'check', None, _('require clean working directory')),
5415 5415 ('m', 'merge', None, _('merge uncommitted changes')),
5416 5416 ('d', 'date', '', _('tipmost revision matching date'), _('DATE')),
5417 5417 ('r', 'rev', '', _('revision'), _('REV'))
5418 5418 ] + mergetoolopts,
5419 5419 _('[-C|-c|-m] [-d DATE] [[-r] REV]'))
5420 5420 def update(ui, repo, node=None, rev=None, clean=False, date=None, check=False,
5421 5421 merge=None, tool=None):
5422 5422 """update working directory (or switch revisions)
5423 5423
5424 5424 Update the repository's working directory to the specified
5425 5425 changeset. If no changeset is specified, update to the tip of the
5426 5426 current named branch and move the active bookmark (see :hg:`help
5427 5427 bookmarks`).
5428 5428
5429 5429 Update sets the working directory's parent revision to the specified
5430 5430 changeset (see :hg:`help parents`).
5431 5431
5432 5432 If the changeset is not a descendant or ancestor of the working
5433 5433 directory's parent and there are uncommitted changes, the update is
5434 5434 aborted. With the -c/--check option, the working directory is checked
5435 5435 for uncommitted changes; if none are found, the working directory is
5436 5436 updated to the specified changeset.
5437 5437
5438 5438 .. container:: verbose
5439 5439
5440 5440 The -C/--clean, -c/--check, and -m/--merge options control what
5441 5441 happens if the working directory contains uncommitted changes.
5442 5442 At most of one of them can be specified.
5443 5443
5444 5444 1. If no option is specified, and if
5445 5445 the requested changeset is an ancestor or descendant of
5446 5446 the working directory's parent, the uncommitted changes
5447 5447 are merged into the requested changeset and the merged
5448 5448 result is left uncommitted. If the requested changeset is
5449 5449 not an ancestor or descendant (that is, it is on another
5450 5450 branch), the update is aborted and the uncommitted changes
5451 5451 are preserved.
5452 5452
5453 5453 2. With the -m/--merge option, the update is allowed even if the
5454 5454 requested changeset is not an ancestor or descendant of
5455 5455 the working directory's parent.
5456 5456
5457 5457 3. With the -c/--check option, the update is aborted and the
5458 5458 uncommitted changes are preserved.
5459 5459
5460 5460 4. With the -C/--clean option, uncommitted changes are discarded and
5461 5461 the working directory is updated to the requested changeset.
5462 5462
5463 5463 To cancel an uncommitted merge (and lose your changes), use
5464 5464 :hg:`update --clean .`.
5465 5465
5466 5466 Use null as the changeset to remove the working directory (like
5467 5467 :hg:`clone -U`).
5468 5468
5469 5469 If you want to revert just one file to an older revision, use
5470 5470 :hg:`revert [-r REV] NAME`.
5471 5471
5472 5472 See :hg:`help dates` for a list of formats valid for -d/--date.
5473 5473
5474 5474 Returns 0 on success, 1 if there are unresolved files.
5475 5475 """
5476 5476 if rev and node:
5477 5477 raise error.Abort(_("please specify just one revision"))
5478 5478
5479 5479 if ui.configbool('commands', 'update.requiredest'):
5480 5480 if not node and not rev and not date:
5481 5481 raise error.Abort(_('you must specify a destination'),
5482 5482 hint=_('for example: hg update ".::"'))
5483 5483
5484 5484 if rev is None or rev == '':
5485 5485 rev = node
5486 5486
5487 5487 if date and rev is not None:
5488 5488 raise error.Abort(_("you can't specify a revision and a date"))
5489 5489
5490 5490 if len([x for x in (clean, check, merge) if x]) > 1:
5491 5491 raise error.Abort(_("can only specify one of -C/--clean, -c/--check, "
5492 5492 "or -m/--merge"))
5493 5493
5494 5494 updatecheck = None
5495 5495 if check:
5496 5496 updatecheck = 'abort'
5497 5497 elif merge:
5498 5498 updatecheck = 'none'
5499 5499
5500 5500 with repo.wlock():
5501 5501 cmdutil.clearunfinished(repo)
5502 5502
5503 5503 if date:
5504 5504 rev = cmdutil.finddate(ui, repo, date)
5505 5505
5506 5506 # if we defined a bookmark, we have to remember the original name
5507 5507 brev = rev
5508 5508 rev = scmutil.revsingle(repo, rev, rev).rev()
5509 5509
5510 5510 repo.ui.setconfig('ui', 'forcemerge', tool, 'update')
5511 5511
5512 5512 return hg.updatetotally(ui, repo, rev, brev, clean=clean,
5513 5513 updatecheck=updatecheck)
5514 5514
5515 5515 @command('verify', [])
5516 5516 def verify(ui, repo):
5517 5517 """verify the integrity of the repository
5518 5518
5519 5519 Verify the integrity of the current repository.
5520 5520
5521 5521 This will perform an extensive check of the repository's
5522 5522 integrity, validating the hashes and checksums of each entry in
5523 5523 the changelog, manifest, and tracked files, as well as the
5524 5524 integrity of their crosslinks and indices.
5525 5525
5526 5526 Please see https://mercurial-scm.org/wiki/RepositoryCorruption
5527 5527 for more information about recovery from corruption of the
5528 5528 repository.
5529 5529
5530 5530 Returns 0 on success, 1 if errors are encountered.
5531 5531 """
5532 5532 return hg.verify(repo)
5533 5533
5534 5534 @command('version', [] + formatteropts, norepo=True)
5535 5535 def version_(ui, **opts):
5536 5536 """output version and copyright information"""
5537 5537 opts = pycompat.byteskwargs(opts)
5538 5538 if ui.verbose:
5539 5539 ui.pager('version')
5540 5540 fm = ui.formatter("version", opts)
5541 5541 fm.startitem()
5542 5542 fm.write("ver", _("Mercurial Distributed SCM (version %s)\n"),
5543 5543 util.version())
5544 5544 license = _(
5545 5545 "(see https://mercurial-scm.org for more information)\n"
5546 5546 "\nCopyright (C) 2005-2017 Matt Mackall and others\n"
5547 5547 "This is free software; see the source for copying conditions. "
5548 5548 "There is NO\nwarranty; "
5549 5549 "not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
5550 5550 )
5551 5551 if not ui.quiet:
5552 5552 fm.plain(license)
5553 5553
5554 5554 if ui.verbose:
5555 5555 fm.plain(_("\nEnabled extensions:\n\n"))
5556 5556 # format names and versions into columns
5557 5557 names = []
5558 5558 vers = []
5559 5559 isinternals = []
5560 5560 for name, module in extensions.extensions():
5561 5561 names.append(name)
5562 5562 vers.append(extensions.moduleversion(module) or None)
5563 5563 isinternals.append(extensions.ismoduleinternal(module))
5564 5564 fn = fm.nested("extensions")
5565 5565 if names:
5566 5566 namefmt = " %%-%ds " % max(len(n) for n in names)
5567 5567 places = [_("external"), _("internal")]
5568 5568 for n, v, p in zip(names, vers, isinternals):
5569 5569 fn.startitem()
5570 5570 fn.condwrite(ui.verbose, "name", namefmt, n)
5571 5571 if ui.verbose:
5572 5572 fn.plain("%s " % places[p])
5573 5573 fn.data(bundled=p)
5574 5574 fn.condwrite(ui.verbose and v, "ver", "%s", v)
5575 5575 if ui.verbose:
5576 5576 fn.plain("\n")
5577 5577 fn.end()
5578 5578 fm.end()
5579 5579
5580 5580 def loadcmdtable(ui, name, cmdtable):
5581 5581 """Load command functions from specified cmdtable
5582 5582 """
5583 5583 overrides = [cmd for cmd in cmdtable if cmd in table]
5584 5584 if overrides:
5585 5585 ui.warn(_("extension '%s' overrides commands: %s\n")
5586 5586 % (name, " ".join(overrides)))
5587 5587 table.update(cmdtable)
@@ -1,108 +1,108 b''
1 1 All config options used within Mercurial should be registered.
2 2
3 3 Config Option in Core
4 4 =====================
5 5
6 6 Config options used by Mercurial core are registered in the
7 7 ``mercurial.configitems`` module.
8 8
9 9 Simple entry
10 10 ------------
11 11
12 12 A registration entry typically looks like::
13 13
14 14 coreconfigitem('section', 'option',
15 15 default=MyDefaultValue,
16 16 )
17 17
18 18 Once registered, Mercurial will know that ``section.option`` is a legitimate
19 19 config option and that ``MyDefaultValue`` should be used if no other values are
20 20 defined in configuration files.
21 21
22 22 Complex default value
23 23 ---------------------
24 24
25 25 If the default provided is a callable, it is called to retrieve the default
26 value when accessing the config option. This is useful for default value that
26 value when accessing the config option. This is useful for default values that
27 27 are mutable like the empty list::
28 28
29 29 coreconfigitem('pager', 'ignore',
30 30 default=list,
31 31 )
32 32
33 33 In addition, there are cases where the default is not fixed, but computed from
34 other properties. In this case, use the ``dynamicdefault`` object as value for
35 the ``default`` parameters. A default value is then explicitly required when
34 other properties. In this case, use the ``dynamicdefault`` object as the value
35 for the ``default`` parameter. A default value is then explicitly required when
36 36 reading the option::
37 37
38 38 # registration
39 39 coreconfigitem('web', 'name',
40 40 default=dynamicdefault,
41 41 )
42 42
43 43 # usage
44 ui.config('web', 'name', dirnam)
44 ui.config('web', 'name', dirname)
45 45
46 46 Free form options
47 47 -----------------
48 48
49 49 Some config sections use free form options (e.g. ``paths``). You can register
50 50 them using the ``generic`` parameters::
51 51
52 52 coreconfigitem('paths', '.*',
53 53 default=None,
54 54 generic=True,
55 55 )
56 56
57 57 When ``generic=True`` is set, the option name is matched as a regular expression
58 58 (rooted to string start). It can be used to select specific sub parameters::
59 59
60 60 coreconfigitem('merge-tools', br'.*\.args$',
61 61 default="$local $base $other",
62 62 generic=True,
63 63 priority=-1,
64 64 )
65 65
66 The ``priority`` parameter control the order used to match the generic pattern
66 The ``priority`` parameter controls the order used to match the generic pattern
67 67 (lower first).
68 68
69 69 Config Option in Extensions
70 70 ===========================
71 71
72 72 General case
73 73 ------------
74 74
75 75 Extensions should register config items through the ``registrar`` API (also used
76 76 for commands and others)::
77 77
78 78 configtable = {}
79 79 configitem = registrar.configitem(configtable)
80 80
81 81 configitem('blackbox', 'dirty',
82 82 default=False,
83 83 )
84 84
85 85 The ``dynamicdefault`` object is then available as
86 86 ``configitem.dynamicdefault``.
87 87
88 Supporting older version
89 ------------------------
88 Supporting older versions
89 -------------------------
90 90
91 The register was introduced in Mercurial 4.3, the ``generic`` parameter was
91 The registry was introduced in Mercurial 4.3, and the ``generic`` parameter was
92 92 introduced in 4.4. Starting with Mercurial 4.4, all core options were registered
93 93 and developer warnings are emitted when accessing unregistered option.
94 94
95 Extensions supporting version older than Mercurial-4.3 cannot rely on the
96 default value registered. The simplest way to register option while still
97 supporting older version is to use ``dynamicdefault`` for option requiring a
98 default value. The existing code passing an explicit default can then stay in
99 use until compatibility to Mercurial 4.2 is dropped.
95 Extensions supporting versions older than Mercurial 4.3 cannot rely on the
96 default value being registered. The simplest way to register an option while
97 still supporting an older version is to use ``dynamicdefault`` for options
98 requiring a default value. The existing code passing an explicit default can
99 then stay in use until compatibility with Mercurial 4.2 is dropped.
100 100
101 As reminder here are the default value for each config types:
101 As reminder, here are the default values for each config type:
102 102 - config: None
103 103 - configbool: False
104 104 - configbytes: 0
105 105 - configdate: None
106 106 - configint: None
107 107 - configlist: []
108 - configpath: None
108 - configpath: None
@@ -1,85 +1,85 b''
1 1 To merge files Mercurial uses merge tools.
2 2
3 3 A merge tool combines two different versions of a file into a merged
4 4 file. Merge tools are given the two files and the greatest common
5 5 ancestor of the two file versions, so they can determine the changes
6 6 made on both branches.
7 7
8 8 Merge tools are used both for :hg:`resolve`, :hg:`merge`, :hg:`update`,
9 9 :hg:`backout` and in several extensions.
10 10
11 11 Usually, the merge tool tries to automatically reconcile the files by
12 12 combining all non-overlapping changes that occurred separately in
13 13 the two different evolutions of the same initial base file. Furthermore, some
14 14 interactive merge programs make it easier to manually resolve
15 15 conflicting merges, either in a graphical way, or by inserting some
16 16 conflict markers. Mercurial does not include any interactive merge
17 17 programs but relies on external tools for that.
18 18
19 19 Available merge tools
20 20 =====================
21 21
22 22 External merge tools and their properties are configured in the
23 23 merge-tools configuration section - see hgrc(5) - but they can often just
24 24 be named by their executable.
25 25
26 26 A merge tool is generally usable if its executable can be found on the
27 27 system and if it can handle the merge. The executable is found if it
28 28 is an absolute or relative executable path or the name of an
29 29 application in the executable search path. The tool is assumed to be
30 30 able to handle the merge if it can handle symlinks if the file is a
31 31 symlink, if it can handle binary files if the file is binary, and if a
32 32 GUI is available if the tool requires a GUI.
33 33
34 34 There are some internal merge tools which can be used. The internal
35 35 merge tools are:
36 36
37 37 .. internaltoolsmarker
38 38
39 39 Internal tools are always available and do not require a GUI but will by default
40 40 not handle symlinks or binary files.
41 41
42 42 Choosing a merge tool
43 43 =====================
44 44
45 45 Mercurial uses these rules when deciding which merge tool to use:
46 46
47 47 1. If a tool has been specified with the --tool option to merge or resolve, it
48 48 is used. If it is the name of a tool in the merge-tools configuration, its
49 49 configuration is used. Otherwise the specified tool must be executable by
50 50 the shell.
51 51
52 52 2. If the ``HGMERGE`` environment variable is present, its value is used and
53 53 must be executable by the shell.
54 54
55 55 3. If the filename of the file to be merged matches any of the patterns in the
56 56 merge-patterns configuration section, the first usable merge tool
57 57 corresponding to a matching pattern is used. Here, binary capabilities of the
58 58 merge tool are not considered.
59 59
60 60 4. If ui.merge is set it will be considered next. If the value is not the name
61 61 of a configured tool, the specified value is used and must be executable by
62 62 the shell. Otherwise the named tool is used if it is usable.
63 63
64 64 5. If any usable merge tools are present in the merge-tools configuration
65 65 section, the one with the highest priority is used.
66 66
67 67 6. If a program named ``hgmerge`` can be found on the system, it is used - but
68 68 it will by default not be used for symlinks and binary files.
69 69
70 70 7. If the file to be merged is not binary and is not a symlink, then
71 71 internal ``:merge`` is used.
72 72
73 73 8. Otherwise, ``:prompt`` is used.
74 74
75 75 .. note::
76 76
77 77 After selecting a merge program, Mercurial will by default attempt
78 78 to merge the files using a simple merge algorithm first. Only if it doesn't
79 succeed because of conflicting changes Mercurial will actually execute the
79 succeed because of conflicting changes will Mercurial actually execute the
80 80 merge program. Whether to use the simple merge algorithm first can be
81 81 controlled by the premerge setting of the merge tool. Premerge is enabled by
82 82 default unless the file is binary or a symlink.
83 83
84 84 See the merge-tools and ui sections of hgrc(5) for details on the
85 85 configuration of merge tools.
@@ -1,100 +1,100 b''
1 1 What are phases?
2 2 ================
3 3
4 4 Phases are a system for tracking which changesets have been or should
5 5 be shared. This helps prevent common mistakes when modifying history
6 6 (for instance, with the mq or rebase extensions).
7 7
8 8 Each changeset in a repository is in one of the following phases:
9 9
10 10 - public : changeset is visible on a public server
11 11 - draft : changeset is not yet published
12 12 - secret : changeset should not be pushed, pulled, or cloned
13 13
14 14 These phases are ordered (public < draft < secret) and no changeset
15 15 can be in a lower phase than its ancestors. For instance, if a
16 16 changeset is public, all its ancestors are also public. Lastly,
17 17 changeset phases should only be changed towards the public phase.
18 18
19 19 How are phases managed?
20 20 =======================
21 21
22 22 For the most part, phases should work transparently. By default, a
23 23 changeset is created in the draft phase and is moved into the public
24 24 phase when it is pushed to another repository.
25 25
26 26 Once changesets become public, extensions like mq and rebase will
27 27 refuse to operate on them to prevent creating duplicate changesets.
28 28 Phases can also be manually manipulated with the :hg:`phase` command
29 29 if needed. See :hg:`help -v phase` for examples.
30 30
31 To make yours commits secret by default, put this in your
31 To make your commits secret by default, put this in your
32 32 configuration file::
33 33
34 34 [phases]
35 35 new-commit = secret
36 36
37 37 Phases and servers
38 38 ==================
39 39
40 40 Normally, all servers are ``publishing`` by default. This means::
41 41
42 42 - all draft changesets that are pulled or cloned appear in phase
43 43 public on the client
44 44
45 45 - all draft changesets that are pushed appear as public on both
46 46 client and server
47 47
48 48 - secret changesets are neither pushed, pulled, or cloned
49 49
50 50 .. note::
51 51
52 52 Pulling a draft changeset from a publishing server does not mark it
53 53 as public on the server side due to the read-only nature of pull.
54 54
55 55 Sometimes it may be desirable to push and pull changesets in the draft
56 56 phase to share unfinished work. This can be done by setting a
57 57 repository to disable publishing in its configuration file::
58 58
59 59 [phases]
60 60 publish = False
61 61
62 62 See :hg:`help config` for more information on configuration files.
63 63
64 64 .. note::
65 65
66 66 Servers running older versions of Mercurial are treated as
67 67 publishing.
68 68
69 69 .. note::
70 70
71 71 Changesets in secret phase are not exchanged with the server. This
72 72 applies to their content: file names, file contents, and changeset
73 73 metadata. For technical reasons, the identifier (e.g. d825e4025e39)
74 74 of the secret changeset may be communicated to the server.
75 75
76 76
77 77 Examples
78 78 ========
79 79
80 80 - list changesets in draft or secret phase::
81 81
82 82 hg log -r "not public()"
83 83
84 84 - change all secret changesets to draft::
85 85
86 86 hg phase --draft "secret()"
87 87
88 88 - forcibly move the current changeset and descendants from public to draft::
89 89
90 90 hg phase --force --draft .
91 91
92 - show a list of changeset revision and phase::
92 - show a list of changeset revisions and each corresponding phase::
93 93
94 94 hg log --template "{rev} {phase}\n"
95 95
96 96 - resynchronize draft changesets relative to a remote repository::
97 97
98 98 hg phase -fd "outgoing(URL)"
99 99
100 100 See :hg:`help phase` for more information on manually manipulating phases.
@@ -1,223 +1,223 b''
1 1 Mercurial supports several ways to specify revisions.
2 2
3 3 Specifying single revisions
4 4 ===========================
5 5
6 6 A plain integer is treated as a revision number. Negative integers are
7 7 treated as sequential offsets from the tip, with -1 denoting the tip,
8 8 -2 denoting the revision prior to the tip, and so forth.
9 9
10 10 A 40-digit hexadecimal string is treated as a unique revision identifier.
11 11 A hexadecimal string less than 40 characters long is treated as a
12 12 unique revision identifier and is referred to as a short-form
13 13 identifier. A short-form identifier is only valid if it is the prefix
14 14 of exactly one full-length identifier.
15 15
16 16 Any other string is treated as a bookmark, tag, or branch name. A
17 17 bookmark is a movable pointer to a revision. A tag is a permanent name
18 18 associated with a revision. A branch name denotes the tipmost open branch head
19 19 of that branch - or if they are all closed, the tipmost closed head of the
20 20 branch. Bookmark, tag, and branch names must not contain the ":" character.
21 21
22 22 The reserved name "tip" always identifies the most recent revision.
23 23
24 24 The reserved name "null" indicates the null revision. This is the
25 25 revision of an empty repository, and the parent of revision 0.
26 26
27 27 The reserved name "." indicates the working directory parent. If no
28 28 working directory is checked out, it is equivalent to null. If an
29 29 uncommitted merge is in progress, "." is the revision of the first
30 30 parent.
31 31
32 32 Finally, commands that expect a single revision (like ``hg update``) also
33 33 accept revsets (see below for details). When given a revset, they use the
34 34 last revision of the revset. A few commands accept two single revisions
35 35 (like ``hg diff``). When given a revset, they use the first and the last
36 36 revisions of the revset.
37 37
38 38 Specifying multiple revisions
39 39 =============================
40 40
41 41 Mercurial supports a functional language for selecting a set of
42 42 revisions. Expressions in this language are called revsets.
43 43
44 44 The language supports a number of predicates which are joined by infix
45 45 operators. Parenthesis can be used for grouping.
46 46
47 47 Identifiers such as branch names may need quoting with single or
48 48 double quotes if they contain characters like ``-`` or if they match
49 49 one of the predefined predicates.
50 50
51 51 Special characters can be used in quoted identifiers by escaping them,
52 52 e.g., ``\n`` is interpreted as a newline. To prevent them from being
53 53 interpreted, strings can be prefixed with ``r``, e.g. ``r'...'``.
54 54
55 55 Operators
56 56 =========
57 57
58 58 There is a single prefix operator:
59 59
60 60 ``not x``
61 61 Changesets not in x. Short form is ``! x``.
62 62
63 63 These are the supported infix operators:
64 64
65 65 ``x::y``
66 66 A DAG range, meaning all changesets that are descendants of x and
67 67 ancestors of y, including x and y themselves. If the first endpoint
68 68 is left out, this is equivalent to ``ancestors(y)``, if the second
69 69 is left out it is equivalent to ``descendants(x)``.
70 70
71 71 An alternative syntax is ``x..y``.
72 72
73 73 ``x:y``
74 74 All changesets with revision numbers between x and y, both
75 75 inclusive. Either endpoint can be left out, they default to 0 and
76 76 tip.
77 77
78 78 ``x and y``
79 79 The intersection of changesets in x and y. Short form is ``x & y``.
80 80
81 81 ``x or y``
82 82 The union of changesets in x and y. There are two alternative short
83 83 forms: ``x | y`` and ``x + y``.
84 84
85 85 ``x - y``
86 86 Changesets in x but not in y.
87 87
88 88 ``x % y``
89 89 Changesets that are ancestors of x but not ancestors of y (i.e. ::x - ::y).
90 90 This is shorthand notation for ``only(x, y)`` (see below). The second
91 91 argument is optional and, if left out, is equivalent to ``only(x)``.
92 92
93 93 ``x^n``
94 94 The nth parent of x, n == 0, 1, or 2.
95 95 For n == 0, x; for n == 1, the first parent of each changeset in x;
96 96 for n == 2, the second parent of changeset in x.
97 97
98 98 ``x~n``
99 99 The nth first ancestor of x; ``x~0`` is x; ``x~3`` is ``x^^^``.
100 100 For n < 0, the nth unambiguous descendent of x.
101 101
102 102 ``x ## y``
103 103 Concatenate strings and identifiers into one string.
104 104
105 105 All other prefix, infix and postfix operators have lower priority than
106 106 ``##``. For example, ``a1 ## a2~2`` is equivalent to ``(a1 ## a2)~2``.
107 107
108 108 For example::
109 109
110 110 [revsetalias]
111 111 issue(a1) = grep(r'\bissue[ :]?' ## a1 ## r'\b|\bbug\(' ## a1 ## r'\)')
112 112
113 113 ``issue(1234)`` is equivalent to
114 114 ``grep(r'\bissue[ :]?1234\b|\bbug\(1234\)')``
115 115 in this case. This matches against all of "issue 1234", "issue:1234",
116 116 "issue1234" and "bug(1234)".
117 117
118 118 There is a single postfix operator:
119 119
120 120 ``x^``
121 121 Equivalent to ``x^1``, the first parent of each changeset in x.
122 122
123 123 Patterns
124 124 ========
125 125
126 126 Where noted, predicates that perform string matching can accept a pattern
127 127 string. The pattern may be either a literal, or a regular expression. If the
128 128 pattern starts with ``re:``, the remainder of the pattern is treated as a
129 129 regular expression. Otherwise, it is treated as a literal. To match a pattern
130 130 that actually starts with ``re:``, use the prefix ``literal:``.
131 131
132 132 Matching is case-sensitive, unless otherwise noted. To perform a case-
133 133 insensitive match on a case-sensitive predicate, use a regular expression,
134 134 prefixed with ``(?i)``.
135 135
136 136 For example, ``tag(r're:(?i)release')`` matches "release" or "RELEASE"
137 or "Release", etc
137 or "Release", etc.
138 138
139 139 Predicates
140 140 ==========
141 141
142 142 The following predicates are supported:
143 143
144 144 .. predicatesmarker
145 145
146 146 Aliases
147 147 =======
148 148
149 149 New predicates (known as "aliases") can be defined, using any combination of
150 150 existing predicates or other aliases. An alias definition looks like::
151 151
152 152 <alias> = <definition>
153 153
154 154 in the ``revsetalias`` section of a Mercurial configuration file. Arguments
155 155 of the form `a1`, `a2`, etc. are substituted from the alias into the
156 156 definition.
157 157
158 158 For example,
159 159
160 160 ::
161 161
162 162 [revsetalias]
163 163 h = heads()
164 164 d(s) = sort(s, date)
165 165 rs(s, k) = reverse(sort(s, k))
166 166
167 167 defines three aliases, ``h``, ``d``, and ``rs``. ``rs(0:tip, author)`` is
168 168 exactly equivalent to ``reverse(sort(0:tip, author))``.
169 169
170 170 Equivalents
171 171 ===========
172 172
173 173 Command line equivalents for :hg:`log`::
174 174
175 175 -f -> ::.
176 176 -d x -> date(x)
177 177 -k x -> keyword(x)
178 178 -m -> merge()
179 179 -u x -> user(x)
180 180 -b x -> branch(x)
181 181 -P x -> !::x
182 182 -l x -> limit(expr, x)
183 183
184 184 Examples
185 185 ========
186 186
187 187 Some sample queries:
188 188
189 189 - Changesets on the default branch::
190 190
191 191 hg log -r "branch(default)"
192 192
193 193 - Changesets on the default branch since tag 1.5 (excluding merges)::
194 194
195 195 hg log -r "branch(default) and 1.5:: and not merge()"
196 196
197 197 - Open branch heads::
198 198
199 199 hg log -r "head() and not closed()"
200 200
201 201 - Changesets between tags 1.3 and 1.5 mentioning "bug" that affect
202 202 ``hgext/*``::
203 203
204 204 hg log -r "1.3::1.5 and keyword(bug) and file('hgext/*')"
205 205
206 206 - Changesets committed in May 2008, sorted by user::
207 207
208 208 hg log -r "sort(date('May 2008'), user)"
209 209
210 210 - Changesets mentioning "bug" or "issue" that are not in a tagged
211 211 release::
212 212
213 213 hg log -r "(keyword(bug) or keyword(issue)) and not ancestors(tag())"
214 214
215 - Update to commit that bookmark @ is pointing too, without activating the
215 - Update to the commit that bookmark @ is pointing to, without activating the
216 216 bookmark (this works because the last revision of the revset is used)::
217 217
218 218 hg update :@
219 219
220 220 - Show diff between tags 1.3 and 1.5 (this works because the first and the
221 221 last revisions of the revset are used)::
222 222
223 223 hg diff -r 1.3::1.5
@@ -1,1714 +1,1714 b''
1 1 Test basic extension support
2 2
3 3 $ cat > foobar.py <<EOF
4 4 > import os
5 5 > from mercurial import commands, registrar
6 6 > cmdtable = {}
7 7 > command = registrar.command(cmdtable)
8 8 > configtable = {}
9 9 > configitem = registrar.configitem(configtable)
10 10 > configitem('tests', 'foo', default="Foo")
11 11 > def uisetup(ui):
12 12 > ui.write("uisetup called\\n")
13 13 > ui.flush()
14 14 > def reposetup(ui, repo):
15 15 > ui.write("reposetup called for %s\\n" % os.path.basename(repo.root))
16 16 > ui.write("ui %s= repo.ui\\n" % (ui == repo.ui and "=" or "!"))
17 17 > ui.flush()
18 18 > @command(b'foo', [], 'hg foo')
19 19 > def foo(ui, *args, **kwargs):
20 20 > foo = ui.config('tests', 'foo')
21 21 > ui.write(foo)
22 22 > ui.write("\\n")
23 23 > @command(b'bar', [], 'hg bar', norepo=True)
24 24 > def bar(ui, *args, **kwargs):
25 25 > ui.write("Bar\\n")
26 26 > EOF
27 27 $ abspath=`pwd`/foobar.py
28 28
29 29 $ mkdir barfoo
30 30 $ cp foobar.py barfoo/__init__.py
31 31 $ barfoopath=`pwd`/barfoo
32 32
33 33 $ hg init a
34 34 $ cd a
35 35 $ echo foo > file
36 36 $ hg add file
37 37 $ hg commit -m 'add file'
38 38
39 39 $ echo '[extensions]' >> $HGRCPATH
40 40 $ echo "foobar = $abspath" >> $HGRCPATH
41 41 $ hg foo
42 42 uisetup called
43 43 reposetup called for a
44 44 ui == repo.ui
45 45 reposetup called for a (chg !)
46 46 ui == repo.ui (chg !)
47 47 Foo
48 48
49 49 $ cd ..
50 50 $ hg clone a b
51 51 uisetup called (no-chg !)
52 52 reposetup called for a
53 53 ui == repo.ui
54 54 reposetup called for b
55 55 ui == repo.ui
56 56 updating to branch default
57 57 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
58 58
59 59 $ hg bar
60 60 uisetup called (no-chg !)
61 61 Bar
62 62 $ echo 'foobar = !' >> $HGRCPATH
63 63
64 64 module/__init__.py-style
65 65
66 66 $ echo "barfoo = $barfoopath" >> $HGRCPATH
67 67 $ cd a
68 68 $ hg foo
69 69 uisetup called
70 70 reposetup called for a
71 71 ui == repo.ui
72 72 reposetup called for a (chg !)
73 73 ui == repo.ui (chg !)
74 74 Foo
75 75 $ echo 'barfoo = !' >> $HGRCPATH
76 76
77 77 Check that extensions are loaded in phases:
78 78
79 79 $ cat > foo.py <<EOF
80 80 > import os
81 81 > name = os.path.basename(__file__).rsplit('.', 1)[0]
82 82 > print("1) %s imported" % name)
83 83 > def uisetup(ui):
84 84 > print("2) %s uisetup" % name)
85 85 > def extsetup():
86 86 > print("3) %s extsetup" % name)
87 87 > def reposetup(ui, repo):
88 88 > print("4) %s reposetup" % name)
89 89 >
90 90 > # custom predicate to check registration of functions at loading
91 91 > from mercurial import (
92 92 > registrar,
93 93 > smartset,
94 94 > )
95 95 > revsetpredicate = registrar.revsetpredicate()
96 96 > @revsetpredicate(name, safe=True) # safe=True for query via hgweb
97 97 > def custompredicate(repo, subset, x):
98 98 > return smartset.baseset([r for r in subset if r in {0}])
99 99 > EOF
100 100
101 101 $ cp foo.py bar.py
102 102 $ echo 'foo = foo.py' >> $HGRCPATH
103 103 $ echo 'bar = bar.py' >> $HGRCPATH
104 104
105 105 Check normal command's load order of extensions and registration of functions
106 106
107 107 $ hg log -r "foo() and bar()" -q
108 108 1) foo imported
109 109 1) bar imported
110 110 2) foo uisetup
111 111 2) bar uisetup
112 112 3) foo extsetup
113 113 3) bar extsetup
114 114 4) foo reposetup
115 115 4) bar reposetup
116 116 0:c24b9ac61126
117 117
118 118 Check hgweb's load order of extensions and registration of functions
119 119
120 120 $ cat > hgweb.cgi <<EOF
121 121 > #!$PYTHON
122 122 > from mercurial import demandimport; demandimport.enable()
123 123 > from mercurial.hgweb import hgweb
124 124 > from mercurial.hgweb import wsgicgi
125 125 > application = hgweb('.', 'test repo')
126 126 > wsgicgi.launch(application)
127 127 > EOF
128 128 $ . "$TESTDIR/cgienv"
129 129
130 130 $ PATH_INFO='/' SCRIPT_NAME='' $PYTHON hgweb.cgi \
131 131 > | grep '^[0-9]) ' # ignores HTML output
132 132 1) foo imported
133 133 1) bar imported
134 134 2) foo uisetup
135 135 2) bar uisetup
136 136 3) foo extsetup
137 137 3) bar extsetup
138 138 4) foo reposetup
139 139 4) bar reposetup
140 140
141 141 (check that revset predicate foo() and bar() are available)
142 142
143 143 #if msys
144 144 $ PATH_INFO='//shortlog'
145 145 #else
146 146 $ PATH_INFO='/shortlog'
147 147 #endif
148 148 $ export PATH_INFO
149 149 $ SCRIPT_NAME='' QUERY_STRING='rev=foo() and bar()' $PYTHON hgweb.cgi \
150 150 > | grep '<a href="/rev/[0-9a-z]*">'
151 151 <a href="/rev/c24b9ac61126">add file</a>
152 152
153 153 $ echo 'foo = !' >> $HGRCPATH
154 154 $ echo 'bar = !' >> $HGRCPATH
155 155
156 156 Check "from __future__ import absolute_import" support for external libraries
157 157
158 158 #if windows
159 159 $ PATHSEP=";"
160 160 #else
161 161 $ PATHSEP=":"
162 162 #endif
163 163 $ export PATHSEP
164 164
165 165 $ mkdir $TESTTMP/libroot
166 166 $ echo "s = 'libroot/ambig.py'" > $TESTTMP/libroot/ambig.py
167 167 $ mkdir $TESTTMP/libroot/mod
168 168 $ touch $TESTTMP/libroot/mod/__init__.py
169 169 $ echo "s = 'libroot/mod/ambig.py'" > $TESTTMP/libroot/mod/ambig.py
170 170
171 171 $ cat > $TESTTMP/libroot/mod/ambigabs.py <<EOF
172 172 > from __future__ import absolute_import
173 173 > import ambig # should load "libroot/ambig.py"
174 174 > s = ambig.s
175 175 > EOF
176 176 $ cat > loadabs.py <<EOF
177 177 > import mod.ambigabs as ambigabs
178 178 > def extsetup():
179 179 > print('ambigabs.s=%s' % ambigabs.s)
180 180 > EOF
181 181 $ (PYTHONPATH=${PYTHONPATH}${PATHSEP}${TESTTMP}/libroot; hg --config extensions.loadabs=loadabs.py root)
182 182 ambigabs.s=libroot/ambig.py
183 183 $TESTTMP/a (glob)
184 184
185 185 #if no-py3k
186 186 $ cat > $TESTTMP/libroot/mod/ambigrel.py <<EOF
187 187 > import ambig # should load "libroot/mod/ambig.py"
188 188 > s = ambig.s
189 189 > EOF
190 190 $ cat > loadrel.py <<EOF
191 191 > import mod.ambigrel as ambigrel
192 192 > def extsetup():
193 193 > print('ambigrel.s=%s' % ambigrel.s)
194 194 > EOF
195 195 $ (PYTHONPATH=${PYTHONPATH}${PATHSEP}${TESTTMP}/libroot; hg --config extensions.loadrel=loadrel.py root)
196 196 ambigrel.s=libroot/mod/ambig.py
197 197 $TESTTMP/a (glob)
198 198 #endif
199 199
200 200 Check absolute/relative import of extension specific modules
201 201
202 202 $ mkdir $TESTTMP/extroot
203 203 $ cat > $TESTTMP/extroot/bar.py <<EOF
204 204 > s = 'this is extroot.bar'
205 205 > EOF
206 206 $ mkdir $TESTTMP/extroot/sub1
207 207 $ cat > $TESTTMP/extroot/sub1/__init__.py <<EOF
208 208 > s = 'this is extroot.sub1.__init__'
209 209 > EOF
210 210 $ cat > $TESTTMP/extroot/sub1/baz.py <<EOF
211 211 > s = 'this is extroot.sub1.baz'
212 212 > EOF
213 213 $ cat > $TESTTMP/extroot/__init__.py <<EOF
214 214 > s = 'this is extroot.__init__'
215 215 > import foo
216 216 > def extsetup(ui):
217 217 > ui.write('(extroot) ', foo.func(), '\n')
218 218 > ui.flush()
219 219 > EOF
220 220
221 221 $ cat > $TESTTMP/extroot/foo.py <<EOF
222 222 > # test absolute import
223 223 > buf = []
224 224 > def func():
225 225 > # "not locals" case
226 226 > import extroot.bar
227 227 > buf.append('import extroot.bar in func(): %s' % extroot.bar.s)
228 228 > return '\n(extroot) '.join(buf)
229 229 > # "fromlist == ('*',)" case
230 230 > from extroot.bar import *
231 231 > buf.append('from extroot.bar import *: %s' % s)
232 232 > # "not fromlist" and "if '.' in name" case
233 233 > import extroot.sub1.baz
234 234 > buf.append('import extroot.sub1.baz: %s' % extroot.sub1.baz.s)
235 235 > # "not fromlist" and NOT "if '.' in name" case
236 236 > import extroot
237 237 > buf.append('import extroot: %s' % extroot.s)
238 238 > # NOT "not fromlist" and NOT "level != -1" case
239 239 > from extroot.bar import s
240 240 > buf.append('from extroot.bar import s: %s' % s)
241 241 > EOF
242 242 $ (PYTHONPATH=${PYTHONPATH}${PATHSEP}${TESTTMP}; hg --config extensions.extroot=$TESTTMP/extroot root)
243 243 (extroot) from extroot.bar import *: this is extroot.bar
244 244 (extroot) import extroot.sub1.baz: this is extroot.sub1.baz
245 245 (extroot) import extroot: this is extroot.__init__
246 246 (extroot) from extroot.bar import s: this is extroot.bar
247 247 (extroot) import extroot.bar in func(): this is extroot.bar
248 248 $TESTTMP/a (glob)
249 249
250 250 #if no-py3k
251 251 $ rm "$TESTTMP"/extroot/foo.*
252 252 $ rm -Rf "$TESTTMP/extroot/__pycache__"
253 253 $ cat > $TESTTMP/extroot/foo.py <<EOF
254 254 > # test relative import
255 255 > buf = []
256 256 > def func():
257 257 > # "not locals" case
258 258 > import bar
259 259 > buf.append('import bar in func(): %s' % bar.s)
260 260 > return '\n(extroot) '.join(buf)
261 261 > # "fromlist == ('*',)" case
262 262 > from bar import *
263 263 > buf.append('from bar import *: %s' % s)
264 264 > # "not fromlist" and "if '.' in name" case
265 265 > import sub1.baz
266 266 > buf.append('import sub1.baz: %s' % sub1.baz.s)
267 267 > # "not fromlist" and NOT "if '.' in name" case
268 268 > import sub1
269 269 > buf.append('import sub1: %s' % sub1.s)
270 270 > # NOT "not fromlist" and NOT "level != -1" case
271 271 > from bar import s
272 272 > buf.append('from bar import s: %s' % s)
273 273 > EOF
274 274 $ hg --config extensions.extroot=$TESTTMP/extroot root
275 275 (extroot) from bar import *: this is extroot.bar
276 276 (extroot) import sub1.baz: this is extroot.sub1.baz
277 277 (extroot) import sub1: this is extroot.sub1.__init__
278 278 (extroot) from bar import s: this is extroot.bar
279 279 (extroot) import bar in func(): this is extroot.bar
280 280 $TESTTMP/a (glob)
281 281 #endif
282 282
283 283 #if demandimport
284 284
285 285 Examine whether module loading is delayed until actual referring, even
286 286 though module is imported with "absolute_import" feature.
287 287
288 288 Files below in each packages are used for described purpose:
289 289
290 290 - "called": examine whether "from MODULE import ATTR" works correctly
291 291 - "unused": examine whether loading is delayed correctly
292 292 - "used": examine whether "from PACKAGE import MODULE" works correctly
293 293
294 294 Package hierarchy is needed to examine whether demand importing works
295 295 as expected for "from SUB.PACK.AGE import MODULE".
296 296
297 297 Setup "external library" to be imported with "absolute_import"
298 298 feature.
299 299
300 300 $ mkdir -p $TESTTMP/extlibroot/lsub1/lsub2
301 301 $ touch $TESTTMP/extlibroot/__init__.py
302 302 $ touch $TESTTMP/extlibroot/lsub1/__init__.py
303 303 $ touch $TESTTMP/extlibroot/lsub1/lsub2/__init__.py
304 304
305 305 $ cat > $TESTTMP/extlibroot/lsub1/lsub2/called.py <<EOF
306 306 > def func():
307 307 > return "this is extlibroot.lsub1.lsub2.called.func()"
308 308 > EOF
309 309 $ cat > $TESTTMP/extlibroot/lsub1/lsub2/unused.py <<EOF
310 310 > raise Exception("extlibroot.lsub1.lsub2.unused is loaded unintentionally")
311 311 > EOF
312 312 $ cat > $TESTTMP/extlibroot/lsub1/lsub2/used.py <<EOF
313 313 > detail = "this is extlibroot.lsub1.lsub2.used"
314 314 > EOF
315 315
316 316 Setup sub-package of "external library", which causes instantiation of
317 317 demandmod in "recurse down the module chain" code path. Relative
318 318 importing with "absolute_import" feature isn't tested, because "level
319 319 >=1 " doesn't cause instantiation of demandmod.
320 320
321 321 $ mkdir -p $TESTTMP/extlibroot/recursedown/abs
322 322 $ cat > $TESTTMP/extlibroot/recursedown/abs/used.py <<EOF
323 323 > detail = "this is extlibroot.recursedown.abs.used"
324 324 > EOF
325 325 $ cat > $TESTTMP/extlibroot/recursedown/abs/__init__.py <<EOF
326 326 > from __future__ import absolute_import
327 327 > from extlibroot.recursedown.abs.used import detail
328 328 > EOF
329 329
330 330 $ mkdir -p $TESTTMP/extlibroot/recursedown/legacy
331 331 $ cat > $TESTTMP/extlibroot/recursedown/legacy/used.py <<EOF
332 332 > detail = "this is extlibroot.recursedown.legacy.used"
333 333 > EOF
334 334 $ cat > $TESTTMP/extlibroot/recursedown/legacy/__init__.py <<EOF
335 335 > # legacy style (level == -1) import
336 336 > from extlibroot.recursedown.legacy.used import detail
337 337 > EOF
338 338
339 339 $ cat > $TESTTMP/extlibroot/recursedown/__init__.py <<EOF
340 340 > from __future__ import absolute_import
341 341 > from extlibroot.recursedown.abs import detail as absdetail
342 342 > from .legacy import detail as legacydetail
343 343 > EOF
344 344
345 345 Setup package that re-exports an attribute of its submodule as the same
346 346 name. This leaves 'shadowing.used' pointing to 'used.detail', but still
347 347 the submodule 'used' should be somehow accessible. (issue5617)
348 348
349 349 $ mkdir -p $TESTTMP/extlibroot/shadowing
350 350 $ cat > $TESTTMP/extlibroot/shadowing/used.py <<EOF
351 351 > detail = "this is extlibroot.shadowing.used"
352 352 > EOF
353 353 $ cat > $TESTTMP/extlibroot/shadowing/proxied.py <<EOF
354 354 > from __future__ import absolute_import
355 355 > from extlibroot.shadowing.used import detail
356 356 > EOF
357 357 $ cat > $TESTTMP/extlibroot/shadowing/__init__.py <<EOF
358 358 > from __future__ import absolute_import
359 359 > from .used import detail as used
360 360 > EOF
361 361
362 362 Setup extension local modules to be imported with "absolute_import"
363 363 feature.
364 364
365 365 $ mkdir -p $TESTTMP/absextroot/xsub1/xsub2
366 366 $ touch $TESTTMP/absextroot/xsub1/__init__.py
367 367 $ touch $TESTTMP/absextroot/xsub1/xsub2/__init__.py
368 368
369 369 $ cat > $TESTTMP/absextroot/xsub1/xsub2/called.py <<EOF
370 370 > def func():
371 371 > return "this is absextroot.xsub1.xsub2.called.func()"
372 372 > EOF
373 373 $ cat > $TESTTMP/absextroot/xsub1/xsub2/unused.py <<EOF
374 374 > raise Exception("absextroot.xsub1.xsub2.unused is loaded unintentionally")
375 375 > EOF
376 376 $ cat > $TESTTMP/absextroot/xsub1/xsub2/used.py <<EOF
377 377 > detail = "this is absextroot.xsub1.xsub2.used"
378 378 > EOF
379 379
380 380 Setup extension local modules to examine whether demand importing
381 381 works as expected in "level > 1" case.
382 382
383 383 $ cat > $TESTTMP/absextroot/relimportee.py <<EOF
384 384 > detail = "this is absextroot.relimportee"
385 385 > EOF
386 386 $ cat > $TESTTMP/absextroot/xsub1/xsub2/relimporter.py <<EOF
387 387 > from __future__ import absolute_import
388 388 > from ... import relimportee
389 389 > detail = "this relimporter imports %r" % (relimportee.detail)
390 390 > EOF
391 391
392 392 Setup modules, which actually import extension local modules at
393 393 runtime.
394 394
395 395 $ cat > $TESTTMP/absextroot/absolute.py << EOF
396 396 > from __future__ import absolute_import
397 397 >
398 398 > # import extension local modules absolutely (level = 0)
399 399 > from absextroot.xsub1.xsub2 import used, unused
400 400 > from absextroot.xsub1.xsub2.called import func
401 401 >
402 402 > def getresult():
403 403 > result = []
404 404 > result.append(used.detail)
405 405 > result.append(func())
406 406 > return result
407 407 > EOF
408 408
409 409 $ cat > $TESTTMP/absextroot/relative.py << EOF
410 410 > from __future__ import absolute_import
411 411 >
412 412 > # import extension local modules relatively (level == 1)
413 413 > from .xsub1.xsub2 import used, unused
414 414 > from .xsub1.xsub2.called import func
415 415 >
416 416 > # import a module, which implies "importing with level > 1"
417 417 > from .xsub1.xsub2 import relimporter
418 418 >
419 419 > def getresult():
420 420 > result = []
421 421 > result.append(used.detail)
422 422 > result.append(func())
423 423 > result.append(relimporter.detail)
424 424 > return result
425 425 > EOF
426 426
427 427 Setup main procedure of extension.
428 428
429 429 $ cat > $TESTTMP/absextroot/__init__.py <<EOF
430 430 > from __future__ import absolute_import
431 431 > from mercurial import registrar
432 432 > cmdtable = {}
433 433 > command = registrar.command(cmdtable)
434 434 >
435 435 > # "absolute" and "relative" shouldn't be imported before actual
436 436 > # command execution, because (1) they import same modules, and (2)
437 437 > # preceding import (= instantiate "demandmod" object instead of
438 438 > # real "module" object) might hide problem of succeeding import.
439 439 >
440 440 > @command(b'showabsolute', [], norepo=True)
441 441 > def showabsolute(ui, *args, **opts):
442 442 > from absextroot import absolute
443 443 > ui.write('ABS: %s\n' % '\nABS: '.join(absolute.getresult()))
444 444 >
445 445 > @command(b'showrelative', [], norepo=True)
446 446 > def showrelative(ui, *args, **opts):
447 447 > from . import relative
448 448 > ui.write('REL: %s\n' % '\nREL: '.join(relative.getresult()))
449 449 >
450 450 > # import modules from external library
451 451 > from extlibroot.lsub1.lsub2 import used as lused, unused as lunused
452 452 > from extlibroot.lsub1.lsub2.called import func as lfunc
453 453 > from extlibroot.recursedown import absdetail, legacydetail
454 454 > from extlibroot.shadowing import proxied
455 455 >
456 456 > def uisetup(ui):
457 457 > result = []
458 458 > result.append(lused.detail)
459 459 > result.append(lfunc())
460 460 > result.append(absdetail)
461 461 > result.append(legacydetail)
462 462 > result.append(proxied.detail)
463 463 > ui.write('LIB: %s\n' % '\nLIB: '.join(result))
464 464 > EOF
465 465
466 466 Examine module importing.
467 467
468 468 $ (PYTHONPATH=${PYTHONPATH}${PATHSEP}${TESTTMP}; hg --config extensions.absextroot=$TESTTMP/absextroot showabsolute)
469 469 LIB: this is extlibroot.lsub1.lsub2.used
470 470 LIB: this is extlibroot.lsub1.lsub2.called.func()
471 471 LIB: this is extlibroot.recursedown.abs.used
472 472 LIB: this is extlibroot.recursedown.legacy.used
473 473 LIB: this is extlibroot.shadowing.used
474 474 ABS: this is absextroot.xsub1.xsub2.used
475 475 ABS: this is absextroot.xsub1.xsub2.called.func()
476 476
477 477 $ (PYTHONPATH=${PYTHONPATH}${PATHSEP}${TESTTMP}; hg --config extensions.absextroot=$TESTTMP/absextroot showrelative)
478 478 LIB: this is extlibroot.lsub1.lsub2.used
479 479 LIB: this is extlibroot.lsub1.lsub2.called.func()
480 480 LIB: this is extlibroot.recursedown.abs.used
481 481 LIB: this is extlibroot.recursedown.legacy.used
482 482 LIB: this is extlibroot.shadowing.used
483 483 REL: this is absextroot.xsub1.xsub2.used
484 484 REL: this is absextroot.xsub1.xsub2.called.func()
485 485 REL: this relimporter imports 'this is absextroot.relimportee'
486 486
487 487 Examine whether sub-module is imported relatively as expected.
488 488
489 489 See also issue5208 for detail about example case on Python 3.x.
490 490
491 491 $ f -q $TESTTMP/extlibroot/lsub1/lsub2/notexist.py
492 492 $TESTTMP/extlibroot/lsub1/lsub2/notexist.py: file not found
493 493
494 494 $ cat > $TESTTMP/notexist.py <<EOF
495 495 > text = 'notexist.py at root is loaded unintentionally\n'
496 496 > EOF
497 497
498 498 $ cat > $TESTTMP/checkrelativity.py <<EOF
499 499 > from mercurial import registrar
500 500 > cmdtable = {}
501 501 > command = registrar.command(cmdtable)
502 502 >
503 503 > # demand import avoids failure of importing notexist here
504 504 > import extlibroot.lsub1.lsub2.notexist
505 505 >
506 506 > @command(b'checkrelativity', [], norepo=True)
507 507 > def checkrelativity(ui, *args, **opts):
508 508 > try:
509 509 > ui.write(extlibroot.lsub1.lsub2.notexist.text)
510 510 > return 1 # unintentional success
511 511 > except ImportError:
512 512 > pass # intentional failure
513 513 > EOF
514 514
515 515 $ (PYTHONPATH=${PYTHONPATH}${PATHSEP}${TESTTMP}; hg --config extensions.checkrelativity=$TESTTMP/checkrelativity.py checkrelativity)
516 516
517 517 #endif
518 518
519 519 Make sure a broken uisetup doesn't globally break hg:
520 520 $ cat > $TESTTMP/baduisetup.py <<EOF
521 521 > def uisetup(ui):
522 522 > 1/0
523 523 > EOF
524 524
525 525 Even though the extension fails during uisetup, hg is still basically usable:
526 526 $ hg --config extensions.baduisetup=$TESTTMP/baduisetup.py version
527 527 Traceback (most recent call last):
528 528 File "*/mercurial/extensions.py", line *, in _runuisetup (glob)
529 529 uisetup(ui)
530 530 File "$TESTTMP/baduisetup.py", line 2, in uisetup
531 531 1/0
532 532 ZeroDivisionError: integer division or modulo by zero
533 533 *** failed to set up extension baduisetup: integer division or modulo by zero
534 534 Mercurial Distributed SCM (version *) (glob)
535 535 (see https://mercurial-scm.org for more information)
536 536
537 537 Copyright (C) 2005-2017 Matt Mackall and others
538 538 This is free software; see the source for copying conditions. There is NO
539 539 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
540 540
541 541 $ cd ..
542 542
543 543 hide outer repo
544 544 $ hg init
545 545
546 546 $ cat > empty.py <<EOF
547 547 > '''empty cmdtable
548 548 > '''
549 549 > cmdtable = {}
550 550 > EOF
551 551 $ emptypath=`pwd`/empty.py
552 552 $ echo "empty = $emptypath" >> $HGRCPATH
553 553 $ hg help empty
554 554 empty extension - empty cmdtable
555 555
556 556 no commands defined
557 557
558 558
559 559 $ echo 'empty = !' >> $HGRCPATH
560 560
561 561 $ cat > debugextension.py <<EOF
562 562 > '''only debugcommands
563 563 > '''
564 564 > from mercurial import registrar
565 565 > cmdtable = {}
566 566 > command = registrar.command(cmdtable)
567 567 > @command(b'debugfoobar', [], 'hg debugfoobar')
568 568 > def debugfoobar(ui, repo, *args, **opts):
569 569 > "yet another debug command"
570 570 > pass
571 571 > @command(b'foo', [], 'hg foo')
572 572 > def foo(ui, repo, *args, **opts):
573 573 > """yet another foo command
574 574 > This command has been DEPRECATED since forever.
575 575 > """
576 576 > pass
577 577 > EOF
578 578 $ debugpath=`pwd`/debugextension.py
579 579 $ echo "debugextension = $debugpath" >> $HGRCPATH
580 580
581 581 $ hg help debugextension
582 582 hg debugextensions
583 583
584 584 show information about active extensions
585 585
586 586 options:
587 587
588 588 (some details hidden, use --verbose to show complete help)
589 589
590 590
591 591 $ hg --verbose help debugextension
592 592 hg debugextensions
593 593
594 594 show information about active extensions
595 595
596 596 options:
597 597
598 598 -T --template TEMPLATE display with template (EXPERIMENTAL)
599 599
600 600 global options ([+] can be repeated):
601 601
602 602 -R --repository REPO repository root directory or name of overlay bundle
603 603 file
604 604 --cwd DIR change working directory
605 605 -y --noninteractive do not prompt, automatically pick the first choice for
606 606 all prompts
607 607 -q --quiet suppress output
608 608 -v --verbose enable additional output
609 609 --color TYPE when to colorize (boolean, always, auto, never, or
610 610 debug)
611 611 --config CONFIG [+] set/override config option (use 'section.name=value')
612 612 --debug enable debugging output
613 613 --debugger start debugger
614 614 --encoding ENCODE set the charset encoding (default: ascii)
615 615 --encodingmode MODE set the charset encoding mode (default: strict)
616 616 --traceback always print a traceback on exception
617 617 --time time how long the command takes
618 618 --profile print command execution profile
619 619 --version output version information and exit
620 620 -h --help display help and exit
621 621 --hidden consider hidden changesets
622 622 --pager TYPE when to paginate (boolean, always, auto, or never)
623 623 (default: auto)
624 624
625 625
626 626
627 627
628 628
629 629
630 630 $ hg --debug help debugextension
631 631 hg debugextensions
632 632
633 633 show information about active extensions
634 634
635 635 options:
636 636
637 637 -T --template TEMPLATE display with template (EXPERIMENTAL)
638 638
639 639 global options ([+] can be repeated):
640 640
641 641 -R --repository REPO repository root directory or name of overlay bundle
642 642 file
643 643 --cwd DIR change working directory
644 644 -y --noninteractive do not prompt, automatically pick the first choice for
645 645 all prompts
646 646 -q --quiet suppress output
647 647 -v --verbose enable additional output
648 648 --color TYPE when to colorize (boolean, always, auto, never, or
649 649 debug)
650 650 --config CONFIG [+] set/override config option (use 'section.name=value')
651 651 --debug enable debugging output
652 652 --debugger start debugger
653 653 --encoding ENCODE set the charset encoding (default: ascii)
654 654 --encodingmode MODE set the charset encoding mode (default: strict)
655 655 --traceback always print a traceback on exception
656 656 --time time how long the command takes
657 657 --profile print command execution profile
658 658 --version output version information and exit
659 659 -h --help display help and exit
660 660 --hidden consider hidden changesets
661 661 --pager TYPE when to paginate (boolean, always, auto, or never)
662 662 (default: auto)
663 663
664 664
665 665
666 666
667 667
668 668 $ echo 'debugextension = !' >> $HGRCPATH
669 669
670 670 Asking for help about a deprecated extension should do something useful:
671 671
672 672 $ hg help glog
673 673 'glog' is provided by the following extension:
674 674
675 675 graphlog command to view revision graphs from a shell (DEPRECATED)
676 676
677 677 (use 'hg help extensions' for information on enabling extensions)
678 678
679 679 Extension module help vs command help:
680 680
681 681 $ echo 'extdiff =' >> $HGRCPATH
682 682 $ hg help extdiff
683 683 hg extdiff [OPT]... [FILE]...
684 684
685 685 use external program to diff repository (or selected files)
686 686
687 687 Show differences between revisions for the specified files, using an
688 688 external program. The default program used is diff, with default options
689 689 "-Npru".
690 690
691 691 To select a different program, use the -p/--program option. The program
692 692 will be passed the names of two directories to compare. To pass additional
693 693 options to the program, use -o/--option. These will be passed before the
694 694 names of the directories to compare.
695 695
696 696 When two revision arguments are given, then changes are shown between
697 697 those revisions. If only one revision is specified then that revision is
698 698 compared to the working directory, and, when no revisions are specified,
699 699 the working directory files are compared to its parent.
700 700
701 701 (use 'hg help -e extdiff' to show help for the extdiff extension)
702 702
703 703 options ([+] can be repeated):
704 704
705 705 -p --program CMD comparison program to run
706 706 -o --option OPT [+] pass option to comparison program
707 707 -r --rev REV [+] revision
708 708 -c --change REV change made by revision
709 709 --patch compare patches for two revisions
710 710 -I --include PATTERN [+] include names matching the given patterns
711 711 -X --exclude PATTERN [+] exclude names matching the given patterns
712 712 -S --subrepos recurse into subrepositories
713 713
714 714 (some details hidden, use --verbose to show complete help)
715 715
716 716
717 717
718 718
719 719
720 720
721 721
722 722
723 723
724 724
725 725 $ hg help --extension extdiff
726 726 extdiff extension - command to allow external programs to compare revisions
727 727
728 728 The extdiff Mercurial extension allows you to use external programs to compare
729 729 revisions, or revision with working directory. The external diff programs are
730 730 called with a configurable set of options and two non-option arguments: paths
731 731 to directories containing snapshots of files to compare.
732 732
733 733 The extdiff extension also allows you to configure new diff commands, so you
734 734 do not need to type 'hg extdiff -p kdiff3' always.
735 735
736 736 [extdiff]
737 737 # add new command that runs GNU diff(1) in 'context diff' mode
738 738 cdiff = gdiff -Nprc5
739 739 ## or the old way:
740 740 #cmd.cdiff = gdiff
741 741 #opts.cdiff = -Nprc5
742 742
743 743 # add new command called meld, runs meld (no need to name twice). If
744 744 # the meld executable is not available, the meld tool in [merge-tools]
745 745 # will be used, if available
746 746 meld =
747 747
748 748 # add new command called vimdiff, runs gvimdiff with DirDiff plugin
749 749 # (see http://www.vim.org/scripts/script.php?script_id=102) Non
750 750 # English user, be sure to put "let g:DirDiffDynamicDiffText = 1" in
751 751 # your .vimrc
752 752 vimdiff = gvim -f "+next" \
753 753 "+execute 'DirDiff' fnameescape(argv(0)) fnameescape(argv(1))"
754 754
755 755 Tool arguments can include variables that are expanded at runtime:
756 756
757 757 $parent1, $plabel1 - filename, descriptive label of first parent
758 758 $child, $clabel - filename, descriptive label of child revision
759 759 $parent2, $plabel2 - filename, descriptive label of second parent
760 760 $root - repository root
761 761 $parent is an alias for $parent1.
762 762
763 763 The extdiff extension will look in your [diff-tools] and [merge-tools]
764 764 sections for diff tool arguments, when none are specified in [extdiff].
765 765
766 766 [extdiff]
767 767 kdiff3 =
768 768
769 769 [diff-tools]
770 770 kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child
771 771
772 772 You can use -I/-X and list of file or directory names like normal 'hg diff'
773 773 command. The extdiff extension makes snapshots of only needed files, so
774 774 running the external diff program will actually be pretty fast (at least
775 775 faster than having to compare the entire tree).
776 776
777 777 list of commands:
778 778
779 779 extdiff use external program to diff repository (or selected files)
780 780
781 781 (use 'hg help -v -e extdiff' to show built-in aliases and global options)
782 782
783 783
784 784
785 785
786 786
787 787
788 788
789 789
790 790
791 791
792 792
793 793
794 794
795 795
796 796
797 797
798 798 $ echo 'extdiff = !' >> $HGRCPATH
799 799
800 800 Test help topic with same name as extension
801 801
802 802 $ cat > multirevs.py <<EOF
803 803 > from mercurial import commands, registrar
804 804 > cmdtable = {}
805 805 > command = registrar.command(cmdtable)
806 806 > """multirevs extension
807 807 > Big multi-line module docstring."""
808 808 > @command(b'multirevs', [], 'ARG', norepo=True)
809 809 > def multirevs(ui, repo, arg, *args, **opts):
810 810 > """multirevs command"""
811 811 > pass
812 812 > EOF
813 813 $ echo "multirevs = multirevs.py" >> $HGRCPATH
814 814
815 815 $ hg help multirevs | tail
816 bookmark (this works because the last revision of the revset is used):
816 used):
817 817
818 818 hg update :@
819 819
820 820 - Show diff between tags 1.3 and 1.5 (this works because the first and the
821 821 last revisions of the revset are used):
822 822
823 823 hg diff -r 1.3::1.5
824 824
825 825 use 'hg help -c multirevs' to see help for the multirevs command
826 826
827 827
828 828
829 829
830 830
831 831
832 832 $ hg help -c multirevs
833 833 hg multirevs ARG
834 834
835 835 multirevs command
836 836
837 837 (some details hidden, use --verbose to show complete help)
838 838
839 839
840 840
841 841 $ hg multirevs
842 842 hg multirevs: invalid arguments
843 843 hg multirevs ARG
844 844
845 845 multirevs command
846 846
847 847 (use 'hg multirevs -h' to show more help)
848 848 [255]
849 849
850 850
851 851
852 852 $ echo "multirevs = !" >> $HGRCPATH
853 853
854 854 Issue811: Problem loading extensions twice (by site and by user)
855 855
856 856 $ cat <<EOF >> $HGRCPATH
857 857 > mq =
858 858 > strip =
859 859 > hgext.mq =
860 860 > hgext/mq =
861 861 > EOF
862 862
863 863 Show extensions:
864 864 (note that mq force load strip, also checking it's not loaded twice)
865 865
866 866 $ hg debugextensions
867 867 mq
868 868 strip
869 869
870 870 For extensions, which name matches one of its commands, help
871 871 message should ask '-v -e' to get list of built-in aliases
872 872 along with extension help itself
873 873
874 874 $ mkdir $TESTTMP/d
875 875 $ cat > $TESTTMP/d/dodo.py <<EOF
876 876 > """
877 877 > This is an awesome 'dodo' extension. It does nothing and
878 878 > writes 'Foo foo'
879 879 > """
880 880 > from mercurial import commands, registrar
881 881 > cmdtable = {}
882 882 > command = registrar.command(cmdtable)
883 883 > @command(b'dodo', [], 'hg dodo')
884 884 > def dodo(ui, *args, **kwargs):
885 885 > """Does nothing"""
886 886 > ui.write("I do nothing. Yay\\n")
887 887 > @command(b'foofoo', [], 'hg foofoo')
888 888 > def foofoo(ui, *args, **kwargs):
889 889 > """Writes 'Foo foo'"""
890 890 > ui.write("Foo foo\\n")
891 891 > EOF
892 892 $ dodopath=$TESTTMP/d/dodo.py
893 893
894 894 $ echo "dodo = $dodopath" >> $HGRCPATH
895 895
896 896 Make sure that user is asked to enter '-v -e' to get list of built-in aliases
897 897 $ hg help -e dodo
898 898 dodo extension -
899 899
900 900 This is an awesome 'dodo' extension. It does nothing and writes 'Foo foo'
901 901
902 902 list of commands:
903 903
904 904 dodo Does nothing
905 905 foofoo Writes 'Foo foo'
906 906
907 907 (use 'hg help -v -e dodo' to show built-in aliases and global options)
908 908
909 909 Make sure that '-v -e' prints list of built-in aliases along with
910 910 extension help itself
911 911 $ hg help -v -e dodo
912 912 dodo extension -
913 913
914 914 This is an awesome 'dodo' extension. It does nothing and writes 'Foo foo'
915 915
916 916 list of commands:
917 917
918 918 dodo Does nothing
919 919 foofoo Writes 'Foo foo'
920 920
921 921 global options ([+] can be repeated):
922 922
923 923 -R --repository REPO repository root directory or name of overlay bundle
924 924 file
925 925 --cwd DIR change working directory
926 926 -y --noninteractive do not prompt, automatically pick the first choice for
927 927 all prompts
928 928 -q --quiet suppress output
929 929 -v --verbose enable additional output
930 930 --color TYPE when to colorize (boolean, always, auto, never, or
931 931 debug)
932 932 --config CONFIG [+] set/override config option (use 'section.name=value')
933 933 --debug enable debugging output
934 934 --debugger start debugger
935 935 --encoding ENCODE set the charset encoding (default: ascii)
936 936 --encodingmode MODE set the charset encoding mode (default: strict)
937 937 --traceback always print a traceback on exception
938 938 --time time how long the command takes
939 939 --profile print command execution profile
940 940 --version output version information and exit
941 941 -h --help display help and exit
942 942 --hidden consider hidden changesets
943 943 --pager TYPE when to paginate (boolean, always, auto, or never)
944 944 (default: auto)
945 945
946 946 Make sure that single '-v' option shows help and built-ins only for 'dodo' command
947 947 $ hg help -v dodo
948 948 hg dodo
949 949
950 950 Does nothing
951 951
952 952 (use 'hg help -e dodo' to show help for the dodo extension)
953 953
954 954 options:
955 955
956 956 --mq operate on patch repository
957 957
958 958 global options ([+] can be repeated):
959 959
960 960 -R --repository REPO repository root directory or name of overlay bundle
961 961 file
962 962 --cwd DIR change working directory
963 963 -y --noninteractive do not prompt, automatically pick the first choice for
964 964 all prompts
965 965 -q --quiet suppress output
966 966 -v --verbose enable additional output
967 967 --color TYPE when to colorize (boolean, always, auto, never, or
968 968 debug)
969 969 --config CONFIG [+] set/override config option (use 'section.name=value')
970 970 --debug enable debugging output
971 971 --debugger start debugger
972 972 --encoding ENCODE set the charset encoding (default: ascii)
973 973 --encodingmode MODE set the charset encoding mode (default: strict)
974 974 --traceback always print a traceback on exception
975 975 --time time how long the command takes
976 976 --profile print command execution profile
977 977 --version output version information and exit
978 978 -h --help display help and exit
979 979 --hidden consider hidden changesets
980 980 --pager TYPE when to paginate (boolean, always, auto, or never)
981 981 (default: auto)
982 982
983 983 In case when extension name doesn't match any of its commands,
984 984 help message should ask for '-v' to get list of built-in aliases
985 985 along with extension help
986 986 $ cat > $TESTTMP/d/dudu.py <<EOF
987 987 > """
988 988 > This is an awesome 'dudu' extension. It does something and
989 989 > also writes 'Beep beep'
990 990 > """
991 991 > from mercurial import commands, registrar
992 992 > cmdtable = {}
993 993 > command = registrar.command(cmdtable)
994 994 > @command(b'something', [], 'hg something')
995 995 > def something(ui, *args, **kwargs):
996 996 > """Does something"""
997 997 > ui.write("I do something. Yaaay\\n")
998 998 > @command(b'beep', [], 'hg beep')
999 999 > def beep(ui, *args, **kwargs):
1000 1000 > """Writes 'Beep beep'"""
1001 1001 > ui.write("Beep beep\\n")
1002 1002 > EOF
1003 1003 $ dudupath=$TESTTMP/d/dudu.py
1004 1004
1005 1005 $ echo "dudu = $dudupath" >> $HGRCPATH
1006 1006
1007 1007 $ hg help -e dudu
1008 1008 dudu extension -
1009 1009
1010 1010 This is an awesome 'dudu' extension. It does something and also writes 'Beep
1011 1011 beep'
1012 1012
1013 1013 list of commands:
1014 1014
1015 1015 beep Writes 'Beep beep'
1016 1016 something Does something
1017 1017
1018 1018 (use 'hg help -v dudu' to show built-in aliases and global options)
1019 1019
1020 1020 In case when extension name doesn't match any of its commands,
1021 1021 help options '-v' and '-v -e' should be equivalent
1022 1022 $ hg help -v dudu
1023 1023 dudu extension -
1024 1024
1025 1025 This is an awesome 'dudu' extension. It does something and also writes 'Beep
1026 1026 beep'
1027 1027
1028 1028 list of commands:
1029 1029
1030 1030 beep Writes 'Beep beep'
1031 1031 something Does something
1032 1032
1033 1033 global options ([+] can be repeated):
1034 1034
1035 1035 -R --repository REPO repository root directory or name of overlay bundle
1036 1036 file
1037 1037 --cwd DIR change working directory
1038 1038 -y --noninteractive do not prompt, automatically pick the first choice for
1039 1039 all prompts
1040 1040 -q --quiet suppress output
1041 1041 -v --verbose enable additional output
1042 1042 --color TYPE when to colorize (boolean, always, auto, never, or
1043 1043 debug)
1044 1044 --config CONFIG [+] set/override config option (use 'section.name=value')
1045 1045 --debug enable debugging output
1046 1046 --debugger start debugger
1047 1047 --encoding ENCODE set the charset encoding (default: ascii)
1048 1048 --encodingmode MODE set the charset encoding mode (default: strict)
1049 1049 --traceback always print a traceback on exception
1050 1050 --time time how long the command takes
1051 1051 --profile print command execution profile
1052 1052 --version output version information and exit
1053 1053 -h --help display help and exit
1054 1054 --hidden consider hidden changesets
1055 1055 --pager TYPE when to paginate (boolean, always, auto, or never)
1056 1056 (default: auto)
1057 1057
1058 1058 $ hg help -v -e dudu
1059 1059 dudu extension -
1060 1060
1061 1061 This is an awesome 'dudu' extension. It does something and also writes 'Beep
1062 1062 beep'
1063 1063
1064 1064 list of commands:
1065 1065
1066 1066 beep Writes 'Beep beep'
1067 1067 something Does something
1068 1068
1069 1069 global options ([+] can be repeated):
1070 1070
1071 1071 -R --repository REPO repository root directory or name of overlay bundle
1072 1072 file
1073 1073 --cwd DIR change working directory
1074 1074 -y --noninteractive do not prompt, automatically pick the first choice for
1075 1075 all prompts
1076 1076 -q --quiet suppress output
1077 1077 -v --verbose enable additional output
1078 1078 --color TYPE when to colorize (boolean, always, auto, never, or
1079 1079 debug)
1080 1080 --config CONFIG [+] set/override config option (use 'section.name=value')
1081 1081 --debug enable debugging output
1082 1082 --debugger start debugger
1083 1083 --encoding ENCODE set the charset encoding (default: ascii)
1084 1084 --encodingmode MODE set the charset encoding mode (default: strict)
1085 1085 --traceback always print a traceback on exception
1086 1086 --time time how long the command takes
1087 1087 --profile print command execution profile
1088 1088 --version output version information and exit
1089 1089 -h --help display help and exit
1090 1090 --hidden consider hidden changesets
1091 1091 --pager TYPE when to paginate (boolean, always, auto, or never)
1092 1092 (default: auto)
1093 1093
1094 1094 Disabled extension commands:
1095 1095
1096 1096 $ ORGHGRCPATH=$HGRCPATH
1097 1097 $ HGRCPATH=
1098 1098 $ export HGRCPATH
1099 1099 $ hg help email
1100 1100 'email' is provided by the following extension:
1101 1101
1102 1102 patchbomb command to send changesets as (a series of) patch emails
1103 1103
1104 1104 (use 'hg help extensions' for information on enabling extensions)
1105 1105
1106 1106
1107 1107 $ hg qdel
1108 1108 hg: unknown command 'qdel'
1109 1109 'qdelete' is provided by the following extension:
1110 1110
1111 1111 mq manage a stack of patches
1112 1112
1113 1113 (use 'hg help extensions' for information on enabling extensions)
1114 1114 [255]
1115 1115
1116 1116
1117 1117 $ hg churn
1118 1118 hg: unknown command 'churn'
1119 1119 'churn' is provided by the following extension:
1120 1120
1121 1121 churn command to display statistics about repository history
1122 1122
1123 1123 (use 'hg help extensions' for information on enabling extensions)
1124 1124 [255]
1125 1125
1126 1126
1127 1127
1128 1128 Disabled extensions:
1129 1129
1130 1130 $ hg help churn
1131 1131 churn extension - command to display statistics about repository history
1132 1132
1133 1133 (use 'hg help extensions' for information on enabling extensions)
1134 1134
1135 1135 $ hg help patchbomb
1136 1136 patchbomb extension - command to send changesets as (a series of) patch emails
1137 1137
1138 1138 The series is started off with a "[PATCH 0 of N]" introduction, which
1139 1139 describes the series as a whole.
1140 1140
1141 1141 Each patch email has a Subject line of "[PATCH M of N] ...", using the first
1142 1142 line of the changeset description as the subject text. The message contains
1143 1143 two or three body parts:
1144 1144
1145 1145 - The changeset description.
1146 1146 - [Optional] The result of running diffstat on the patch.
1147 1147 - The patch itself, as generated by 'hg export'.
1148 1148
1149 1149 Each message refers to the first in the series using the In-Reply-To and
1150 1150 References headers, so they will show up as a sequence in threaded mail and
1151 1151 news readers, and in mail archives.
1152 1152
1153 1153 To configure other defaults, add a section like this to your configuration
1154 1154 file:
1155 1155
1156 1156 [email]
1157 1157 from = My Name <my@email>
1158 1158 to = recipient1, recipient2, ...
1159 1159 cc = cc1, cc2, ...
1160 1160 bcc = bcc1, bcc2, ...
1161 1161 reply-to = address1, address2, ...
1162 1162
1163 1163 Use "[patchbomb]" as configuration section name if you need to override global
1164 1164 "[email]" address settings.
1165 1165
1166 1166 Then you can use the 'hg email' command to mail a series of changesets as a
1167 1167 patchbomb.
1168 1168
1169 1169 You can also either configure the method option in the email section to be a
1170 1170 sendmail compatible mailer or fill out the [smtp] section so that the
1171 1171 patchbomb extension can automatically send patchbombs directly from the
1172 1172 commandline. See the [email] and [smtp] sections in hgrc(5) for details.
1173 1173
1174 1174 By default, 'hg email' will prompt for a "To" or "CC" header if you do not
1175 1175 supply one via configuration or the command line. You can override this to
1176 1176 never prompt by configuring an empty value:
1177 1177
1178 1178 [email]
1179 1179 cc =
1180 1180
1181 1181 You can control the default inclusion of an introduction message with the
1182 1182 "patchbomb.intro" configuration option. The configuration is always
1183 1183 overwritten by command line flags like --intro and --desc:
1184 1184
1185 1185 [patchbomb]
1186 1186 intro=auto # include introduction message if more than 1 patch (default)
1187 1187 intro=never # never include an introduction message
1188 1188 intro=always # always include an introduction message
1189 1189
1190 1190 You can specify a template for flags to be added in subject prefixes. Flags
1191 1191 specified by --flag option are exported as "{flags}" keyword:
1192 1192
1193 1193 [patchbomb]
1194 1194 flagtemplate = "{separate(' ',
1195 1195 ifeq(branch, 'default', '', branch|upper),
1196 1196 flags)}"
1197 1197
1198 1198 You can set patchbomb to always ask for confirmation by setting
1199 1199 "patchbomb.confirm" to true.
1200 1200
1201 1201 (use 'hg help extensions' for information on enabling extensions)
1202 1202
1203 1203
1204 1204 Broken disabled extension and command:
1205 1205
1206 1206 $ mkdir hgext
1207 1207 $ echo > hgext/__init__.py
1208 1208 $ cat > hgext/broken.py <<EOF
1209 1209 > "broken extension'
1210 1210 > EOF
1211 1211 $ cat > path.py <<EOF
1212 1212 > import os, sys
1213 1213 > sys.path.insert(0, os.environ['HGEXTPATH'])
1214 1214 > EOF
1215 1215 $ HGEXTPATH=`pwd`
1216 1216 $ export HGEXTPATH
1217 1217
1218 1218 $ hg --config extensions.path=./path.py help broken
1219 1219 broken extension - (no help text available)
1220 1220
1221 1221 (use 'hg help extensions' for information on enabling extensions)
1222 1222
1223 1223
1224 1224 $ cat > hgext/forest.py <<EOF
1225 1225 > cmdtable = None
1226 1226 > EOF
1227 1227 $ hg --config extensions.path=./path.py help foo > /dev/null
1228 1228 warning: error finding commands in $TESTTMP/hgext/forest.py (glob)
1229 1229 abort: no such help topic: foo
1230 1230 (try 'hg help --keyword foo')
1231 1231 [255]
1232 1232
1233 1233 $ cat > throw.py <<EOF
1234 1234 > from mercurial import commands, registrar, util
1235 1235 > cmdtable = {}
1236 1236 > command = registrar.command(cmdtable)
1237 1237 > class Bogon(Exception): pass
1238 1238 > @command(b'throw', [], 'hg throw', norepo=True)
1239 1239 > def throw(ui, **opts):
1240 1240 > """throws an exception"""
1241 1241 > raise Bogon()
1242 1242 > EOF
1243 1243
1244 1244 No declared supported version, extension complains:
1245 1245 $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
1246 1246 ** Unknown exception encountered with possibly-broken third-party extension throw
1247 1247 ** which supports versions unknown of Mercurial.
1248 1248 ** Please disable throw and try your action again.
1249 1249 ** If that fixes the bug please report it to the extension author.
1250 1250 ** Python * (glob)
1251 1251 ** Mercurial Distributed SCM * (glob)
1252 1252 ** Extensions loaded: throw
1253 1253
1254 1254 empty declaration of supported version, extension complains:
1255 1255 $ echo "testedwith = ''" >> throw.py
1256 1256 $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
1257 1257 ** Unknown exception encountered with possibly-broken third-party extension throw
1258 1258 ** which supports versions unknown of Mercurial.
1259 1259 ** Please disable throw and try your action again.
1260 1260 ** If that fixes the bug please report it to the extension author.
1261 1261 ** Python * (glob)
1262 1262 ** Mercurial Distributed SCM (*) (glob)
1263 1263 ** Extensions loaded: throw
1264 1264
1265 1265 If the extension specifies a buglink, show that:
1266 1266 $ echo 'buglink = "http://example.com/bts"' >> throw.py
1267 1267 $ rm -f throw.pyc throw.pyo
1268 1268 $ rm -Rf __pycache__
1269 1269 $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
1270 1270 ** Unknown exception encountered with possibly-broken third-party extension throw
1271 1271 ** which supports versions unknown of Mercurial.
1272 1272 ** Please disable throw and try your action again.
1273 1273 ** If that fixes the bug please report it to http://example.com/bts
1274 1274 ** Python * (glob)
1275 1275 ** Mercurial Distributed SCM (*) (glob)
1276 1276 ** Extensions loaded: throw
1277 1277
1278 1278 If the extensions declare outdated versions, accuse the older extension first:
1279 1279 $ echo "from mercurial import util" >> older.py
1280 1280 $ echo "util.version = lambda:'2.2'" >> older.py
1281 1281 $ echo "testedwith = '1.9.3'" >> older.py
1282 1282 $ echo "testedwith = '2.1.1'" >> throw.py
1283 1283 $ rm -f throw.pyc throw.pyo
1284 1284 $ rm -Rf __pycache__
1285 1285 $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
1286 1286 > throw 2>&1 | egrep '^\*\*'
1287 1287 ** Unknown exception encountered with possibly-broken third-party extension older
1288 1288 ** which supports versions 1.9 of Mercurial.
1289 1289 ** Please disable older and try your action again.
1290 1290 ** If that fixes the bug please report it to the extension author.
1291 1291 ** Python * (glob)
1292 1292 ** Mercurial Distributed SCM (version 2.2)
1293 1293 ** Extensions loaded: throw, older
1294 1294
1295 1295 One extension only tested with older, one only with newer versions:
1296 1296 $ echo "util.version = lambda:'2.1'" >> older.py
1297 1297 $ rm -f older.pyc older.pyo
1298 1298 $ rm -Rf __pycache__
1299 1299 $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
1300 1300 > throw 2>&1 | egrep '^\*\*'
1301 1301 ** Unknown exception encountered with possibly-broken third-party extension older
1302 1302 ** which supports versions 1.9 of Mercurial.
1303 1303 ** Please disable older and try your action again.
1304 1304 ** If that fixes the bug please report it to the extension author.
1305 1305 ** Python * (glob)
1306 1306 ** Mercurial Distributed SCM (version 2.1)
1307 1307 ** Extensions loaded: throw, older
1308 1308
1309 1309 Older extension is tested with current version, the other only with newer:
1310 1310 $ echo "util.version = lambda:'1.9.3'" >> older.py
1311 1311 $ rm -f older.pyc older.pyo
1312 1312 $ rm -Rf __pycache__
1313 1313 $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
1314 1314 > throw 2>&1 | egrep '^\*\*'
1315 1315 ** Unknown exception encountered with possibly-broken third-party extension throw
1316 1316 ** which supports versions 2.1 of Mercurial.
1317 1317 ** Please disable throw and try your action again.
1318 1318 ** If that fixes the bug please report it to http://example.com/bts
1319 1319 ** Python * (glob)
1320 1320 ** Mercurial Distributed SCM (version 1.9.3)
1321 1321 ** Extensions loaded: throw, older
1322 1322
1323 1323 Ability to point to a different point
1324 1324 $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
1325 1325 > --config ui.supportcontact='Your Local Goat Lenders' throw 2>&1 | egrep '^\*\*'
1326 1326 ** unknown exception encountered, please report by visiting
1327 1327 ** Your Local Goat Lenders
1328 1328 ** Python * (glob)
1329 1329 ** Mercurial Distributed SCM (*) (glob)
1330 1330 ** Extensions loaded: throw, older
1331 1331
1332 1332 Declare the version as supporting this hg version, show regular bts link:
1333 1333 $ hgver=`hg debuginstall -T '{hgver}'`
1334 1334 $ echo 'testedwith = """'"$hgver"'"""' >> throw.py
1335 1335 $ if [ -z "$hgver" ]; then
1336 1336 > echo "unable to fetch a mercurial version. Make sure __version__ is correct";
1337 1337 > fi
1338 1338 $ rm -f throw.pyc throw.pyo
1339 1339 $ rm -Rf __pycache__
1340 1340 $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
1341 1341 ** unknown exception encountered, please report by visiting
1342 1342 ** https://mercurial-scm.org/wiki/BugTracker
1343 1343 ** Python * (glob)
1344 1344 ** Mercurial Distributed SCM (*) (glob)
1345 1345 ** Extensions loaded: throw
1346 1346
1347 1347 Patch version is ignored during compatibility check
1348 1348 $ echo "testedwith = '3.2'" >> throw.py
1349 1349 $ echo "util.version = lambda:'3.2.2'" >> throw.py
1350 1350 $ rm -f throw.pyc throw.pyo
1351 1351 $ rm -Rf __pycache__
1352 1352 $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
1353 1353 ** unknown exception encountered, please report by visiting
1354 1354 ** https://mercurial-scm.org/wiki/BugTracker
1355 1355 ** Python * (glob)
1356 1356 ** Mercurial Distributed SCM (*) (glob)
1357 1357 ** Extensions loaded: throw
1358 1358
1359 1359 Test version number support in 'hg version':
1360 1360 $ echo '__version__ = (1, 2, 3)' >> throw.py
1361 1361 $ rm -f throw.pyc throw.pyo
1362 1362 $ rm -Rf __pycache__
1363 1363 $ hg version -v
1364 1364 Mercurial Distributed SCM (version *) (glob)
1365 1365 (see https://mercurial-scm.org for more information)
1366 1366
1367 1367 Copyright (C) 2005-* Matt Mackall and others (glob)
1368 1368 This is free software; see the source for copying conditions. There is NO
1369 1369 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
1370 1370
1371 1371 Enabled extensions:
1372 1372
1373 1373
1374 1374 $ hg version -v --config extensions.throw=throw.py
1375 1375 Mercurial Distributed SCM (version *) (glob)
1376 1376 (see https://mercurial-scm.org for more information)
1377 1377
1378 1378 Copyright (C) 2005-* Matt Mackall and others (glob)
1379 1379 This is free software; see the source for copying conditions. There is NO
1380 1380 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
1381 1381
1382 1382 Enabled extensions:
1383 1383
1384 1384 throw external 1.2.3
1385 1385 $ echo 'getversion = lambda: "1.twentythree"' >> throw.py
1386 1386 $ rm -f throw.pyc throw.pyo
1387 1387 $ rm -Rf __pycache__
1388 1388 $ hg version -v --config extensions.throw=throw.py --config extensions.strip=
1389 1389 Mercurial Distributed SCM (version *) (glob)
1390 1390 (see https://mercurial-scm.org for more information)
1391 1391
1392 1392 Copyright (C) 2005-* Matt Mackall and others (glob)
1393 1393 This is free software; see the source for copying conditions. There is NO
1394 1394 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
1395 1395
1396 1396 Enabled extensions:
1397 1397
1398 1398 throw external 1.twentythree
1399 1399 strip internal
1400 1400
1401 1401 $ hg version -q --config extensions.throw=throw.py
1402 1402 Mercurial Distributed SCM (version *) (glob)
1403 1403
1404 1404 Test JSON output of version:
1405 1405
1406 1406 $ hg version -Tjson
1407 1407 [
1408 1408 {
1409 1409 "extensions": [],
1410 1410 "ver": "*" (glob)
1411 1411 }
1412 1412 ]
1413 1413
1414 1414 $ hg version --config extensions.throw=throw.py -Tjson
1415 1415 [
1416 1416 {
1417 1417 "extensions": [{"bundled": false, "name": "throw", "ver": "1.twentythree"}],
1418 1418 "ver": "3.2.2"
1419 1419 }
1420 1420 ]
1421 1421
1422 1422 $ hg version --config extensions.strip= -Tjson
1423 1423 [
1424 1424 {
1425 1425 "extensions": [{"bundled": true, "name": "strip", "ver": null}],
1426 1426 "ver": "*" (glob)
1427 1427 }
1428 1428 ]
1429 1429
1430 1430 Test template output of version:
1431 1431
1432 1432 $ hg version --config extensions.throw=throw.py --config extensions.strip= \
1433 1433 > -T'{extensions % "{name} {pad(ver, 16)} ({if(bundled, "internal", "external")})\n"}'
1434 1434 throw 1.twentythree (external)
1435 1435 strip (internal)
1436 1436
1437 1437 Refuse to load extensions with minimum version requirements
1438 1438
1439 1439 $ cat > minversion1.py << EOF
1440 1440 > from mercurial import util
1441 1441 > util.version = lambda: '3.5.2'
1442 1442 > minimumhgversion = '3.6'
1443 1443 > EOF
1444 1444 $ hg --config extensions.minversion=minversion1.py version
1445 1445 (third party extension minversion requires version 3.6 or newer of Mercurial; disabling)
1446 1446 Mercurial Distributed SCM (version 3.5.2)
1447 1447 (see https://mercurial-scm.org for more information)
1448 1448
1449 1449 Copyright (C) 2005-* Matt Mackall and others (glob)
1450 1450 This is free software; see the source for copying conditions. There is NO
1451 1451 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
1452 1452
1453 1453 $ cat > minversion2.py << EOF
1454 1454 > from mercurial import util
1455 1455 > util.version = lambda: '3.6'
1456 1456 > minimumhgversion = '3.7'
1457 1457 > EOF
1458 1458 $ hg --config extensions.minversion=minversion2.py version 2>&1 | egrep '\(third'
1459 1459 (third party extension minversion requires version 3.7 or newer of Mercurial; disabling)
1460 1460
1461 1461 Can load version that is only off by point release
1462 1462
1463 1463 $ cat > minversion2.py << EOF
1464 1464 > from mercurial import util
1465 1465 > util.version = lambda: '3.6.1'
1466 1466 > minimumhgversion = '3.6'
1467 1467 > EOF
1468 1468 $ hg --config extensions.minversion=minversion3.py version 2>&1 | egrep '\(third'
1469 1469 [1]
1470 1470
1471 1471 Can load minimum version identical to current
1472 1472
1473 1473 $ cat > minversion3.py << EOF
1474 1474 > from mercurial import util
1475 1475 > util.version = lambda: '3.5'
1476 1476 > minimumhgversion = '3.5'
1477 1477 > EOF
1478 1478 $ hg --config extensions.minversion=minversion3.py version 2>&1 | egrep '\(third'
1479 1479 [1]
1480 1480
1481 1481 Restore HGRCPATH
1482 1482
1483 1483 $ HGRCPATH=$ORGHGRCPATH
1484 1484 $ export HGRCPATH
1485 1485
1486 1486 Commands handling multiple repositories at a time should invoke only
1487 1487 "reposetup()" of extensions enabling in the target repository.
1488 1488
1489 1489 $ mkdir reposetup-test
1490 1490 $ cd reposetup-test
1491 1491
1492 1492 $ cat > $TESTTMP/reposetuptest.py <<EOF
1493 1493 > from mercurial import extensions
1494 1494 > def reposetup(ui, repo):
1495 1495 > ui.write('reposetup() for %s\n' % (repo.root))
1496 1496 > ui.flush()
1497 1497 > EOF
1498 1498 $ hg init src
1499 1499 $ echo a > src/a
1500 1500 $ hg -R src commit -Am '#0 at src/a'
1501 1501 adding a
1502 1502 $ echo '[extensions]' >> src/.hg/hgrc
1503 1503 $ echo '# enable extension locally' >> src/.hg/hgrc
1504 1504 $ echo "reposetuptest = $TESTTMP/reposetuptest.py" >> src/.hg/hgrc
1505 1505 $ hg -R src status
1506 1506 reposetup() for $TESTTMP/reposetup-test/src (glob)
1507 1507 reposetup() for $TESTTMP/reposetup-test/src (glob) (chg !)
1508 1508
1509 1509 $ hg clone -U src clone-dst1
1510 1510 reposetup() for $TESTTMP/reposetup-test/src (glob)
1511 1511 $ hg init push-dst1
1512 1512 $ hg -q -R src push push-dst1
1513 1513 reposetup() for $TESTTMP/reposetup-test/src (glob)
1514 1514 $ hg init pull-src1
1515 1515 $ hg -q -R pull-src1 pull src
1516 1516 reposetup() for $TESTTMP/reposetup-test/src (glob)
1517 1517
1518 1518 $ cat <<EOF >> $HGRCPATH
1519 1519 > [extensions]
1520 1520 > # disable extension globally and explicitly
1521 1521 > reposetuptest = !
1522 1522 > EOF
1523 1523 $ hg clone -U src clone-dst2
1524 1524 reposetup() for $TESTTMP/reposetup-test/src (glob)
1525 1525 $ hg init push-dst2
1526 1526 $ hg -q -R src push push-dst2
1527 1527 reposetup() for $TESTTMP/reposetup-test/src (glob)
1528 1528 $ hg init pull-src2
1529 1529 $ hg -q -R pull-src2 pull src
1530 1530 reposetup() for $TESTTMP/reposetup-test/src (glob)
1531 1531
1532 1532 $ cat <<EOF >> $HGRCPATH
1533 1533 > [extensions]
1534 1534 > # enable extension globally
1535 1535 > reposetuptest = $TESTTMP/reposetuptest.py
1536 1536 > EOF
1537 1537 $ hg clone -U src clone-dst3
1538 1538 reposetup() for $TESTTMP/reposetup-test/src (glob)
1539 1539 reposetup() for $TESTTMP/reposetup-test/clone-dst3 (glob)
1540 1540 $ hg init push-dst3
1541 1541 reposetup() for $TESTTMP/reposetup-test/push-dst3 (glob)
1542 1542 $ hg -q -R src push push-dst3
1543 1543 reposetup() for $TESTTMP/reposetup-test/src (glob)
1544 1544 reposetup() for $TESTTMP/reposetup-test/push-dst3 (glob)
1545 1545 $ hg init pull-src3
1546 1546 reposetup() for $TESTTMP/reposetup-test/pull-src3 (glob)
1547 1547 $ hg -q -R pull-src3 pull src
1548 1548 reposetup() for $TESTTMP/reposetup-test/pull-src3 (glob)
1549 1549 reposetup() for $TESTTMP/reposetup-test/src (glob)
1550 1550
1551 1551 $ echo '[extensions]' >> src/.hg/hgrc
1552 1552 $ echo '# disable extension locally' >> src/.hg/hgrc
1553 1553 $ echo 'reposetuptest = !' >> src/.hg/hgrc
1554 1554 $ hg clone -U src clone-dst4
1555 1555 reposetup() for $TESTTMP/reposetup-test/clone-dst4 (glob)
1556 1556 $ hg init push-dst4
1557 1557 reposetup() for $TESTTMP/reposetup-test/push-dst4 (glob)
1558 1558 $ hg -q -R src push push-dst4
1559 1559 reposetup() for $TESTTMP/reposetup-test/push-dst4 (glob)
1560 1560 $ hg init pull-src4
1561 1561 reposetup() for $TESTTMP/reposetup-test/pull-src4 (glob)
1562 1562 $ hg -q -R pull-src4 pull src
1563 1563 reposetup() for $TESTTMP/reposetup-test/pull-src4 (glob)
1564 1564
1565 1565 disabling in command line overlays with all configuration
1566 1566 $ hg --config extensions.reposetuptest=! clone -U src clone-dst5
1567 1567 $ hg --config extensions.reposetuptest=! init push-dst5
1568 1568 $ hg --config extensions.reposetuptest=! -q -R src push push-dst5
1569 1569 $ hg --config extensions.reposetuptest=! init pull-src5
1570 1570 $ hg --config extensions.reposetuptest=! -q -R pull-src5 pull src
1571 1571
1572 1572 $ cat <<EOF >> $HGRCPATH
1573 1573 > [extensions]
1574 1574 > # disable extension globally and explicitly
1575 1575 > reposetuptest = !
1576 1576 > EOF
1577 1577 $ hg init parent
1578 1578 $ hg init parent/sub1
1579 1579 $ echo 1 > parent/sub1/1
1580 1580 $ hg -R parent/sub1 commit -Am '#0 at parent/sub1'
1581 1581 adding 1
1582 1582 $ hg init parent/sub2
1583 1583 $ hg init parent/sub2/sub21
1584 1584 $ echo 21 > parent/sub2/sub21/21
1585 1585 $ hg -R parent/sub2/sub21 commit -Am '#0 at parent/sub2/sub21'
1586 1586 adding 21
1587 1587 $ cat > parent/sub2/.hgsub <<EOF
1588 1588 > sub21 = sub21
1589 1589 > EOF
1590 1590 $ hg -R parent/sub2 commit -Am '#0 at parent/sub2'
1591 1591 adding .hgsub
1592 1592 $ hg init parent/sub3
1593 1593 $ echo 3 > parent/sub3/3
1594 1594 $ hg -R parent/sub3 commit -Am '#0 at parent/sub3'
1595 1595 adding 3
1596 1596 $ cat > parent/.hgsub <<EOF
1597 1597 > sub1 = sub1
1598 1598 > sub2 = sub2
1599 1599 > sub3 = sub3
1600 1600 > EOF
1601 1601 $ hg -R parent commit -Am '#0 at parent'
1602 1602 adding .hgsub
1603 1603 $ echo '[extensions]' >> parent/.hg/hgrc
1604 1604 $ echo '# enable extension locally' >> parent/.hg/hgrc
1605 1605 $ echo "reposetuptest = $TESTTMP/reposetuptest.py" >> parent/.hg/hgrc
1606 1606 $ cp parent/.hg/hgrc parent/sub2/.hg/hgrc
1607 1607 $ hg -R parent status -S -A
1608 1608 reposetup() for $TESTTMP/reposetup-test/parent (glob)
1609 1609 reposetup() for $TESTTMP/reposetup-test/parent/sub2 (glob)
1610 1610 C .hgsub
1611 1611 C .hgsubstate
1612 1612 C sub1/1
1613 1613 C sub2/.hgsub
1614 1614 C sub2/.hgsubstate
1615 1615 C sub2/sub21/21
1616 1616 C sub3/3
1617 1617
1618 1618 $ cd ..
1619 1619
1620 1620 Prohibit registration of commands that don't use @command (issue5137)
1621 1621
1622 1622 $ hg init deprecated
1623 1623 $ cd deprecated
1624 1624
1625 1625 $ cat <<EOF > deprecatedcmd.py
1626 1626 > def deprecatedcmd(repo, ui):
1627 1627 > pass
1628 1628 > cmdtable = {
1629 1629 > 'deprecatedcmd': (deprecatedcmd, [], ''),
1630 1630 > }
1631 1631 > EOF
1632 1632 $ cat <<EOF > .hg/hgrc
1633 1633 > [extensions]
1634 1634 > deprecatedcmd = `pwd`/deprecatedcmd.py
1635 1635 > mq = !
1636 1636 > hgext.mq = !
1637 1637 > hgext/mq = !
1638 1638 > EOF
1639 1639
1640 1640 $ hg deprecatedcmd > /dev/null
1641 1641 *** failed to import extension deprecatedcmd from $TESTTMP/deprecated/deprecatedcmd.py: missing attributes: norepo, optionalrepo, inferrepo
1642 1642 *** (use @command decorator to register 'deprecatedcmd')
1643 1643 hg: unknown command 'deprecatedcmd'
1644 1644 [255]
1645 1645
1646 1646 the extension shouldn't be loaded at all so the mq works:
1647 1647
1648 1648 $ hg qseries --config extensions.mq= > /dev/null
1649 1649 *** failed to import extension deprecatedcmd from $TESTTMP/deprecated/deprecatedcmd.py: missing attributes: norepo, optionalrepo, inferrepo
1650 1650 *** (use @command decorator to register 'deprecatedcmd')
1651 1651
1652 1652 $ cd ..
1653 1653
1654 1654 Test synopsis and docstring extending
1655 1655
1656 1656 $ hg init exthelp
1657 1657 $ cat > exthelp.py <<EOF
1658 1658 > from mercurial import commands, extensions
1659 1659 > def exbookmarks(orig, *args, **opts):
1660 1660 > return orig(*args, **opts)
1661 1661 > def uisetup(ui):
1662 1662 > synopsis = ' GREPME [--foo] [-x]'
1663 1663 > docstring = '''
1664 1664 > GREPME make sure that this is in the help!
1665 1665 > '''
1666 1666 > extensions.wrapcommand(commands.table, 'bookmarks', exbookmarks,
1667 1667 > synopsis, docstring)
1668 1668 > EOF
1669 1669 $ abspath=`pwd`/exthelp.py
1670 1670 $ echo '[extensions]' >> $HGRCPATH
1671 1671 $ echo "exthelp = $abspath" >> $HGRCPATH
1672 1672 $ cd exthelp
1673 1673 $ hg help bookmarks | grep GREPME
1674 1674 hg bookmarks [OPTIONS]... [NAME]... GREPME [--foo] [-x]
1675 1675 GREPME make sure that this is in the help!
1676 1676 $ cd ..
1677 1677
1678 1678 Show deprecation warning for the use of cmdutil.command
1679 1679
1680 1680 $ cat > nonregistrar.py <<EOF
1681 1681 > from mercurial import cmdutil
1682 1682 > cmdtable = {}
1683 1683 > command = cmdutil.command(cmdtable)
1684 1684 > @command(b'foo', [], norepo=True)
1685 1685 > def foo(ui):
1686 1686 > pass
1687 1687 > EOF
1688 1688
1689 1689 $ hg --config extensions.nonregistrar=`pwd`/nonregistrar.py version > /dev/null
1690 1690 devel-warn: cmdutil.command is deprecated, use registrar.command to register 'foo'
1691 1691 (compatibility will be dropped after Mercurial-4.6, update your code.) * (glob)
1692 1692
1693 1693 Prohibit the use of unicode strings as the default value of options
1694 1694
1695 1695 $ hg init $TESTTMP/opt-unicode-default
1696 1696
1697 1697 $ cat > $TESTTMP/test_unicode_default_value.py << EOF
1698 1698 > from mercurial import registrar
1699 1699 > cmdtable = {}
1700 1700 > command = registrar.command(cmdtable)
1701 1701 > @command('dummy', [('', 'opt', u'value', u'help')], 'ext [OPTIONS]')
1702 1702 > def ext(*args, **opts):
1703 1703 > print(opts['opt'])
1704 1704 > EOF
1705 1705 $ cat > $TESTTMP/opt-unicode-default/.hg/hgrc << EOF
1706 1706 > [extensions]
1707 1707 > test_unicode_default_value = $TESTTMP/test_unicode_default_value.py
1708 1708 > EOF
1709 1709 $ hg -R $TESTTMP/opt-unicode-default dummy
1710 1710 *** failed to import extension test_unicode_default_value from $TESTTMP/test_unicode_default_value.py: option 'dummy.opt' has a unicode default value
1711 1711 *** (change the dummy.opt default value to a non-unicode string)
1712 1712 hg: unknown command 'dummy'
1713 1713 (did you mean summary?)
1714 1714 [255]
@@ -1,3376 +1,3376 b''
1 1 Short help:
2 2
3 3 $ hg
4 4 Mercurial Distributed SCM
5 5
6 6 basic commands:
7 7
8 8 add add the specified files on the next commit
9 9 annotate show changeset information by line for each file
10 10 clone make a copy of an existing repository
11 11 commit commit the specified files or all outstanding changes
12 12 diff diff repository (or selected files)
13 13 export dump the header and diffs for one or more changesets
14 14 forget forget the specified files on the next commit
15 15 init create a new repository in the given directory
16 16 log show revision history of entire repository or files
17 17 merge merge another revision into working directory
18 18 pull pull changes from the specified source
19 19 push push changes to the specified destination
20 20 remove remove the specified files on the next commit
21 21 serve start stand-alone webserver
22 22 status show changed files in the working directory
23 23 summary summarize working directory state
24 24 update update working directory (or switch revisions)
25 25
26 26 (use 'hg help' for the full list of commands or 'hg -v' for details)
27 27
28 28 $ hg -q
29 29 add add the specified files on the next commit
30 30 annotate show changeset information by line for each file
31 31 clone make a copy of an existing repository
32 32 commit commit the specified files or all outstanding changes
33 33 diff diff repository (or selected files)
34 34 export dump the header and diffs for one or more changesets
35 35 forget forget the specified files on the next commit
36 36 init create a new repository in the given directory
37 37 log show revision history of entire repository or files
38 38 merge merge another revision into working directory
39 39 pull pull changes from the specified source
40 40 push push changes to the specified destination
41 41 remove remove the specified files on the next commit
42 42 serve start stand-alone webserver
43 43 status show changed files in the working directory
44 44 summary summarize working directory state
45 45 update update working directory (or switch revisions)
46 46
47 47 $ hg help
48 48 Mercurial Distributed SCM
49 49
50 50 list of commands:
51 51
52 52 add add the specified files on the next commit
53 53 addremove add all new files, delete all missing files
54 54 annotate show changeset information by line for each file
55 55 archive create an unversioned archive of a repository revision
56 56 backout reverse effect of earlier changeset
57 57 bisect subdivision search of changesets
58 58 bookmarks create a new bookmark or list existing bookmarks
59 59 branch set or show the current branch name
60 60 branches list repository named branches
61 61 bundle create a bundle file
62 62 cat output the current or given revision of files
63 63 clone make a copy of an existing repository
64 64 commit commit the specified files or all outstanding changes
65 65 config show combined config settings from all hgrc files
66 66 copy mark files as copied for the next commit
67 67 diff diff repository (or selected files)
68 68 export dump the header and diffs for one or more changesets
69 69 files list tracked files
70 70 forget forget the specified files on the next commit
71 71 graft copy changes from other branches onto the current branch
72 72 grep search revision history for a pattern in specified files
73 73 heads show branch heads
74 74 help show help for a given topic or a help overview
75 75 identify identify the working directory or specified revision
76 76 import import an ordered set of patches
77 77 incoming show new changesets found in source
78 78 init create a new repository in the given directory
79 79 log show revision history of entire repository or files
80 80 manifest output the current or given revision of the project manifest
81 81 merge merge another revision into working directory
82 82 outgoing show changesets not found in the destination
83 83 paths show aliases for remote repositories
84 84 phase set or show the current phase name
85 85 pull pull changes from the specified source
86 86 push push changes to the specified destination
87 87 recover roll back an interrupted transaction
88 88 remove remove the specified files on the next commit
89 89 rename rename files; equivalent of copy + remove
90 90 resolve redo merges or set/view the merge status of files
91 91 revert restore files to their checkout state
92 92 root print the root (top) of the current working directory
93 93 serve start stand-alone webserver
94 94 status show changed files in the working directory
95 95 summary summarize working directory state
96 96 tag add one or more tags for the current or given revision
97 97 tags list repository tags
98 98 unbundle apply one or more bundle files
99 99 update update working directory (or switch revisions)
100 100 verify verify the integrity of the repository
101 101 version output version and copyright information
102 102
103 103 additional help topics:
104 104
105 105 bundlespec Bundle File Formats
106 106 color Colorizing Outputs
107 107 config Configuration Files
108 108 dates Date Formats
109 109 diffs Diff Formats
110 110 environment Environment Variables
111 111 extensions Using Additional Features
112 112 filesets Specifying File Sets
113 113 glossary Glossary
114 114 hgignore Syntax for Mercurial Ignore Files
115 115 hgweb Configuring hgweb
116 116 internals Technical implementation topics
117 117 merge-tools Merge Tools
118 118 pager Pager Support
119 119 patterns File Name Patterns
120 120 phases Working with Phases
121 121 revisions Specifying Revisions
122 122 scripting Using Mercurial from scripts and automation
123 123 subrepos Subrepositories
124 124 templating Template Usage
125 125 urls URL Paths
126 126
127 127 (use 'hg help -v' to show built-in aliases and global options)
128 128
129 129 $ hg -q help
130 130 add add the specified files on the next commit
131 131 addremove add all new files, delete all missing files
132 132 annotate show changeset information by line for each file
133 133 archive create an unversioned archive of a repository revision
134 134 backout reverse effect of earlier changeset
135 135 bisect subdivision search of changesets
136 136 bookmarks create a new bookmark or list existing bookmarks
137 137 branch set or show the current branch name
138 138 branches list repository named branches
139 139 bundle create a bundle file
140 140 cat output the current or given revision of files
141 141 clone make a copy of an existing repository
142 142 commit commit the specified files or all outstanding changes
143 143 config show combined config settings from all hgrc files
144 144 copy mark files as copied for the next commit
145 145 diff diff repository (or selected files)
146 146 export dump the header and diffs for one or more changesets
147 147 files list tracked files
148 148 forget forget the specified files on the next commit
149 149 graft copy changes from other branches onto the current branch
150 150 grep search revision history for a pattern in specified files
151 151 heads show branch heads
152 152 help show help for a given topic or a help overview
153 153 identify identify the working directory or specified revision
154 154 import import an ordered set of patches
155 155 incoming show new changesets found in source
156 156 init create a new repository in the given directory
157 157 log show revision history of entire repository or files
158 158 manifest output the current or given revision of the project manifest
159 159 merge merge another revision into working directory
160 160 outgoing show changesets not found in the destination
161 161 paths show aliases for remote repositories
162 162 phase set or show the current phase name
163 163 pull pull changes from the specified source
164 164 push push changes to the specified destination
165 165 recover roll back an interrupted transaction
166 166 remove remove the specified files on the next commit
167 167 rename rename files; equivalent of copy + remove
168 168 resolve redo merges or set/view the merge status of files
169 169 revert restore files to their checkout state
170 170 root print the root (top) of the current working directory
171 171 serve start stand-alone webserver
172 172 status show changed files in the working directory
173 173 summary summarize working directory state
174 174 tag add one or more tags for the current or given revision
175 175 tags list repository tags
176 176 unbundle apply one or more bundle files
177 177 update update working directory (or switch revisions)
178 178 verify verify the integrity of the repository
179 179 version output version and copyright information
180 180
181 181 additional help topics:
182 182
183 183 bundlespec Bundle File Formats
184 184 color Colorizing Outputs
185 185 config Configuration Files
186 186 dates Date Formats
187 187 diffs Diff Formats
188 188 environment Environment Variables
189 189 extensions Using Additional Features
190 190 filesets Specifying File Sets
191 191 glossary Glossary
192 192 hgignore Syntax for Mercurial Ignore Files
193 193 hgweb Configuring hgweb
194 194 internals Technical implementation topics
195 195 merge-tools Merge Tools
196 196 pager Pager Support
197 197 patterns File Name Patterns
198 198 phases Working with Phases
199 199 revisions Specifying Revisions
200 200 scripting Using Mercurial from scripts and automation
201 201 subrepos Subrepositories
202 202 templating Template Usage
203 203 urls URL Paths
204 204
205 205 Test extension help:
206 206 $ hg help extensions --config extensions.rebase= --config extensions.children=
207 207 Using Additional Features
208 208 """""""""""""""""""""""""
209 209
210 210 Mercurial has the ability to add new features through the use of
211 211 extensions. Extensions may add new commands, add options to existing
212 212 commands, change the default behavior of commands, or implement hooks.
213 213
214 214 To enable the "foo" extension, either shipped with Mercurial or in the
215 215 Python search path, create an entry for it in your configuration file,
216 216 like this:
217 217
218 218 [extensions]
219 219 foo =
220 220
221 221 You may also specify the full path to an extension:
222 222
223 223 [extensions]
224 224 myfeature = ~/.hgext/myfeature.py
225 225
226 226 See 'hg help config' for more information on configuration files.
227 227
228 228 Extensions are not loaded by default for a variety of reasons: they can
229 229 increase startup overhead; they may be meant for advanced usage only; they
230 230 may provide potentially dangerous abilities (such as letting you destroy
231 231 or modify history); they might not be ready for prime time; or they may
232 232 alter some usual behaviors of stock Mercurial. It is thus up to the user
233 233 to activate extensions as needed.
234 234
235 235 To explicitly disable an extension enabled in a configuration file of
236 236 broader scope, prepend its path with !:
237 237
238 238 [extensions]
239 239 # disabling extension bar residing in /path/to/extension/bar.py
240 240 bar = !/path/to/extension/bar.py
241 241 # ditto, but no path was supplied for extension baz
242 242 baz = !
243 243
244 244 enabled extensions:
245 245
246 246 children command to display child changesets (DEPRECATED)
247 247 rebase command to move sets of revisions to a different ancestor
248 248
249 249 disabled extensions:
250 250
251 251 acl hooks for controlling repository access
252 252 blackbox log repository events to a blackbox for debugging
253 253 bugzilla hooks for integrating with the Bugzilla bug tracker
254 254 censor erase file content at a given revision
255 255 churn command to display statistics about repository history
256 256 clonebundles advertise pre-generated bundles to seed clones
257 257 convert import revisions from foreign VCS repositories into
258 258 Mercurial
259 259 eol automatically manage newlines in repository files
260 260 extdiff command to allow external programs to compare revisions
261 261 factotum http authentication with factotum
262 262 gpg commands to sign and verify changesets
263 263 hgk browse the repository in a graphical way
264 264 highlight syntax highlighting for hgweb (requires Pygments)
265 265 histedit interactive history editing
266 266 keyword expand keywords in tracked files
267 267 largefiles track large binary files
268 268 mq manage a stack of patches
269 269 notify hooks for sending email push notifications
270 270 patchbomb command to send changesets as (a series of) patch emails
271 271 purge command to delete untracked files from the working
272 272 directory
273 273 relink recreates hardlinks between repository clones
274 274 schemes extend schemes with shortcuts to repository swarms
275 275 share share a common history between several working directories
276 276 shelve save and restore changes to the working directory
277 277 strip strip changesets and their descendants from history
278 278 transplant command to transplant changesets from another branch
279 279 win32mbcs allow the use of MBCS paths with problematic encodings
280 280 zeroconf discover and advertise repositories on the local network
281 281
282 282 Verify that extension keywords appear in help templates
283 283
284 284 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
285 285
286 286 Test short command list with verbose option
287 287
288 288 $ hg -v help shortlist
289 289 Mercurial Distributed SCM
290 290
291 291 basic commands:
292 292
293 293 add add the specified files on the next commit
294 294 annotate, blame
295 295 show changeset information by line for each file
296 296 clone make a copy of an existing repository
297 297 commit, ci commit the specified files or all outstanding changes
298 298 diff diff repository (or selected files)
299 299 export dump the header and diffs for one or more changesets
300 300 forget forget the specified files on the next commit
301 301 init create a new repository in the given directory
302 302 log, history show revision history of entire repository or files
303 303 merge merge another revision into working directory
304 304 pull pull changes from the specified source
305 305 push push changes to the specified destination
306 306 remove, rm remove the specified files on the next commit
307 307 serve start stand-alone webserver
308 308 status, st show changed files in the working directory
309 309 summary, sum summarize working directory state
310 310 update, up, checkout, co
311 311 update working directory (or switch revisions)
312 312
313 313 global options ([+] can be repeated):
314 314
315 315 -R --repository REPO repository root directory or name of overlay bundle
316 316 file
317 317 --cwd DIR change working directory
318 318 -y --noninteractive do not prompt, automatically pick the first choice for
319 319 all prompts
320 320 -q --quiet suppress output
321 321 -v --verbose enable additional output
322 322 --color TYPE when to colorize (boolean, always, auto, never, or
323 323 debug)
324 324 --config CONFIG [+] set/override config option (use 'section.name=value')
325 325 --debug enable debugging output
326 326 --debugger start debugger
327 327 --encoding ENCODE set the charset encoding (default: ascii)
328 328 --encodingmode MODE set the charset encoding mode (default: strict)
329 329 --traceback always print a traceback on exception
330 330 --time time how long the command takes
331 331 --profile print command execution profile
332 332 --version output version information and exit
333 333 -h --help display help and exit
334 334 --hidden consider hidden changesets
335 335 --pager TYPE when to paginate (boolean, always, auto, or never)
336 336 (default: auto)
337 337
338 338 (use 'hg help' for the full list of commands)
339 339
340 340 $ hg add -h
341 341 hg add [OPTION]... [FILE]...
342 342
343 343 add the specified files on the next commit
344 344
345 345 Schedule files to be version controlled and added to the repository.
346 346
347 347 The files will be added to the repository at the next commit. To undo an
348 348 add before that, see 'hg forget'.
349 349
350 350 If no names are given, add all files to the repository (except files
351 351 matching ".hgignore").
352 352
353 353 Returns 0 if all files are successfully added.
354 354
355 355 options ([+] can be repeated):
356 356
357 357 -I --include PATTERN [+] include names matching the given patterns
358 358 -X --exclude PATTERN [+] exclude names matching the given patterns
359 359 -S --subrepos recurse into subrepositories
360 360 -n --dry-run do not perform actions, just print output
361 361
362 362 (some details hidden, use --verbose to show complete help)
363 363
364 364 Verbose help for add
365 365
366 366 $ hg add -hv
367 367 hg add [OPTION]... [FILE]...
368 368
369 369 add the specified files on the next commit
370 370
371 371 Schedule files to be version controlled and added to the repository.
372 372
373 373 The files will be added to the repository at the next commit. To undo an
374 374 add before that, see 'hg forget'.
375 375
376 376 If no names are given, add all files to the repository (except files
377 377 matching ".hgignore").
378 378
379 379 Examples:
380 380
381 381 - New (unknown) files are added automatically by 'hg add':
382 382
383 383 $ ls
384 384 foo.c
385 385 $ hg status
386 386 ? foo.c
387 387 $ hg add
388 388 adding foo.c
389 389 $ hg status
390 390 A foo.c
391 391
392 392 - Specific files to be added can be specified:
393 393
394 394 $ ls
395 395 bar.c foo.c
396 396 $ hg status
397 397 ? bar.c
398 398 ? foo.c
399 399 $ hg add bar.c
400 400 $ hg status
401 401 A bar.c
402 402 ? foo.c
403 403
404 404 Returns 0 if all files are successfully added.
405 405
406 406 options ([+] can be repeated):
407 407
408 408 -I --include PATTERN [+] include names matching the given patterns
409 409 -X --exclude PATTERN [+] exclude names matching the given patterns
410 410 -S --subrepos recurse into subrepositories
411 411 -n --dry-run do not perform actions, just print output
412 412
413 413 global options ([+] can be repeated):
414 414
415 415 -R --repository REPO repository root directory or name of overlay bundle
416 416 file
417 417 --cwd DIR change working directory
418 418 -y --noninteractive do not prompt, automatically pick the first choice for
419 419 all prompts
420 420 -q --quiet suppress output
421 421 -v --verbose enable additional output
422 422 --color TYPE when to colorize (boolean, always, auto, never, or
423 423 debug)
424 424 --config CONFIG [+] set/override config option (use 'section.name=value')
425 425 --debug enable debugging output
426 426 --debugger start debugger
427 427 --encoding ENCODE set the charset encoding (default: ascii)
428 428 --encodingmode MODE set the charset encoding mode (default: strict)
429 429 --traceback always print a traceback on exception
430 430 --time time how long the command takes
431 431 --profile print command execution profile
432 432 --version output version information and exit
433 433 -h --help display help and exit
434 434 --hidden consider hidden changesets
435 435 --pager TYPE when to paginate (boolean, always, auto, or never)
436 436 (default: auto)
437 437
438 438 Test the textwidth config option
439 439
440 440 $ hg root -h --config ui.textwidth=50
441 441 hg root
442 442
443 443 print the root (top) of the current working
444 444 directory
445 445
446 446 Print the root directory of the current
447 447 repository.
448 448
449 449 Returns 0 on success.
450 450
451 451 (some details hidden, use --verbose to show
452 452 complete help)
453 453
454 454 Test help option with version option
455 455
456 456 $ hg add -h --version
457 457 Mercurial Distributed SCM (version *) (glob)
458 458 (see https://mercurial-scm.org for more information)
459 459
460 460 Copyright (C) 2005-* Matt Mackall and others (glob)
461 461 This is free software; see the source for copying conditions. There is NO
462 462 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
463 463
464 464 $ hg add --skjdfks
465 465 hg add: option --skjdfks not recognized
466 466 hg add [OPTION]... [FILE]...
467 467
468 468 add the specified files on the next commit
469 469
470 470 options ([+] can be repeated):
471 471
472 472 -I --include PATTERN [+] include names matching the given patterns
473 473 -X --exclude PATTERN [+] exclude names matching the given patterns
474 474 -S --subrepos recurse into subrepositories
475 475 -n --dry-run do not perform actions, just print output
476 476
477 477 (use 'hg add -h' to show more help)
478 478 [255]
479 479
480 480 Test ambiguous command help
481 481
482 482 $ hg help ad
483 483 list of commands:
484 484
485 485 add add the specified files on the next commit
486 486 addremove add all new files, delete all missing files
487 487
488 488 (use 'hg help -v ad' to show built-in aliases and global options)
489 489
490 490 Test command without options
491 491
492 492 $ hg help verify
493 493 hg verify
494 494
495 495 verify the integrity of the repository
496 496
497 497 Verify the integrity of the current repository.
498 498
499 499 This will perform an extensive check of the repository's integrity,
500 500 validating the hashes and checksums of each entry in the changelog,
501 501 manifest, and tracked files, as well as the integrity of their crosslinks
502 502 and indices.
503 503
504 504 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
505 505 information about recovery from corruption of the repository.
506 506
507 507 Returns 0 on success, 1 if errors are encountered.
508 508
509 509 (some details hidden, use --verbose to show complete help)
510 510
511 511 $ hg help diff
512 512 hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
513 513
514 514 diff repository (or selected files)
515 515
516 516 Show differences between revisions for the specified files.
517 517
518 518 Differences between files are shown using the unified diff format.
519 519
520 520 Note:
521 521 'hg diff' may generate unexpected results for merges, as it will
522 522 default to comparing against the working directory's first parent
523 523 changeset if no revisions are specified.
524 524
525 525 When two revision arguments are given, then changes are shown between
526 526 those revisions. If only one revision is specified then that revision is
527 527 compared to the working directory, and, when no revisions are specified,
528 528 the working directory files are compared to its first parent.
529 529
530 530 Alternatively you can specify -c/--change with a revision to see the
531 531 changes in that changeset relative to its first parent.
532 532
533 533 Without the -a/--text option, diff will avoid generating diffs of files it
534 534 detects as binary. With -a, diff will generate a diff anyway, probably
535 535 with undesirable results.
536 536
537 537 Use the -g/--git option to generate diffs in the git extended diff format.
538 538 For more information, read 'hg help diffs'.
539 539
540 540 Returns 0 on success.
541 541
542 542 options ([+] can be repeated):
543 543
544 544 -r --rev REV [+] revision
545 545 -c --change REV change made by revision
546 546 -a --text treat all files as text
547 547 -g --git use git extended diff format
548 548 --binary generate binary diffs in git mode (default)
549 549 --nodates omit dates from diff headers
550 550 --noprefix omit a/ and b/ prefixes from filenames
551 551 -p --show-function show which function each change is in
552 552 --reverse produce a diff that undoes the changes
553 553 -w --ignore-all-space ignore white space when comparing lines
554 554 -b --ignore-space-change ignore changes in the amount of white space
555 555 -B --ignore-blank-lines ignore changes whose lines are all blank
556 556 -Z --ignore-space-at-eol ignore changes in whitespace at EOL
557 557 -U --unified NUM number of lines of context to show
558 558 --stat output diffstat-style summary of changes
559 559 --root DIR produce diffs relative to subdirectory
560 560 -I --include PATTERN [+] include names matching the given patterns
561 561 -X --exclude PATTERN [+] exclude names matching the given patterns
562 562 -S --subrepos recurse into subrepositories
563 563
564 564 (some details hidden, use --verbose to show complete help)
565 565
566 566 $ hg help status
567 567 hg status [OPTION]... [FILE]...
568 568
569 569 aliases: st
570 570
571 571 show changed files in the working directory
572 572
573 573 Show status of files in the repository. If names are given, only files
574 574 that match are shown. Files that are clean or ignored or the source of a
575 575 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
576 576 -C/--copies or -A/--all are given. Unless options described with "show
577 577 only ..." are given, the options -mardu are used.
578 578
579 579 Option -q/--quiet hides untracked (unknown and ignored) files unless
580 580 explicitly requested with -u/--unknown or -i/--ignored.
581 581
582 582 Note:
583 583 'hg status' may appear to disagree with diff if permissions have
584 584 changed or a merge has occurred. The standard diff format does not
585 585 report permission changes and diff only reports changes relative to one
586 586 merge parent.
587 587
588 588 If one revision is given, it is used as the base revision. If two
589 589 revisions are given, the differences between them are shown. The --change
590 590 option can also be used as a shortcut to list the changed files of a
591 591 revision from its first parent.
592 592
593 593 The codes used to show the status of files are:
594 594
595 595 M = modified
596 596 A = added
597 597 R = removed
598 598 C = clean
599 599 ! = missing (deleted by non-hg command, but still tracked)
600 600 ? = not tracked
601 601 I = ignored
602 602 = origin of the previous file (with --copies)
603 603
604 604 Returns 0 on success.
605 605
606 606 options ([+] can be repeated):
607 607
608 608 -A --all show status of all files
609 609 -m --modified show only modified files
610 610 -a --added show only added files
611 611 -r --removed show only removed files
612 612 -d --deleted show only deleted (but tracked) files
613 613 -c --clean show only files without changes
614 614 -u --unknown show only unknown (not tracked) files
615 615 -i --ignored show only ignored files
616 616 -n --no-status hide status prefix
617 617 -C --copies show source of copied files
618 618 -0 --print0 end filenames with NUL, for use with xargs
619 619 --rev REV [+] show difference from revision
620 620 --change REV list the changed files of a revision
621 621 -I --include PATTERN [+] include names matching the given patterns
622 622 -X --exclude PATTERN [+] exclude names matching the given patterns
623 623 -S --subrepos recurse into subrepositories
624 624
625 625 (some details hidden, use --verbose to show complete help)
626 626
627 627 $ hg -q help status
628 628 hg status [OPTION]... [FILE]...
629 629
630 630 show changed files in the working directory
631 631
632 632 $ hg help foo
633 633 abort: no such help topic: foo
634 634 (try 'hg help --keyword foo')
635 635 [255]
636 636
637 637 $ hg skjdfks
638 638 hg: unknown command 'skjdfks'
639 639 Mercurial Distributed SCM
640 640
641 641 basic commands:
642 642
643 643 add add the specified files on the next commit
644 644 annotate show changeset information by line for each file
645 645 clone make a copy of an existing repository
646 646 commit commit the specified files or all outstanding changes
647 647 diff diff repository (or selected files)
648 648 export dump the header and diffs for one or more changesets
649 649 forget forget the specified files on the next commit
650 650 init create a new repository in the given directory
651 651 log show revision history of entire repository or files
652 652 merge merge another revision into working directory
653 653 pull pull changes from the specified source
654 654 push push changes to the specified destination
655 655 remove remove the specified files on the next commit
656 656 serve start stand-alone webserver
657 657 status show changed files in the working directory
658 658 summary summarize working directory state
659 659 update update working directory (or switch revisions)
660 660
661 661 (use 'hg help' for the full list of commands or 'hg -v' for details)
662 662 [255]
663 663
664 664 Typoed command gives suggestion
665 665 $ hg puls
666 666 hg: unknown command 'puls'
667 667 (did you mean one of pull, push?)
668 668 [255]
669 669
670 670 Not enabled extension gets suggested
671 671
672 672 $ hg rebase
673 673 hg: unknown command 'rebase'
674 674 'rebase' is provided by the following extension:
675 675
676 676 rebase command to move sets of revisions to a different ancestor
677 677
678 678 (use 'hg help extensions' for information on enabling extensions)
679 679 [255]
680 680
681 681 Disabled extension gets suggested
682 682 $ hg --config extensions.rebase=! rebase
683 683 hg: unknown command 'rebase'
684 684 'rebase' is provided by the following extension:
685 685
686 686 rebase command to move sets of revisions to a different ancestor
687 687
688 688 (use 'hg help extensions' for information on enabling extensions)
689 689 [255]
690 690
691 691 Make sure that we don't run afoul of the help system thinking that
692 692 this is a section and erroring out weirdly.
693 693
694 694 $ hg .log
695 695 hg: unknown command '.log'
696 696 (did you mean log?)
697 697 [255]
698 698
699 699 $ hg log.
700 700 hg: unknown command 'log.'
701 701 (did you mean log?)
702 702 [255]
703 703 $ hg pu.lh
704 704 hg: unknown command 'pu.lh'
705 705 (did you mean one of pull, push?)
706 706 [255]
707 707
708 708 $ cat > helpext.py <<EOF
709 709 > import os
710 710 > from mercurial import commands, registrar
711 711 >
712 712 > cmdtable = {}
713 713 > command = registrar.command(cmdtable)
714 714 >
715 715 > @command(b'nohelp',
716 716 > [(b'', b'longdesc', 3, b'x'*90),
717 717 > (b'n', b'', None, b'normal desc'),
718 718 > (b'', b'newline', b'', b'line1\nline2')],
719 719 > b'hg nohelp',
720 720 > norepo=True)
721 721 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
722 722 > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
723 723 > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
724 724 > def nohelp(ui, *args, **kwargs):
725 725 > pass
726 726 >
727 727 > def uisetup(ui):
728 728 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
729 729 > ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
730 730 >
731 731 > EOF
732 732 $ echo '[extensions]' >> $HGRCPATH
733 733 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
734 734
735 735 Test for aliases
736 736
737 737 $ hg help hgalias
738 738 hg hgalias [--remote]
739 739
740 740 alias for: hg summary
741 741
742 742 summarize working directory state
743 743
744 744 This generates a brief summary of the working directory state, including
745 745 parents, branch, commit status, phase and available updates.
746 746
747 747 With the --remote option, this will check the default paths for incoming
748 748 and outgoing changes. This can be time-consuming.
749 749
750 750 Returns 0 on success.
751 751
752 752 defined by: helpext
753 753
754 754 options:
755 755
756 756 --remote check for push and pull
757 757
758 758 (some details hidden, use --verbose to show complete help)
759 759
760 760 $ hg help shellalias
761 761 hg shellalias
762 762
763 763 shell alias for:
764 764
765 765 echo hi
766 766
767 767 defined by: helpext
768 768
769 769 (some details hidden, use --verbose to show complete help)
770 770
771 771 Test command with no help text
772 772
773 773 $ hg help nohelp
774 774 hg nohelp
775 775
776 776 (no help text available)
777 777
778 778 options:
779 779
780 780 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
781 781 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
782 782 -n -- normal desc
783 783 --newline VALUE line1 line2
784 784
785 785 (some details hidden, use --verbose to show complete help)
786 786
787 787 $ hg help -k nohelp
788 788 Commands:
789 789
790 790 nohelp hg nohelp
791 791
792 792 Extension Commands:
793 793
794 794 nohelp (no help text available)
795 795
796 796 Test that default list of commands omits extension commands
797 797
798 798 $ hg help
799 799 Mercurial Distributed SCM
800 800
801 801 list of commands:
802 802
803 803 add add the specified files on the next commit
804 804 addremove add all new files, delete all missing files
805 805 annotate show changeset information by line for each file
806 806 archive create an unversioned archive of a repository revision
807 807 backout reverse effect of earlier changeset
808 808 bisect subdivision search of changesets
809 809 bookmarks create a new bookmark or list existing bookmarks
810 810 branch set or show the current branch name
811 811 branches list repository named branches
812 812 bundle create a bundle file
813 813 cat output the current or given revision of files
814 814 clone make a copy of an existing repository
815 815 commit commit the specified files or all outstanding changes
816 816 config show combined config settings from all hgrc files
817 817 copy mark files as copied for the next commit
818 818 diff diff repository (or selected files)
819 819 export dump the header and diffs for one or more changesets
820 820 files list tracked files
821 821 forget forget the specified files on the next commit
822 822 graft copy changes from other branches onto the current branch
823 823 grep search revision history for a pattern in specified files
824 824 heads show branch heads
825 825 help show help for a given topic or a help overview
826 826 identify identify the working directory or specified revision
827 827 import import an ordered set of patches
828 828 incoming show new changesets found in source
829 829 init create a new repository in the given directory
830 830 log show revision history of entire repository or files
831 831 manifest output the current or given revision of the project manifest
832 832 merge merge another revision into working directory
833 833 outgoing show changesets not found in the destination
834 834 paths show aliases for remote repositories
835 835 phase set or show the current phase name
836 836 pull pull changes from the specified source
837 837 push push changes to the specified destination
838 838 recover roll back an interrupted transaction
839 839 remove remove the specified files on the next commit
840 840 rename rename files; equivalent of copy + remove
841 841 resolve redo merges or set/view the merge status of files
842 842 revert restore files to their checkout state
843 843 root print the root (top) of the current working directory
844 844 serve start stand-alone webserver
845 845 status show changed files in the working directory
846 846 summary summarize working directory state
847 847 tag add one or more tags for the current or given revision
848 848 tags list repository tags
849 849 unbundle apply one or more bundle files
850 850 update update working directory (or switch revisions)
851 851 verify verify the integrity of the repository
852 852 version output version and copyright information
853 853
854 854 enabled extensions:
855 855
856 856 helpext (no help text available)
857 857
858 858 additional help topics:
859 859
860 860 bundlespec Bundle File Formats
861 861 color Colorizing Outputs
862 862 config Configuration Files
863 863 dates Date Formats
864 864 diffs Diff Formats
865 865 environment Environment Variables
866 866 extensions Using Additional Features
867 867 filesets Specifying File Sets
868 868 glossary Glossary
869 869 hgignore Syntax for Mercurial Ignore Files
870 870 hgweb Configuring hgweb
871 871 internals Technical implementation topics
872 872 merge-tools Merge Tools
873 873 pager Pager Support
874 874 patterns File Name Patterns
875 875 phases Working with Phases
876 876 revisions Specifying Revisions
877 877 scripting Using Mercurial from scripts and automation
878 878 subrepos Subrepositories
879 879 templating Template Usage
880 880 urls URL Paths
881 881
882 882 (use 'hg help -v' to show built-in aliases and global options)
883 883
884 884
885 885 Test list of internal help commands
886 886
887 887 $ hg help debug
888 888 debug commands (internal and unsupported):
889 889
890 890 debugancestor
891 891 find the ancestor revision of two revisions in a given index
892 892 debugapplystreamclonebundle
893 893 apply a stream clone bundle file
894 894 debugbuilddag
895 895 builds a repo with a given DAG from scratch in the current
896 896 empty repo
897 897 debugbundle lists the contents of a bundle
898 898 debugcheckstate
899 899 validate the correctness of the current dirstate
900 900 debugcolor show available color, effects or style
901 901 debugcommands
902 902 list all available commands and options
903 903 debugcomplete
904 904 returns the completion list associated with the given command
905 905 debugcreatestreamclonebundle
906 906 create a stream clone bundle file
907 907 debugdag format the changelog or an index DAG as a concise textual
908 908 description
909 909 debugdata dump the contents of a data file revision
910 910 debugdate parse and display a date
911 911 debugdeltachain
912 912 dump information about delta chains in a revlog
913 913 debugdirstate
914 914 show the contents of the current dirstate
915 915 debugdiscovery
916 916 runs the changeset discovery protocol in isolation
917 917 debugextensions
918 918 show information about active extensions
919 919 debugfileset parse and apply a fileset specification
920 920 debugfsinfo show information detected about current filesystem
921 921 debuggetbundle
922 922 retrieves a bundle from a repo
923 923 debugignore display the combined ignore pattern and information about
924 924 ignored files
925 925 debugindex dump the contents of an index file
926 926 debugindexdot
927 927 dump an index DAG as a graphviz dot file
928 928 debuginstall test Mercurial installation
929 929 debugknown test whether node ids are known to a repo
930 930 debuglocks show or modify state of locks
931 931 debugmergestate
932 932 print merge state
933 933 debugnamecomplete
934 934 complete "names" - tags, open branch names, bookmark names
935 935 debugobsolete
936 936 create arbitrary obsolete marker
937 937 debugoptADV (no help text available)
938 938 debugoptDEP (no help text available)
939 939 debugoptEXP (no help text available)
940 940 debugpathcomplete
941 941 complete part or all of a tracked path
942 942 debugpickmergetool
943 943 examine which merge tool is chosen for specified file
944 944 debugpushkey access the pushkey key/value protocol
945 945 debugpvec (no help text available)
946 946 debugrebuilddirstate
947 947 rebuild the dirstate as it would look like for the given
948 948 revision
949 949 debugrebuildfncache
950 950 rebuild the fncache file
951 951 debugrename dump rename information
952 952 debugrevlog show data and statistics about a revlog
953 953 debugrevspec parse and apply a revision specification
954 954 debugsetparents
955 955 manually set the parents of the current working directory
956 956 debugssl test a secure connection to a server
957 957 debugsub (no help text available)
958 958 debugsuccessorssets
959 959 show set of successors for revision
960 960 debugtemplate
961 961 parse and apply a template
962 962 debugupdatecaches
963 963 warm all known caches in the repository
964 964 debugupgraderepo
965 965 upgrade a repository to use different features
966 966 debugwalk show how files match on given patterns
967 967 debugwireargs
968 968 (no help text available)
969 969
970 970 (use 'hg help -v debug' to show built-in aliases and global options)
971 971
972 972 internals topic renders index of available sub-topics
973 973
974 974 $ hg help internals
975 975 Technical implementation topics
976 976 """""""""""""""""""""""""""""""
977 977
978 978 To access a subtopic, use "hg help internals.{subtopic-name}"
979 979
980 980 bundles Bundles
981 981 censor Censor
982 982 changegroups Changegroups
983 983 config Config Register
984 984 requirements Repository Requirements
985 985 revlogs Revision Logs
986 986 wireprotocol Wire Protocol
987 987
988 988 sub-topics can be accessed
989 989
990 990 $ hg help internals.changegroups
991 991 Changegroups
992 992 """"""""""""
993 993
994 994 Changegroups are representations of repository revlog data, specifically
995 995 the changelog data, root/flat manifest data, treemanifest data, and
996 996 filelogs.
997 997
998 998 There are 3 versions of changegroups: "1", "2", and "3". From a high-
999 999 level, versions "1" and "2" are almost exactly the same, with the only
1000 1000 difference being an additional item in the *delta header*. Version "3"
1001 1001 adds support for revlog flags in the *delta header* and optionally
1002 1002 exchanging treemanifests (enabled by setting an option on the
1003 1003 "changegroup" part in the bundle2).
1004 1004
1005 1005 Changegroups when not exchanging treemanifests consist of 3 logical
1006 1006 segments:
1007 1007
1008 1008 +---------------------------------+
1009 1009 | | | |
1010 1010 | changeset | manifest | filelogs |
1011 1011 | | | |
1012 1012 | | | |
1013 1013 +---------------------------------+
1014 1014
1015 1015 When exchanging treemanifests, there are 4 logical segments:
1016 1016
1017 1017 +-------------------------------------------------+
1018 1018 | | | | |
1019 1019 | changeset | root | treemanifests | filelogs |
1020 1020 | | manifest | | |
1021 1021 | | | | |
1022 1022 +-------------------------------------------------+
1023 1023
1024 1024 The principle building block of each segment is a *chunk*. A *chunk* is a
1025 1025 framed piece of data:
1026 1026
1027 1027 +---------------------------------------+
1028 1028 | | |
1029 1029 | length | data |
1030 1030 | (4 bytes) | (<length - 4> bytes) |
1031 1031 | | |
1032 1032 +---------------------------------------+
1033 1033
1034 1034 All integers are big-endian signed integers. Each chunk starts with a
1035 1035 32-bit integer indicating the length of the entire chunk (including the
1036 1036 length field itself).
1037 1037
1038 1038 There is a special case chunk that has a value of 0 for the length
1039 1039 ("0x00000000"). We call this an *empty chunk*.
1040 1040
1041 1041 Delta Groups
1042 1042 ============
1043 1043
1044 1044 A *delta group* expresses the content of a revlog as a series of deltas,
1045 1045 or patches against previous revisions.
1046 1046
1047 1047 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1048 1048 to signal the end of the delta group:
1049 1049
1050 1050 +------------------------------------------------------------------------+
1051 1051 | | | | | |
1052 1052 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
1053 1053 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
1054 1054 | | | | | |
1055 1055 +------------------------------------------------------------------------+
1056 1056
1057 1057 Each *chunk*'s data consists of the following:
1058 1058
1059 1059 +---------------------------------------+
1060 1060 | | |
1061 1061 | delta header | delta data |
1062 1062 | (various by version) | (various) |
1063 1063 | | |
1064 1064 +---------------------------------------+
1065 1065
1066 1066 The *delta data* is a series of *delta*s that describe a diff from an
1067 1067 existing entry (either that the recipient already has, or previously
1068 1068 specified in the bundle/changegroup).
1069 1069
1070 1070 The *delta header* is different between versions "1", "2", and "3" of the
1071 1071 changegroup format.
1072 1072
1073 1073 Version 1 (headerlen=80):
1074 1074
1075 1075 +------------------------------------------------------+
1076 1076 | | | | |
1077 1077 | node | p1 node | p2 node | link node |
1078 1078 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1079 1079 | | | | |
1080 1080 +------------------------------------------------------+
1081 1081
1082 1082 Version 2 (headerlen=100):
1083 1083
1084 1084 +------------------------------------------------------------------+
1085 1085 | | | | | |
1086 1086 | node | p1 node | p2 node | base node | link node |
1087 1087 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1088 1088 | | | | | |
1089 1089 +------------------------------------------------------------------+
1090 1090
1091 1091 Version 3 (headerlen=102):
1092 1092
1093 1093 +------------------------------------------------------------------------------+
1094 1094 | | | | | | |
1095 1095 | node | p1 node | p2 node | base node | link node | flags |
1096 1096 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
1097 1097 | | | | | | |
1098 1098 +------------------------------------------------------------------------------+
1099 1099
1100 1100 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
1101 1101 contain a series of *delta*s, densely packed (no separators). These deltas
1102 1102 describe a diff from an existing entry (either that the recipient already
1103 1103 has, or previously specified in the bundle/changegroup). The format is
1104 1104 described more fully in "hg help internals.bdiff", but briefly:
1105 1105
1106 1106 +---------------------------------------------------------------+
1107 1107 | | | | |
1108 1108 | start offset | end offset | new length | content |
1109 1109 | (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
1110 1110 | | | | |
1111 1111 +---------------------------------------------------------------+
1112 1112
1113 1113 Please note that the length field in the delta data does *not* include
1114 1114 itself.
1115 1115
1116 1116 In version 1, the delta is always applied against the previous node from
1117 1117 the changegroup or the first parent if this is the first entry in the
1118 1118 changegroup.
1119 1119
1120 1120 In version 2 and up, the delta base node is encoded in the entry in the
1121 1121 changegroup. This allows the delta to be expressed against any parent,
1122 1122 which can result in smaller deltas and more efficient encoding of data.
1123 1123
1124 1124 Changeset Segment
1125 1125 =================
1126 1126
1127 1127 The *changeset segment* consists of a single *delta group* holding
1128 1128 changelog data. The *empty chunk* at the end of the *delta group* denotes
1129 1129 the boundary to the *manifest segment*.
1130 1130
1131 1131 Manifest Segment
1132 1132 ================
1133 1133
1134 1134 The *manifest segment* consists of a single *delta group* holding manifest
1135 1135 data. If treemanifests are in use, it contains only the manifest for the
1136 1136 root directory of the repository. Otherwise, it contains the entire
1137 1137 manifest data. The *empty chunk* at the end of the *delta group* denotes
1138 1138 the boundary to the next segment (either the *treemanifests segment* or
1139 1139 the *filelogs segment*, depending on version and the request options).
1140 1140
1141 1141 Treemanifests Segment
1142 1142 ---------------------
1143 1143
1144 1144 The *treemanifests segment* only exists in changegroup version "3", and
1145 1145 only if the 'treemanifest' param is part of the bundle2 changegroup part
1146 1146 (it is not possible to use changegroup version 3 outside of bundle2).
1147 1147 Aside from the filenames in the *treemanifests segment* containing a
1148 1148 trailing "/" character, it behaves identically to the *filelogs segment*
1149 1149 (see below). The final sub-segment is followed by an *empty chunk*
1150 1150 (logically, a sub-segment with filename size 0). This denotes the boundary
1151 1151 to the *filelogs segment*.
1152 1152
1153 1153 Filelogs Segment
1154 1154 ================
1155 1155
1156 1156 The *filelogs segment* consists of multiple sub-segments, each
1157 1157 corresponding to an individual file whose data is being described:
1158 1158
1159 1159 +--------------------------------------------------+
1160 1160 | | | | | |
1161 1161 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
1162 1162 | | | | | (4 bytes) |
1163 1163 | | | | | |
1164 1164 +--------------------------------------------------+
1165 1165
1166 1166 The final filelog sub-segment is followed by an *empty chunk* (logically,
1167 1167 a sub-segment with filename size 0). This denotes the end of the segment
1168 1168 and of the overall changegroup.
1169 1169
1170 1170 Each filelog sub-segment consists of the following:
1171 1171
1172 1172 +------------------------------------------------------+
1173 1173 | | | |
1174 1174 | filename length | filename | delta group |
1175 1175 | (4 bytes) | (<length - 4> bytes) | (various) |
1176 1176 | | | |
1177 1177 +------------------------------------------------------+
1178 1178
1179 1179 That is, a *chunk* consisting of the filename (not terminated or padded)
1180 1180 followed by N chunks constituting the *delta group* for this file. The
1181 1181 *empty chunk* at the end of each *delta group* denotes the boundary to the
1182 1182 next filelog sub-segment.
1183 1183
1184 1184 Test list of commands with command with no help text
1185 1185
1186 1186 $ hg help helpext
1187 1187 helpext extension - no help text available
1188 1188
1189 1189 list of commands:
1190 1190
1191 1191 nohelp (no help text available)
1192 1192
1193 1193 (use 'hg help -v helpext' to show built-in aliases and global options)
1194 1194
1195 1195
1196 1196 test advanced, deprecated and experimental options are hidden in command help
1197 1197 $ hg help debugoptADV
1198 1198 hg debugoptADV
1199 1199
1200 1200 (no help text available)
1201 1201
1202 1202 options:
1203 1203
1204 1204 (some details hidden, use --verbose to show complete help)
1205 1205 $ hg help debugoptDEP
1206 1206 hg debugoptDEP
1207 1207
1208 1208 (no help text available)
1209 1209
1210 1210 options:
1211 1211
1212 1212 (some details hidden, use --verbose to show complete help)
1213 1213
1214 1214 $ hg help debugoptEXP
1215 1215 hg debugoptEXP
1216 1216
1217 1217 (no help text available)
1218 1218
1219 1219 options:
1220 1220
1221 1221 (some details hidden, use --verbose to show complete help)
1222 1222
1223 1223 test advanced, deprecated and experimental options are shown with -v
1224 1224 $ hg help -v debugoptADV | grep aopt
1225 1225 --aopt option is (ADVANCED)
1226 1226 $ hg help -v debugoptDEP | grep dopt
1227 1227 --dopt option is (DEPRECATED)
1228 1228 $ hg help -v debugoptEXP | grep eopt
1229 1229 --eopt option is (EXPERIMENTAL)
1230 1230
1231 1231 #if gettext
1232 1232 test deprecated option is hidden with translation with untranslated description
1233 1233 (use many globy for not failing on changed transaction)
1234 1234 $ LANGUAGE=sv hg help debugoptDEP
1235 1235 hg debugoptDEP
1236 1236
1237 1237 (*) (glob)
1238 1238
1239 1239 options:
1240 1240
1241 1241 (some details hidden, use --verbose to show complete help)
1242 1242 #endif
1243 1243
1244 1244 Test commands that collide with topics (issue4240)
1245 1245
1246 1246 $ hg config -hq
1247 1247 hg config [-u] [NAME]...
1248 1248
1249 1249 show combined config settings from all hgrc files
1250 1250 $ hg showconfig -hq
1251 1251 hg config [-u] [NAME]...
1252 1252
1253 1253 show combined config settings from all hgrc files
1254 1254
1255 1255 Test a help topic
1256 1256
1257 1257 $ hg help dates
1258 1258 Date Formats
1259 1259 """"""""""""
1260 1260
1261 1261 Some commands allow the user to specify a date, e.g.:
1262 1262
1263 1263 - backout, commit, import, tag: Specify the commit date.
1264 1264 - log, revert, update: Select revision(s) by date.
1265 1265
1266 1266 Many date formats are valid. Here are some examples:
1267 1267
1268 1268 - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
1269 1269 - "Dec 6 13:18 -0600" (year assumed, time offset provided)
1270 1270 - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
1271 1271 - "Dec 6" (midnight)
1272 1272 - "13:18" (today assumed)
1273 1273 - "3:39" (3:39AM assumed)
1274 1274 - "3:39pm" (15:39)
1275 1275 - "2006-12-06 13:18:29" (ISO 8601 format)
1276 1276 - "2006-12-6 13:18"
1277 1277 - "2006-12-6"
1278 1278 - "12-6"
1279 1279 - "12/6"
1280 1280 - "12/6/6" (Dec 6 2006)
1281 1281 - "today" (midnight)
1282 1282 - "yesterday" (midnight)
1283 1283 - "now" - right now
1284 1284
1285 1285 Lastly, there is Mercurial's internal format:
1286 1286
1287 1287 - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
1288 1288
1289 1289 This is the internal representation format for dates. The first number is
1290 1290 the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
1291 1291 is the offset of the local timezone, in seconds west of UTC (negative if
1292 1292 the timezone is east of UTC).
1293 1293
1294 1294 The log command also accepts date ranges:
1295 1295
1296 1296 - "<DATE" - at or before a given date/time
1297 1297 - ">DATE" - on or after a given date/time
1298 1298 - "DATE to DATE" - a date range, inclusive
1299 1299 - "-DAYS" - within a given number of days of today
1300 1300
1301 1301 Test repeated config section name
1302 1302
1303 1303 $ hg help config.host
1304 1304 "http_proxy.host"
1305 1305 Host name and (optional) port of the proxy server, for example
1306 1306 "myproxy:8000".
1307 1307
1308 1308 "smtp.host"
1309 1309 Host name of mail server, e.g. "mail.example.com".
1310 1310
1311 1311 Unrelated trailing paragraphs shouldn't be included
1312 1312
1313 1313 $ hg help config.extramsg | grep '^$'
1314 1314
1315 1315
1316 1316 Test capitalized section name
1317 1317
1318 1318 $ hg help scripting.HGPLAIN > /dev/null
1319 1319
1320 1320 Help subsection:
1321 1321
1322 1322 $ hg help config.charsets |grep "Email example:" > /dev/null
1323 1323 [1]
1324 1324
1325 1325 Show nested definitions
1326 1326 ("profiling.type"[break]"ls"[break]"stat"[break])
1327 1327
1328 1328 $ hg help config.type | egrep '^$'|wc -l
1329 1329 \s*3 (re)
1330 1330
1331 1331 Separate sections from subsections
1332 1332
1333 1333 $ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
1334 1334 "format"
1335 1335 --------
1336 1336
1337 1337 "usegeneraldelta"
1338 1338
1339 1339 "dotencode"
1340 1340
1341 1341 "usefncache"
1342 1342
1343 1343 "usestore"
1344 1344
1345 1345 "profiling"
1346 1346 -----------
1347 1347
1348 1348 "format"
1349 1349
1350 1350 "progress"
1351 1351 ----------
1352 1352
1353 1353 "format"
1354 1354
1355 1355
1356 1356 Last item in help config.*:
1357 1357
1358 1358 $ hg help config.`hg help config|grep '^ "'| \
1359 1359 > tail -1|sed 's![ "]*!!g'`| \
1360 1360 > grep 'hg help -c config' > /dev/null
1361 1361 [1]
1362 1362
1363 1363 note to use help -c for general hg help config:
1364 1364
1365 1365 $ hg help config |grep 'hg help -c config' > /dev/null
1366 1366
1367 1367 Test templating help
1368 1368
1369 1369 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1370 1370 desc String. The text of the changeset description.
1371 1371 diffstat String. Statistics of changes with the following format:
1372 1372 firstline Any text. Returns the first line of text.
1373 1373 nonempty Any text. Returns '(none)' if the string is empty.
1374 1374
1375 1375 Test deprecated items
1376 1376
1377 1377 $ hg help -v templating | grep currentbookmark
1378 1378 currentbookmark
1379 1379 $ hg help templating | (grep currentbookmark || true)
1380 1380
1381 1381 Test help hooks
1382 1382
1383 1383 $ cat > helphook1.py <<EOF
1384 1384 > from mercurial import help
1385 1385 >
1386 1386 > def rewrite(ui, topic, doc):
1387 1387 > return doc + '\nhelphook1\n'
1388 1388 >
1389 1389 > def extsetup(ui):
1390 1390 > help.addtopichook('revisions', rewrite)
1391 1391 > EOF
1392 1392 $ cat > helphook2.py <<EOF
1393 1393 > from mercurial import help
1394 1394 >
1395 1395 > def rewrite(ui, topic, doc):
1396 1396 > return doc + '\nhelphook2\n'
1397 1397 >
1398 1398 > def extsetup(ui):
1399 1399 > help.addtopichook('revisions', rewrite)
1400 1400 > EOF
1401 1401 $ echo '[extensions]' >> $HGRCPATH
1402 1402 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1403 1403 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1404 1404 $ hg help revsets | grep helphook
1405 1405 helphook1
1406 1406 helphook2
1407 1407
1408 1408 help -c should only show debug --debug
1409 1409
1410 1410 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1411 1411 [1]
1412 1412
1413 1413 help -c should only show deprecated for -v
1414 1414
1415 1415 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1416 1416 [1]
1417 1417
1418 1418 Test -s / --system
1419 1419
1420 1420 $ hg help config.files -s windows |grep 'etc/mercurial' | \
1421 1421 > wc -l | sed -e 's/ //g'
1422 1422 0
1423 1423 $ hg help config.files --system unix | grep 'USER' | \
1424 1424 > wc -l | sed -e 's/ //g'
1425 1425 0
1426 1426
1427 1427 Test -e / -c / -k combinations
1428 1428
1429 1429 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1430 1430 Commands:
1431 1431 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1432 1432 Extensions:
1433 1433 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1434 1434 Topics:
1435 1435 Commands:
1436 1436 Extensions:
1437 1437 Extension Commands:
1438 1438 $ hg help -c schemes
1439 1439 abort: no such help topic: schemes
1440 1440 (try 'hg help --keyword schemes')
1441 1441 [255]
1442 1442 $ hg help -e schemes |head -1
1443 1443 schemes extension - extend schemes with shortcuts to repository swarms
1444 1444 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1445 1445 Commands:
1446 1446 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1447 1447 Extensions:
1448 1448 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1449 1449 Extensions:
1450 1450 Commands:
1451 1451 $ hg help -c commit > /dev/null
1452 1452 $ hg help -e -c commit > /dev/null
1453 1453 $ hg help -e commit > /dev/null
1454 1454 abort: no such help topic: commit
1455 1455 (try 'hg help --keyword commit')
1456 1456 [255]
1457 1457
1458 1458 Test keyword search help
1459 1459
1460 1460 $ cat > prefixedname.py <<EOF
1461 1461 > '''matched against word "clone"
1462 1462 > '''
1463 1463 > EOF
1464 1464 $ echo '[extensions]' >> $HGRCPATH
1465 1465 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1466 1466 $ hg help -k clone
1467 1467 Topics:
1468 1468
1469 1469 config Configuration Files
1470 1470 extensions Using Additional Features
1471 1471 glossary Glossary
1472 1472 phases Working with Phases
1473 1473 subrepos Subrepositories
1474 1474 urls URL Paths
1475 1475
1476 1476 Commands:
1477 1477
1478 1478 bookmarks create a new bookmark or list existing bookmarks
1479 1479 clone make a copy of an existing repository
1480 1480 paths show aliases for remote repositories
1481 1481 update update working directory (or switch revisions)
1482 1482
1483 1483 Extensions:
1484 1484
1485 1485 clonebundles advertise pre-generated bundles to seed clones
1486 1486 prefixedname matched against word "clone"
1487 1487 relink recreates hardlinks between repository clones
1488 1488
1489 1489 Extension Commands:
1490 1490
1491 1491 qclone clone main and patch repository at same time
1492 1492
1493 1493 Test unfound topic
1494 1494
1495 1495 $ hg help nonexistingtopicthatwillneverexisteverever
1496 1496 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1497 1497 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
1498 1498 [255]
1499 1499
1500 1500 Test unfound keyword
1501 1501
1502 1502 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1503 1503 abort: no matches
1504 1504 (try 'hg help' for a list of topics)
1505 1505 [255]
1506 1506
1507 1507 Test omit indicating for help
1508 1508
1509 1509 $ cat > addverboseitems.py <<EOF
1510 1510 > '''extension to test omit indicating.
1511 1511 >
1512 1512 > This paragraph is never omitted (for extension)
1513 1513 >
1514 1514 > .. container:: verbose
1515 1515 >
1516 1516 > This paragraph is omitted,
1517 1517 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1518 1518 >
1519 1519 > This paragraph is never omitted, too (for extension)
1520 1520 > '''
1521 1521 > from __future__ import absolute_import
1522 1522 > from mercurial import commands, help
1523 1523 > testtopic = """This paragraph is never omitted (for topic).
1524 1524 >
1525 1525 > .. container:: verbose
1526 1526 >
1527 1527 > This paragraph is omitted,
1528 1528 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1529 1529 >
1530 1530 > This paragraph is never omitted, too (for topic)
1531 1531 > """
1532 1532 > def extsetup(ui):
1533 1533 > help.helptable.append((["topic-containing-verbose"],
1534 1534 > "This is the topic to test omit indicating.",
1535 1535 > lambda ui: testtopic))
1536 1536 > EOF
1537 1537 $ echo '[extensions]' >> $HGRCPATH
1538 1538 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1539 1539 $ hg help addverboseitems
1540 1540 addverboseitems extension - extension to test omit indicating.
1541 1541
1542 1542 This paragraph is never omitted (for extension)
1543 1543
1544 1544 This paragraph is never omitted, too (for extension)
1545 1545
1546 1546 (some details hidden, use --verbose to show complete help)
1547 1547
1548 1548 no commands defined
1549 1549 $ hg help -v addverboseitems
1550 1550 addverboseitems extension - extension to test omit indicating.
1551 1551
1552 1552 This paragraph is never omitted (for extension)
1553 1553
1554 1554 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1555 1555 extension)
1556 1556
1557 1557 This paragraph is never omitted, too (for extension)
1558 1558
1559 1559 no commands defined
1560 1560 $ hg help topic-containing-verbose
1561 1561 This is the topic to test omit indicating.
1562 1562 """"""""""""""""""""""""""""""""""""""""""
1563 1563
1564 1564 This paragraph is never omitted (for topic).
1565 1565
1566 1566 This paragraph is never omitted, too (for topic)
1567 1567
1568 1568 (some details hidden, use --verbose to show complete help)
1569 1569 $ hg help -v topic-containing-verbose
1570 1570 This is the topic to test omit indicating.
1571 1571 """"""""""""""""""""""""""""""""""""""""""
1572 1572
1573 1573 This paragraph is never omitted (for topic).
1574 1574
1575 1575 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1576 1576 topic)
1577 1577
1578 1578 This paragraph is never omitted, too (for topic)
1579 1579
1580 1580 Test section lookup
1581 1581
1582 1582 $ hg help revset.merge
1583 1583 "merge()"
1584 1584 Changeset is a merge changeset.
1585 1585
1586 1586 $ hg help glossary.dag
1587 1587 DAG
1588 1588 The repository of changesets of a distributed version control system
1589 1589 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1590 1590 of nodes and edges, where nodes correspond to changesets and edges
1591 1591 imply a parent -> child relation. This graph can be visualized by
1592 1592 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
1593 1593 limited by the requirement for children to have at most two parents.
1594 1594
1595 1595
1596 1596 $ hg help hgrc.paths
1597 1597 "paths"
1598 1598 -------
1599 1599
1600 1600 Assigns symbolic names and behavior to repositories.
1601 1601
1602 1602 Options are symbolic names defining the URL or directory that is the
1603 1603 location of the repository. Example:
1604 1604
1605 1605 [paths]
1606 1606 my_server = https://example.com/my_repo
1607 1607 local_path = /home/me/repo
1608 1608
1609 1609 These symbolic names can be used from the command line. To pull from
1610 1610 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
1611 1611 local_path'.
1612 1612
1613 1613 Options containing colons (":") denote sub-options that can influence
1614 1614 behavior for that specific path. Example:
1615 1615
1616 1616 [paths]
1617 1617 my_server = https://example.com/my_path
1618 1618 my_server:pushurl = ssh://example.com/my_path
1619 1619
1620 1620 The following sub-options can be defined:
1621 1621
1622 1622 "pushurl"
1623 1623 The URL to use for push operations. If not defined, the location
1624 1624 defined by the path's main entry is used.
1625 1625
1626 1626 "pushrev"
1627 1627 A revset defining which revisions to push by default.
1628 1628
1629 1629 When 'hg push' is executed without a "-r" argument, the revset defined
1630 1630 by this sub-option is evaluated to determine what to push.
1631 1631
1632 1632 For example, a value of "." will push the working directory's revision
1633 1633 by default.
1634 1634
1635 1635 Revsets specifying bookmarks will not result in the bookmark being
1636 1636 pushed.
1637 1637
1638 1638 The following special named paths exist:
1639 1639
1640 1640 "default"
1641 1641 The URL or directory to use when no source or remote is specified.
1642 1642
1643 1643 'hg clone' will automatically define this path to the location the
1644 1644 repository was cloned from.
1645 1645
1646 1646 "default-push"
1647 1647 (deprecated) The URL or directory for the default 'hg push' location.
1648 1648 "default:pushurl" should be used instead.
1649 1649
1650 1650 $ hg help glossary.mcguffin
1651 1651 abort: help section not found: glossary.mcguffin
1652 1652 [255]
1653 1653
1654 1654 $ hg help glossary.mc.guffin
1655 1655 abort: help section not found: glossary.mc.guffin
1656 1656 [255]
1657 1657
1658 1658 $ hg help template.files
1659 1659 files List of strings. All files modified, added, or removed by
1660 1660 this changeset.
1661 1661 files(pattern)
1662 1662 All files of the current changeset matching the pattern. See
1663 1663 'hg help patterns'.
1664 1664
1665 1665 Test section lookup by translated message
1666 1666
1667 1667 str.lower() instead of encoding.lower(str) on translated message might
1668 1668 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
1669 1669 as the second or later byte of multi-byte character.
1670 1670
1671 1671 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
1672 1672 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
1673 1673 replacement makes message meaningless.
1674 1674
1675 1675 This tests that section lookup by translated string isn't broken by
1676 1676 such str.lower().
1677 1677
1678 1678 $ $PYTHON <<EOF
1679 1679 > def escape(s):
1680 1680 > return ''.join('\u%x' % ord(uc) for uc in s.decode('cp932'))
1681 1681 > # translation of "record" in ja_JP.cp932
1682 1682 > upper = "\x8bL\x98^"
1683 1683 > # str.lower()-ed section name should be treated as different one
1684 1684 > lower = "\x8bl\x98^"
1685 1685 > with open('ambiguous.py', 'w') as fp:
1686 1686 > fp.write("""# ambiguous section names in ja_JP.cp932
1687 1687 > u'''summary of extension
1688 1688 >
1689 1689 > %s
1690 1690 > ----
1691 1691 >
1692 1692 > Upper name should show only this message
1693 1693 >
1694 1694 > %s
1695 1695 > ----
1696 1696 >
1697 1697 > Lower name should show only this message
1698 1698 >
1699 1699 > subsequent section
1700 1700 > ------------------
1701 1701 >
1702 1702 > This should be hidden at 'hg help ambiguous' with section name.
1703 1703 > '''
1704 1704 > """ % (escape(upper), escape(lower)))
1705 1705 > EOF
1706 1706
1707 1707 $ cat >> $HGRCPATH <<EOF
1708 1708 > [extensions]
1709 1709 > ambiguous = ./ambiguous.py
1710 1710 > EOF
1711 1711
1712 1712 $ $PYTHON <<EOF | sh
1713 1713 > upper = "\x8bL\x98^"
1714 1714 > print("hg --encoding cp932 help -e ambiguous.%s" % upper)
1715 1715 > EOF
1716 1716 \x8bL\x98^ (esc)
1717 1717 ----
1718 1718
1719 1719 Upper name should show only this message
1720 1720
1721 1721
1722 1722 $ $PYTHON <<EOF | sh
1723 1723 > lower = "\x8bl\x98^"
1724 1724 > print("hg --encoding cp932 help -e ambiguous.%s" % lower)
1725 1725 > EOF
1726 1726 \x8bl\x98^ (esc)
1727 1727 ----
1728 1728
1729 1729 Lower name should show only this message
1730 1730
1731 1731
1732 1732 $ cat >> $HGRCPATH <<EOF
1733 1733 > [extensions]
1734 1734 > ambiguous = !
1735 1735 > EOF
1736 1736
1737 1737 Show help content of disabled extensions
1738 1738
1739 1739 $ cat >> $HGRCPATH <<EOF
1740 1740 > [extensions]
1741 1741 > ambiguous = !./ambiguous.py
1742 1742 > EOF
1743 1743 $ hg help -e ambiguous
1744 1744 ambiguous extension - (no help text available)
1745 1745
1746 1746 (use 'hg help extensions' for information on enabling extensions)
1747 1747
1748 1748 Test dynamic list of merge tools only shows up once
1749 1749 $ hg help merge-tools
1750 1750 Merge Tools
1751 1751 """""""""""
1752 1752
1753 1753 To merge files Mercurial uses merge tools.
1754 1754
1755 1755 A merge tool combines two different versions of a file into a merged file.
1756 1756 Merge tools are given the two files and the greatest common ancestor of
1757 1757 the two file versions, so they can determine the changes made on both
1758 1758 branches.
1759 1759
1760 1760 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
1761 1761 backout' and in several extensions.
1762 1762
1763 1763 Usually, the merge tool tries to automatically reconcile the files by
1764 1764 combining all non-overlapping changes that occurred separately in the two
1765 1765 different evolutions of the same initial base file. Furthermore, some
1766 1766 interactive merge programs make it easier to manually resolve conflicting
1767 1767 merges, either in a graphical way, or by inserting some conflict markers.
1768 1768 Mercurial does not include any interactive merge programs but relies on
1769 1769 external tools for that.
1770 1770
1771 1771 Available merge tools
1772 1772 =====================
1773 1773
1774 1774 External merge tools and their properties are configured in the merge-
1775 1775 tools configuration section - see hgrc(5) - but they can often just be
1776 1776 named by their executable.
1777 1777
1778 1778 A merge tool is generally usable if its executable can be found on the
1779 1779 system and if it can handle the merge. The executable is found if it is an
1780 1780 absolute or relative executable path or the name of an application in the
1781 1781 executable search path. The tool is assumed to be able to handle the merge
1782 1782 if it can handle symlinks if the file is a symlink, if it can handle
1783 1783 binary files if the file is binary, and if a GUI is available if the tool
1784 1784 requires a GUI.
1785 1785
1786 1786 There are some internal merge tools which can be used. The internal merge
1787 1787 tools are:
1788 1788
1789 1789 ":dump"
1790 1790 Creates three versions of the files to merge, containing the contents of
1791 1791 local, other and base. These files can then be used to perform a merge
1792 1792 manually. If the file to be merged is named "a.txt", these files will
1793 1793 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
1794 1794 they will be placed in the same directory as "a.txt".
1795 1795
1796 1796 This implies premerge. Therefore, files aren't dumped, if premerge runs
1797 1797 successfully. Use :forcedump to forcibly write files out.
1798 1798
1799 1799 ":fail"
1800 1800 Rather than attempting to merge files that were modified on both
1801 1801 branches, it marks them as unresolved. The resolve command must be used
1802 1802 to resolve these conflicts.
1803 1803
1804 1804 ":forcedump"
1805 1805 Creates three versions of the files as same as :dump, but omits
1806 1806 premerge.
1807 1807
1808 1808 ":local"
1809 1809 Uses the local 'p1()' version of files as the merged version.
1810 1810
1811 1811 ":merge"
1812 1812 Uses the internal non-interactive simple merge algorithm for merging
1813 1813 files. It will fail if there are any conflicts and leave markers in the
1814 1814 partially merged file. Markers will have two sections, one for each side
1815 1815 of merge.
1816 1816
1817 1817 ":merge-local"
1818 1818 Like :merge, but resolve all conflicts non-interactively in favor of the
1819 1819 local 'p1()' changes.
1820 1820
1821 1821 ":merge-other"
1822 1822 Like :merge, but resolve all conflicts non-interactively in favor of the
1823 1823 other 'p2()' changes.
1824 1824
1825 1825 ":merge3"
1826 1826 Uses the internal non-interactive simple merge algorithm for merging
1827 1827 files. It will fail if there are any conflicts and leave markers in the
1828 1828 partially merged file. Marker will have three sections, one from each
1829 1829 side of the merge and one for the base content.
1830 1830
1831 1831 ":other"
1832 1832 Uses the other 'p2()' version of files as the merged version.
1833 1833
1834 1834 ":prompt"
1835 1835 Asks the user which of the local 'p1()' or the other 'p2()' version to
1836 1836 keep as the merged version.
1837 1837
1838 1838 ":tagmerge"
1839 1839 Uses the internal tag merge algorithm (experimental).
1840 1840
1841 1841 ":union"
1842 1842 Uses the internal non-interactive simple merge algorithm for merging
1843 1843 files. It will use both left and right sides for conflict regions. No
1844 1844 markers are inserted.
1845 1845
1846 1846 Internal tools are always available and do not require a GUI but will by
1847 1847 default not handle symlinks or binary files.
1848 1848
1849 1849 Choosing a merge tool
1850 1850 =====================
1851 1851
1852 1852 Mercurial uses these rules when deciding which merge tool to use:
1853 1853
1854 1854 1. If a tool has been specified with the --tool option to merge or
1855 1855 resolve, it is used. If it is the name of a tool in the merge-tools
1856 1856 configuration, its configuration is used. Otherwise the specified tool
1857 1857 must be executable by the shell.
1858 1858 2. If the "HGMERGE" environment variable is present, its value is used and
1859 1859 must be executable by the shell.
1860 1860 3. If the filename of the file to be merged matches any of the patterns in
1861 1861 the merge-patterns configuration section, the first usable merge tool
1862 1862 corresponding to a matching pattern is used. Here, binary capabilities
1863 1863 of the merge tool are not considered.
1864 1864 4. If ui.merge is set it will be considered next. If the value is not the
1865 1865 name of a configured tool, the specified value is used and must be
1866 1866 executable by the shell. Otherwise the named tool is used if it is
1867 1867 usable.
1868 1868 5. If any usable merge tools are present in the merge-tools configuration
1869 1869 section, the one with the highest priority is used.
1870 1870 6. If a program named "hgmerge" can be found on the system, it is used -
1871 1871 but it will by default not be used for symlinks and binary files.
1872 1872 7. If the file to be merged is not binary and is not a symlink, then
1873 1873 internal ":merge" is used.
1874 1874 8. Otherwise, ":prompt" is used.
1875 1875
1876 1876 Note:
1877 1877 After selecting a merge program, Mercurial will by default attempt to
1878 1878 merge the files using a simple merge algorithm first. Only if it
1879 doesn't succeed because of conflicting changes Mercurial will actually
1879 doesn't succeed because of conflicting changes will Mercurial actually
1880 1880 execute the merge program. Whether to use the simple merge algorithm
1881 1881 first can be controlled by the premerge setting of the merge tool.
1882 1882 Premerge is enabled by default unless the file is binary or a symlink.
1883 1883
1884 1884 See the merge-tools and ui sections of hgrc(5) for details on the
1885 1885 configuration of merge tools.
1886 1886
1887 1887 Compression engines listed in `hg help bundlespec`
1888 1888
1889 1889 $ hg help bundlespec | grep gzip
1890 1890 "v1" bundles can only use the "gzip", "bzip2", and "none" compression
1891 1891 An algorithm that produces smaller bundles than "gzip".
1892 1892 This engine will likely produce smaller bundles than "gzip" but will be
1893 1893 "gzip"
1894 1894 better compression than "gzip". It also frequently yields better (?)
1895 1895
1896 1896 Test usage of section marks in help documents
1897 1897
1898 1898 $ cd "$TESTDIR"/../doc
1899 1899 $ $PYTHON check-seclevel.py
1900 1900 $ cd $TESTTMP
1901 1901
1902 1902 #if serve
1903 1903
1904 1904 Test the help pages in hgweb.
1905 1905
1906 1906 Dish up an empty repo; serve it cold.
1907 1907
1908 1908 $ hg init "$TESTTMP/test"
1909 1909 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
1910 1910 $ cat hg.pid >> $DAEMON_PIDS
1911 1911
1912 1912 $ get-with-headers.py $LOCALIP:$HGPORT "help"
1913 1913 200 Script output follows
1914 1914
1915 1915 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
1916 1916 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
1917 1917 <head>
1918 1918 <link rel="icon" href="/static/hgicon.png" type="image/png" />
1919 1919 <meta name="robots" content="index, nofollow" />
1920 1920 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
1921 1921 <script type="text/javascript" src="/static/mercurial.js"></script>
1922 1922
1923 1923 <title>Help: Index</title>
1924 1924 </head>
1925 1925 <body>
1926 1926
1927 1927 <div class="container">
1928 1928 <div class="menu">
1929 1929 <div class="logo">
1930 1930 <a href="https://mercurial-scm.org/">
1931 1931 <img src="/static/hglogo.png" alt="mercurial" /></a>
1932 1932 </div>
1933 1933 <ul>
1934 1934 <li><a href="/shortlog">log</a></li>
1935 1935 <li><a href="/graph">graph</a></li>
1936 1936 <li><a href="/tags">tags</a></li>
1937 1937 <li><a href="/bookmarks">bookmarks</a></li>
1938 1938 <li><a href="/branches">branches</a></li>
1939 1939 </ul>
1940 1940 <ul>
1941 1941 <li class="active">help</li>
1942 1942 </ul>
1943 1943 </div>
1944 1944
1945 1945 <div class="main">
1946 1946 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
1947 1947
1948 1948 <form class="search" action="/log">
1949 1949
1950 1950 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
1951 1951 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
1952 1952 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
1953 1953 </form>
1954 1954 <table class="bigtable">
1955 1955 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
1956 1956
1957 1957 <tr><td>
1958 1958 <a href="/help/bundlespec">
1959 1959 bundlespec
1960 1960 </a>
1961 1961 </td><td>
1962 1962 Bundle File Formats
1963 1963 </td></tr>
1964 1964 <tr><td>
1965 1965 <a href="/help/color">
1966 1966 color
1967 1967 </a>
1968 1968 </td><td>
1969 1969 Colorizing Outputs
1970 1970 </td></tr>
1971 1971 <tr><td>
1972 1972 <a href="/help/config">
1973 1973 config
1974 1974 </a>
1975 1975 </td><td>
1976 1976 Configuration Files
1977 1977 </td></tr>
1978 1978 <tr><td>
1979 1979 <a href="/help/dates">
1980 1980 dates
1981 1981 </a>
1982 1982 </td><td>
1983 1983 Date Formats
1984 1984 </td></tr>
1985 1985 <tr><td>
1986 1986 <a href="/help/diffs">
1987 1987 diffs
1988 1988 </a>
1989 1989 </td><td>
1990 1990 Diff Formats
1991 1991 </td></tr>
1992 1992 <tr><td>
1993 1993 <a href="/help/environment">
1994 1994 environment
1995 1995 </a>
1996 1996 </td><td>
1997 1997 Environment Variables
1998 1998 </td></tr>
1999 1999 <tr><td>
2000 2000 <a href="/help/extensions">
2001 2001 extensions
2002 2002 </a>
2003 2003 </td><td>
2004 2004 Using Additional Features
2005 2005 </td></tr>
2006 2006 <tr><td>
2007 2007 <a href="/help/filesets">
2008 2008 filesets
2009 2009 </a>
2010 2010 </td><td>
2011 2011 Specifying File Sets
2012 2012 </td></tr>
2013 2013 <tr><td>
2014 2014 <a href="/help/glossary">
2015 2015 glossary
2016 2016 </a>
2017 2017 </td><td>
2018 2018 Glossary
2019 2019 </td></tr>
2020 2020 <tr><td>
2021 2021 <a href="/help/hgignore">
2022 2022 hgignore
2023 2023 </a>
2024 2024 </td><td>
2025 2025 Syntax for Mercurial Ignore Files
2026 2026 </td></tr>
2027 2027 <tr><td>
2028 2028 <a href="/help/hgweb">
2029 2029 hgweb
2030 2030 </a>
2031 2031 </td><td>
2032 2032 Configuring hgweb
2033 2033 </td></tr>
2034 2034 <tr><td>
2035 2035 <a href="/help/internals">
2036 2036 internals
2037 2037 </a>
2038 2038 </td><td>
2039 2039 Technical implementation topics
2040 2040 </td></tr>
2041 2041 <tr><td>
2042 2042 <a href="/help/merge-tools">
2043 2043 merge-tools
2044 2044 </a>
2045 2045 </td><td>
2046 2046 Merge Tools
2047 2047 </td></tr>
2048 2048 <tr><td>
2049 2049 <a href="/help/pager">
2050 2050 pager
2051 2051 </a>
2052 2052 </td><td>
2053 2053 Pager Support
2054 2054 </td></tr>
2055 2055 <tr><td>
2056 2056 <a href="/help/patterns">
2057 2057 patterns
2058 2058 </a>
2059 2059 </td><td>
2060 2060 File Name Patterns
2061 2061 </td></tr>
2062 2062 <tr><td>
2063 2063 <a href="/help/phases">
2064 2064 phases
2065 2065 </a>
2066 2066 </td><td>
2067 2067 Working with Phases
2068 2068 </td></tr>
2069 2069 <tr><td>
2070 2070 <a href="/help/revisions">
2071 2071 revisions
2072 2072 </a>
2073 2073 </td><td>
2074 2074 Specifying Revisions
2075 2075 </td></tr>
2076 2076 <tr><td>
2077 2077 <a href="/help/scripting">
2078 2078 scripting
2079 2079 </a>
2080 2080 </td><td>
2081 2081 Using Mercurial from scripts and automation
2082 2082 </td></tr>
2083 2083 <tr><td>
2084 2084 <a href="/help/subrepos">
2085 2085 subrepos
2086 2086 </a>
2087 2087 </td><td>
2088 2088 Subrepositories
2089 2089 </td></tr>
2090 2090 <tr><td>
2091 2091 <a href="/help/templating">
2092 2092 templating
2093 2093 </a>
2094 2094 </td><td>
2095 2095 Template Usage
2096 2096 </td></tr>
2097 2097 <tr><td>
2098 2098 <a href="/help/urls">
2099 2099 urls
2100 2100 </a>
2101 2101 </td><td>
2102 2102 URL Paths
2103 2103 </td></tr>
2104 2104 <tr><td>
2105 2105 <a href="/help/topic-containing-verbose">
2106 2106 topic-containing-verbose
2107 2107 </a>
2108 2108 </td><td>
2109 2109 This is the topic to test omit indicating.
2110 2110 </td></tr>
2111 2111
2112 2112
2113 2113 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
2114 2114
2115 2115 <tr><td>
2116 2116 <a href="/help/add">
2117 2117 add
2118 2118 </a>
2119 2119 </td><td>
2120 2120 add the specified files on the next commit
2121 2121 </td></tr>
2122 2122 <tr><td>
2123 2123 <a href="/help/annotate">
2124 2124 annotate
2125 2125 </a>
2126 2126 </td><td>
2127 2127 show changeset information by line for each file
2128 2128 </td></tr>
2129 2129 <tr><td>
2130 2130 <a href="/help/clone">
2131 2131 clone
2132 2132 </a>
2133 2133 </td><td>
2134 2134 make a copy of an existing repository
2135 2135 </td></tr>
2136 2136 <tr><td>
2137 2137 <a href="/help/commit">
2138 2138 commit
2139 2139 </a>
2140 2140 </td><td>
2141 2141 commit the specified files or all outstanding changes
2142 2142 </td></tr>
2143 2143 <tr><td>
2144 2144 <a href="/help/diff">
2145 2145 diff
2146 2146 </a>
2147 2147 </td><td>
2148 2148 diff repository (or selected files)
2149 2149 </td></tr>
2150 2150 <tr><td>
2151 2151 <a href="/help/export">
2152 2152 export
2153 2153 </a>
2154 2154 </td><td>
2155 2155 dump the header and diffs for one or more changesets
2156 2156 </td></tr>
2157 2157 <tr><td>
2158 2158 <a href="/help/forget">
2159 2159 forget
2160 2160 </a>
2161 2161 </td><td>
2162 2162 forget the specified files on the next commit
2163 2163 </td></tr>
2164 2164 <tr><td>
2165 2165 <a href="/help/init">
2166 2166 init
2167 2167 </a>
2168 2168 </td><td>
2169 2169 create a new repository in the given directory
2170 2170 </td></tr>
2171 2171 <tr><td>
2172 2172 <a href="/help/log">
2173 2173 log
2174 2174 </a>
2175 2175 </td><td>
2176 2176 show revision history of entire repository or files
2177 2177 </td></tr>
2178 2178 <tr><td>
2179 2179 <a href="/help/merge">
2180 2180 merge
2181 2181 </a>
2182 2182 </td><td>
2183 2183 merge another revision into working directory
2184 2184 </td></tr>
2185 2185 <tr><td>
2186 2186 <a href="/help/pull">
2187 2187 pull
2188 2188 </a>
2189 2189 </td><td>
2190 2190 pull changes from the specified source
2191 2191 </td></tr>
2192 2192 <tr><td>
2193 2193 <a href="/help/push">
2194 2194 push
2195 2195 </a>
2196 2196 </td><td>
2197 2197 push changes to the specified destination
2198 2198 </td></tr>
2199 2199 <tr><td>
2200 2200 <a href="/help/remove">
2201 2201 remove
2202 2202 </a>
2203 2203 </td><td>
2204 2204 remove the specified files on the next commit
2205 2205 </td></tr>
2206 2206 <tr><td>
2207 2207 <a href="/help/serve">
2208 2208 serve
2209 2209 </a>
2210 2210 </td><td>
2211 2211 start stand-alone webserver
2212 2212 </td></tr>
2213 2213 <tr><td>
2214 2214 <a href="/help/status">
2215 2215 status
2216 2216 </a>
2217 2217 </td><td>
2218 2218 show changed files in the working directory
2219 2219 </td></tr>
2220 2220 <tr><td>
2221 2221 <a href="/help/summary">
2222 2222 summary
2223 2223 </a>
2224 2224 </td><td>
2225 2225 summarize working directory state
2226 2226 </td></tr>
2227 2227 <tr><td>
2228 2228 <a href="/help/update">
2229 2229 update
2230 2230 </a>
2231 2231 </td><td>
2232 2232 update working directory (or switch revisions)
2233 2233 </td></tr>
2234 2234
2235 2235
2236 2236
2237 2237 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
2238 2238
2239 2239 <tr><td>
2240 2240 <a href="/help/addremove">
2241 2241 addremove
2242 2242 </a>
2243 2243 </td><td>
2244 2244 add all new files, delete all missing files
2245 2245 </td></tr>
2246 2246 <tr><td>
2247 2247 <a href="/help/archive">
2248 2248 archive
2249 2249 </a>
2250 2250 </td><td>
2251 2251 create an unversioned archive of a repository revision
2252 2252 </td></tr>
2253 2253 <tr><td>
2254 2254 <a href="/help/backout">
2255 2255 backout
2256 2256 </a>
2257 2257 </td><td>
2258 2258 reverse effect of earlier changeset
2259 2259 </td></tr>
2260 2260 <tr><td>
2261 2261 <a href="/help/bisect">
2262 2262 bisect
2263 2263 </a>
2264 2264 </td><td>
2265 2265 subdivision search of changesets
2266 2266 </td></tr>
2267 2267 <tr><td>
2268 2268 <a href="/help/bookmarks">
2269 2269 bookmarks
2270 2270 </a>
2271 2271 </td><td>
2272 2272 create a new bookmark or list existing bookmarks
2273 2273 </td></tr>
2274 2274 <tr><td>
2275 2275 <a href="/help/branch">
2276 2276 branch
2277 2277 </a>
2278 2278 </td><td>
2279 2279 set or show the current branch name
2280 2280 </td></tr>
2281 2281 <tr><td>
2282 2282 <a href="/help/branches">
2283 2283 branches
2284 2284 </a>
2285 2285 </td><td>
2286 2286 list repository named branches
2287 2287 </td></tr>
2288 2288 <tr><td>
2289 2289 <a href="/help/bundle">
2290 2290 bundle
2291 2291 </a>
2292 2292 </td><td>
2293 2293 create a bundle file
2294 2294 </td></tr>
2295 2295 <tr><td>
2296 2296 <a href="/help/cat">
2297 2297 cat
2298 2298 </a>
2299 2299 </td><td>
2300 2300 output the current or given revision of files
2301 2301 </td></tr>
2302 2302 <tr><td>
2303 2303 <a href="/help/config">
2304 2304 config
2305 2305 </a>
2306 2306 </td><td>
2307 2307 show combined config settings from all hgrc files
2308 2308 </td></tr>
2309 2309 <tr><td>
2310 2310 <a href="/help/copy">
2311 2311 copy
2312 2312 </a>
2313 2313 </td><td>
2314 2314 mark files as copied for the next commit
2315 2315 </td></tr>
2316 2316 <tr><td>
2317 2317 <a href="/help/files">
2318 2318 files
2319 2319 </a>
2320 2320 </td><td>
2321 2321 list tracked files
2322 2322 </td></tr>
2323 2323 <tr><td>
2324 2324 <a href="/help/graft">
2325 2325 graft
2326 2326 </a>
2327 2327 </td><td>
2328 2328 copy changes from other branches onto the current branch
2329 2329 </td></tr>
2330 2330 <tr><td>
2331 2331 <a href="/help/grep">
2332 2332 grep
2333 2333 </a>
2334 2334 </td><td>
2335 2335 search revision history for a pattern in specified files
2336 2336 </td></tr>
2337 2337 <tr><td>
2338 2338 <a href="/help/heads">
2339 2339 heads
2340 2340 </a>
2341 2341 </td><td>
2342 2342 show branch heads
2343 2343 </td></tr>
2344 2344 <tr><td>
2345 2345 <a href="/help/help">
2346 2346 help
2347 2347 </a>
2348 2348 </td><td>
2349 2349 show help for a given topic or a help overview
2350 2350 </td></tr>
2351 2351 <tr><td>
2352 2352 <a href="/help/hgalias">
2353 2353 hgalias
2354 2354 </a>
2355 2355 </td><td>
2356 2356 summarize working directory state
2357 2357 </td></tr>
2358 2358 <tr><td>
2359 2359 <a href="/help/identify">
2360 2360 identify
2361 2361 </a>
2362 2362 </td><td>
2363 2363 identify the working directory or specified revision
2364 2364 </td></tr>
2365 2365 <tr><td>
2366 2366 <a href="/help/import">
2367 2367 import
2368 2368 </a>
2369 2369 </td><td>
2370 2370 import an ordered set of patches
2371 2371 </td></tr>
2372 2372 <tr><td>
2373 2373 <a href="/help/incoming">
2374 2374 incoming
2375 2375 </a>
2376 2376 </td><td>
2377 2377 show new changesets found in source
2378 2378 </td></tr>
2379 2379 <tr><td>
2380 2380 <a href="/help/manifest">
2381 2381 manifest
2382 2382 </a>
2383 2383 </td><td>
2384 2384 output the current or given revision of the project manifest
2385 2385 </td></tr>
2386 2386 <tr><td>
2387 2387 <a href="/help/nohelp">
2388 2388 nohelp
2389 2389 </a>
2390 2390 </td><td>
2391 2391 (no help text available)
2392 2392 </td></tr>
2393 2393 <tr><td>
2394 2394 <a href="/help/outgoing">
2395 2395 outgoing
2396 2396 </a>
2397 2397 </td><td>
2398 2398 show changesets not found in the destination
2399 2399 </td></tr>
2400 2400 <tr><td>
2401 2401 <a href="/help/paths">
2402 2402 paths
2403 2403 </a>
2404 2404 </td><td>
2405 2405 show aliases for remote repositories
2406 2406 </td></tr>
2407 2407 <tr><td>
2408 2408 <a href="/help/phase">
2409 2409 phase
2410 2410 </a>
2411 2411 </td><td>
2412 2412 set or show the current phase name
2413 2413 </td></tr>
2414 2414 <tr><td>
2415 2415 <a href="/help/recover">
2416 2416 recover
2417 2417 </a>
2418 2418 </td><td>
2419 2419 roll back an interrupted transaction
2420 2420 </td></tr>
2421 2421 <tr><td>
2422 2422 <a href="/help/rename">
2423 2423 rename
2424 2424 </a>
2425 2425 </td><td>
2426 2426 rename files; equivalent of copy + remove
2427 2427 </td></tr>
2428 2428 <tr><td>
2429 2429 <a href="/help/resolve">
2430 2430 resolve
2431 2431 </a>
2432 2432 </td><td>
2433 2433 redo merges or set/view the merge status of files
2434 2434 </td></tr>
2435 2435 <tr><td>
2436 2436 <a href="/help/revert">
2437 2437 revert
2438 2438 </a>
2439 2439 </td><td>
2440 2440 restore files to their checkout state
2441 2441 </td></tr>
2442 2442 <tr><td>
2443 2443 <a href="/help/root">
2444 2444 root
2445 2445 </a>
2446 2446 </td><td>
2447 2447 print the root (top) of the current working directory
2448 2448 </td></tr>
2449 2449 <tr><td>
2450 2450 <a href="/help/shellalias">
2451 2451 shellalias
2452 2452 </a>
2453 2453 </td><td>
2454 2454 (no help text available)
2455 2455 </td></tr>
2456 2456 <tr><td>
2457 2457 <a href="/help/tag">
2458 2458 tag
2459 2459 </a>
2460 2460 </td><td>
2461 2461 add one or more tags for the current or given revision
2462 2462 </td></tr>
2463 2463 <tr><td>
2464 2464 <a href="/help/tags">
2465 2465 tags
2466 2466 </a>
2467 2467 </td><td>
2468 2468 list repository tags
2469 2469 </td></tr>
2470 2470 <tr><td>
2471 2471 <a href="/help/unbundle">
2472 2472 unbundle
2473 2473 </a>
2474 2474 </td><td>
2475 2475 apply one or more bundle files
2476 2476 </td></tr>
2477 2477 <tr><td>
2478 2478 <a href="/help/verify">
2479 2479 verify
2480 2480 </a>
2481 2481 </td><td>
2482 2482 verify the integrity of the repository
2483 2483 </td></tr>
2484 2484 <tr><td>
2485 2485 <a href="/help/version">
2486 2486 version
2487 2487 </a>
2488 2488 </td><td>
2489 2489 output version and copyright information
2490 2490 </td></tr>
2491 2491
2492 2492
2493 2493 </table>
2494 2494 </div>
2495 2495 </div>
2496 2496
2497 2497
2498 2498
2499 2499 </body>
2500 2500 </html>
2501 2501
2502 2502
2503 2503 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
2504 2504 200 Script output follows
2505 2505
2506 2506 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2507 2507 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2508 2508 <head>
2509 2509 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2510 2510 <meta name="robots" content="index, nofollow" />
2511 2511 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2512 2512 <script type="text/javascript" src="/static/mercurial.js"></script>
2513 2513
2514 2514 <title>Help: add</title>
2515 2515 </head>
2516 2516 <body>
2517 2517
2518 2518 <div class="container">
2519 2519 <div class="menu">
2520 2520 <div class="logo">
2521 2521 <a href="https://mercurial-scm.org/">
2522 2522 <img src="/static/hglogo.png" alt="mercurial" /></a>
2523 2523 </div>
2524 2524 <ul>
2525 2525 <li><a href="/shortlog">log</a></li>
2526 2526 <li><a href="/graph">graph</a></li>
2527 2527 <li><a href="/tags">tags</a></li>
2528 2528 <li><a href="/bookmarks">bookmarks</a></li>
2529 2529 <li><a href="/branches">branches</a></li>
2530 2530 </ul>
2531 2531 <ul>
2532 2532 <li class="active"><a href="/help">help</a></li>
2533 2533 </ul>
2534 2534 </div>
2535 2535
2536 2536 <div class="main">
2537 2537 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2538 2538 <h3>Help: add</h3>
2539 2539
2540 2540 <form class="search" action="/log">
2541 2541
2542 2542 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2543 2543 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2544 2544 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2545 2545 </form>
2546 2546 <div id="doc">
2547 2547 <p>
2548 2548 hg add [OPTION]... [FILE]...
2549 2549 </p>
2550 2550 <p>
2551 2551 add the specified files on the next commit
2552 2552 </p>
2553 2553 <p>
2554 2554 Schedule files to be version controlled and added to the
2555 2555 repository.
2556 2556 </p>
2557 2557 <p>
2558 2558 The files will be added to the repository at the next commit. To
2559 2559 undo an add before that, see 'hg forget'.
2560 2560 </p>
2561 2561 <p>
2562 2562 If no names are given, add all files to the repository (except
2563 2563 files matching &quot;.hgignore&quot;).
2564 2564 </p>
2565 2565 <p>
2566 2566 Examples:
2567 2567 </p>
2568 2568 <ul>
2569 2569 <li> New (unknown) files are added automatically by 'hg add':
2570 2570 <pre>
2571 2571 \$ ls (re)
2572 2572 foo.c
2573 2573 \$ hg status (re)
2574 2574 ? foo.c
2575 2575 \$ hg add (re)
2576 2576 adding foo.c
2577 2577 \$ hg status (re)
2578 2578 A foo.c
2579 2579 </pre>
2580 2580 <li> Specific files to be added can be specified:
2581 2581 <pre>
2582 2582 \$ ls (re)
2583 2583 bar.c foo.c
2584 2584 \$ hg status (re)
2585 2585 ? bar.c
2586 2586 ? foo.c
2587 2587 \$ hg add bar.c (re)
2588 2588 \$ hg status (re)
2589 2589 A bar.c
2590 2590 ? foo.c
2591 2591 </pre>
2592 2592 </ul>
2593 2593 <p>
2594 2594 Returns 0 if all files are successfully added.
2595 2595 </p>
2596 2596 <p>
2597 2597 options ([+] can be repeated):
2598 2598 </p>
2599 2599 <table>
2600 2600 <tr><td>-I</td>
2601 2601 <td>--include PATTERN [+]</td>
2602 2602 <td>include names matching the given patterns</td></tr>
2603 2603 <tr><td>-X</td>
2604 2604 <td>--exclude PATTERN [+]</td>
2605 2605 <td>exclude names matching the given patterns</td></tr>
2606 2606 <tr><td>-S</td>
2607 2607 <td>--subrepos</td>
2608 2608 <td>recurse into subrepositories</td></tr>
2609 2609 <tr><td>-n</td>
2610 2610 <td>--dry-run</td>
2611 2611 <td>do not perform actions, just print output</td></tr>
2612 2612 </table>
2613 2613 <p>
2614 2614 global options ([+] can be repeated):
2615 2615 </p>
2616 2616 <table>
2617 2617 <tr><td>-R</td>
2618 2618 <td>--repository REPO</td>
2619 2619 <td>repository root directory or name of overlay bundle file</td></tr>
2620 2620 <tr><td></td>
2621 2621 <td>--cwd DIR</td>
2622 2622 <td>change working directory</td></tr>
2623 2623 <tr><td>-y</td>
2624 2624 <td>--noninteractive</td>
2625 2625 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2626 2626 <tr><td>-q</td>
2627 2627 <td>--quiet</td>
2628 2628 <td>suppress output</td></tr>
2629 2629 <tr><td>-v</td>
2630 2630 <td>--verbose</td>
2631 2631 <td>enable additional output</td></tr>
2632 2632 <tr><td></td>
2633 2633 <td>--color TYPE</td>
2634 2634 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2635 2635 <tr><td></td>
2636 2636 <td>--config CONFIG [+]</td>
2637 2637 <td>set/override config option (use 'section.name=value')</td></tr>
2638 2638 <tr><td></td>
2639 2639 <td>--debug</td>
2640 2640 <td>enable debugging output</td></tr>
2641 2641 <tr><td></td>
2642 2642 <td>--debugger</td>
2643 2643 <td>start debugger</td></tr>
2644 2644 <tr><td></td>
2645 2645 <td>--encoding ENCODE</td>
2646 2646 <td>set the charset encoding (default: ascii)</td></tr>
2647 2647 <tr><td></td>
2648 2648 <td>--encodingmode MODE</td>
2649 2649 <td>set the charset encoding mode (default: strict)</td></tr>
2650 2650 <tr><td></td>
2651 2651 <td>--traceback</td>
2652 2652 <td>always print a traceback on exception</td></tr>
2653 2653 <tr><td></td>
2654 2654 <td>--time</td>
2655 2655 <td>time how long the command takes</td></tr>
2656 2656 <tr><td></td>
2657 2657 <td>--profile</td>
2658 2658 <td>print command execution profile</td></tr>
2659 2659 <tr><td></td>
2660 2660 <td>--version</td>
2661 2661 <td>output version information and exit</td></tr>
2662 2662 <tr><td>-h</td>
2663 2663 <td>--help</td>
2664 2664 <td>display help and exit</td></tr>
2665 2665 <tr><td></td>
2666 2666 <td>--hidden</td>
2667 2667 <td>consider hidden changesets</td></tr>
2668 2668 <tr><td></td>
2669 2669 <td>--pager TYPE</td>
2670 2670 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2671 2671 </table>
2672 2672
2673 2673 </div>
2674 2674 </div>
2675 2675 </div>
2676 2676
2677 2677
2678 2678
2679 2679 </body>
2680 2680 </html>
2681 2681
2682 2682
2683 2683 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
2684 2684 200 Script output follows
2685 2685
2686 2686 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2687 2687 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2688 2688 <head>
2689 2689 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2690 2690 <meta name="robots" content="index, nofollow" />
2691 2691 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2692 2692 <script type="text/javascript" src="/static/mercurial.js"></script>
2693 2693
2694 2694 <title>Help: remove</title>
2695 2695 </head>
2696 2696 <body>
2697 2697
2698 2698 <div class="container">
2699 2699 <div class="menu">
2700 2700 <div class="logo">
2701 2701 <a href="https://mercurial-scm.org/">
2702 2702 <img src="/static/hglogo.png" alt="mercurial" /></a>
2703 2703 </div>
2704 2704 <ul>
2705 2705 <li><a href="/shortlog">log</a></li>
2706 2706 <li><a href="/graph">graph</a></li>
2707 2707 <li><a href="/tags">tags</a></li>
2708 2708 <li><a href="/bookmarks">bookmarks</a></li>
2709 2709 <li><a href="/branches">branches</a></li>
2710 2710 </ul>
2711 2711 <ul>
2712 2712 <li class="active"><a href="/help">help</a></li>
2713 2713 </ul>
2714 2714 </div>
2715 2715
2716 2716 <div class="main">
2717 2717 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2718 2718 <h3>Help: remove</h3>
2719 2719
2720 2720 <form class="search" action="/log">
2721 2721
2722 2722 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2723 2723 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2724 2724 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2725 2725 </form>
2726 2726 <div id="doc">
2727 2727 <p>
2728 2728 hg remove [OPTION]... FILE...
2729 2729 </p>
2730 2730 <p>
2731 2731 aliases: rm
2732 2732 </p>
2733 2733 <p>
2734 2734 remove the specified files on the next commit
2735 2735 </p>
2736 2736 <p>
2737 2737 Schedule the indicated files for removal from the current branch.
2738 2738 </p>
2739 2739 <p>
2740 2740 This command schedules the files to be removed at the next commit.
2741 2741 To undo a remove before that, see 'hg revert'. To undo added
2742 2742 files, see 'hg forget'.
2743 2743 </p>
2744 2744 <p>
2745 2745 -A/--after can be used to remove only files that have already
2746 2746 been deleted, -f/--force can be used to force deletion, and -Af
2747 2747 can be used to remove files from the next revision without
2748 2748 deleting them from the working directory.
2749 2749 </p>
2750 2750 <p>
2751 2751 The following table details the behavior of remove for different
2752 2752 file states (columns) and option combinations (rows). The file
2753 2753 states are Added [A], Clean [C], Modified [M] and Missing [!]
2754 2754 (as reported by 'hg status'). The actions are Warn, Remove
2755 2755 (from branch) and Delete (from disk):
2756 2756 </p>
2757 2757 <table>
2758 2758 <tr><td>opt/state</td>
2759 2759 <td>A</td>
2760 2760 <td>C</td>
2761 2761 <td>M</td>
2762 2762 <td>!</td></tr>
2763 2763 <tr><td>none</td>
2764 2764 <td>W</td>
2765 2765 <td>RD</td>
2766 2766 <td>W</td>
2767 2767 <td>R</td></tr>
2768 2768 <tr><td>-f</td>
2769 2769 <td>R</td>
2770 2770 <td>RD</td>
2771 2771 <td>RD</td>
2772 2772 <td>R</td></tr>
2773 2773 <tr><td>-A</td>
2774 2774 <td>W</td>
2775 2775 <td>W</td>
2776 2776 <td>W</td>
2777 2777 <td>R</td></tr>
2778 2778 <tr><td>-Af</td>
2779 2779 <td>R</td>
2780 2780 <td>R</td>
2781 2781 <td>R</td>
2782 2782 <td>R</td></tr>
2783 2783 </table>
2784 2784 <p>
2785 2785 <b>Note:</b>
2786 2786 </p>
2787 2787 <p>
2788 2788 'hg remove' never deletes files in Added [A] state from the
2789 2789 working directory, not even if &quot;--force&quot; is specified.
2790 2790 </p>
2791 2791 <p>
2792 2792 Returns 0 on success, 1 if any warnings encountered.
2793 2793 </p>
2794 2794 <p>
2795 2795 options ([+] can be repeated):
2796 2796 </p>
2797 2797 <table>
2798 2798 <tr><td>-A</td>
2799 2799 <td>--after</td>
2800 2800 <td>record delete for missing files</td></tr>
2801 2801 <tr><td>-f</td>
2802 2802 <td>--force</td>
2803 2803 <td>forget added files, delete modified files</td></tr>
2804 2804 <tr><td>-S</td>
2805 2805 <td>--subrepos</td>
2806 2806 <td>recurse into subrepositories</td></tr>
2807 2807 <tr><td>-I</td>
2808 2808 <td>--include PATTERN [+]</td>
2809 2809 <td>include names matching the given patterns</td></tr>
2810 2810 <tr><td>-X</td>
2811 2811 <td>--exclude PATTERN [+]</td>
2812 2812 <td>exclude names matching the given patterns</td></tr>
2813 2813 </table>
2814 2814 <p>
2815 2815 global options ([+] can be repeated):
2816 2816 </p>
2817 2817 <table>
2818 2818 <tr><td>-R</td>
2819 2819 <td>--repository REPO</td>
2820 2820 <td>repository root directory or name of overlay bundle file</td></tr>
2821 2821 <tr><td></td>
2822 2822 <td>--cwd DIR</td>
2823 2823 <td>change working directory</td></tr>
2824 2824 <tr><td>-y</td>
2825 2825 <td>--noninteractive</td>
2826 2826 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2827 2827 <tr><td>-q</td>
2828 2828 <td>--quiet</td>
2829 2829 <td>suppress output</td></tr>
2830 2830 <tr><td>-v</td>
2831 2831 <td>--verbose</td>
2832 2832 <td>enable additional output</td></tr>
2833 2833 <tr><td></td>
2834 2834 <td>--color TYPE</td>
2835 2835 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2836 2836 <tr><td></td>
2837 2837 <td>--config CONFIG [+]</td>
2838 2838 <td>set/override config option (use 'section.name=value')</td></tr>
2839 2839 <tr><td></td>
2840 2840 <td>--debug</td>
2841 2841 <td>enable debugging output</td></tr>
2842 2842 <tr><td></td>
2843 2843 <td>--debugger</td>
2844 2844 <td>start debugger</td></tr>
2845 2845 <tr><td></td>
2846 2846 <td>--encoding ENCODE</td>
2847 2847 <td>set the charset encoding (default: ascii)</td></tr>
2848 2848 <tr><td></td>
2849 2849 <td>--encodingmode MODE</td>
2850 2850 <td>set the charset encoding mode (default: strict)</td></tr>
2851 2851 <tr><td></td>
2852 2852 <td>--traceback</td>
2853 2853 <td>always print a traceback on exception</td></tr>
2854 2854 <tr><td></td>
2855 2855 <td>--time</td>
2856 2856 <td>time how long the command takes</td></tr>
2857 2857 <tr><td></td>
2858 2858 <td>--profile</td>
2859 2859 <td>print command execution profile</td></tr>
2860 2860 <tr><td></td>
2861 2861 <td>--version</td>
2862 2862 <td>output version information and exit</td></tr>
2863 2863 <tr><td>-h</td>
2864 2864 <td>--help</td>
2865 2865 <td>display help and exit</td></tr>
2866 2866 <tr><td></td>
2867 2867 <td>--hidden</td>
2868 2868 <td>consider hidden changesets</td></tr>
2869 2869 <tr><td></td>
2870 2870 <td>--pager TYPE</td>
2871 2871 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2872 2872 </table>
2873 2873
2874 2874 </div>
2875 2875 </div>
2876 2876 </div>
2877 2877
2878 2878
2879 2879
2880 2880 </body>
2881 2881 </html>
2882 2882
2883 2883
2884 2884 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
2885 2885 200 Script output follows
2886 2886
2887 2887 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2888 2888 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2889 2889 <head>
2890 2890 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2891 2891 <meta name="robots" content="index, nofollow" />
2892 2892 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2893 2893 <script type="text/javascript" src="/static/mercurial.js"></script>
2894 2894
2895 2895 <title>Help: dates</title>
2896 2896 </head>
2897 2897 <body>
2898 2898
2899 2899 <div class="container">
2900 2900 <div class="menu">
2901 2901 <div class="logo">
2902 2902 <a href="https://mercurial-scm.org/">
2903 2903 <img src="/static/hglogo.png" alt="mercurial" /></a>
2904 2904 </div>
2905 2905 <ul>
2906 2906 <li><a href="/shortlog">log</a></li>
2907 2907 <li><a href="/graph">graph</a></li>
2908 2908 <li><a href="/tags">tags</a></li>
2909 2909 <li><a href="/bookmarks">bookmarks</a></li>
2910 2910 <li><a href="/branches">branches</a></li>
2911 2911 </ul>
2912 2912 <ul>
2913 2913 <li class="active"><a href="/help">help</a></li>
2914 2914 </ul>
2915 2915 </div>
2916 2916
2917 2917 <div class="main">
2918 2918 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2919 2919 <h3>Help: dates</h3>
2920 2920
2921 2921 <form class="search" action="/log">
2922 2922
2923 2923 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2924 2924 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2925 2925 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2926 2926 </form>
2927 2927 <div id="doc">
2928 2928 <h1>Date Formats</h1>
2929 2929 <p>
2930 2930 Some commands allow the user to specify a date, e.g.:
2931 2931 </p>
2932 2932 <ul>
2933 2933 <li> backout, commit, import, tag: Specify the commit date.
2934 2934 <li> log, revert, update: Select revision(s) by date.
2935 2935 </ul>
2936 2936 <p>
2937 2937 Many date formats are valid. Here are some examples:
2938 2938 </p>
2939 2939 <ul>
2940 2940 <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
2941 2941 <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
2942 2942 <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
2943 2943 <li> &quot;Dec 6&quot; (midnight)
2944 2944 <li> &quot;13:18&quot; (today assumed)
2945 2945 <li> &quot;3:39&quot; (3:39AM assumed)
2946 2946 <li> &quot;3:39pm&quot; (15:39)
2947 2947 <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
2948 2948 <li> &quot;2006-12-6 13:18&quot;
2949 2949 <li> &quot;2006-12-6&quot;
2950 2950 <li> &quot;12-6&quot;
2951 2951 <li> &quot;12/6&quot;
2952 2952 <li> &quot;12/6/6&quot; (Dec 6 2006)
2953 2953 <li> &quot;today&quot; (midnight)
2954 2954 <li> &quot;yesterday&quot; (midnight)
2955 2955 <li> &quot;now&quot; - right now
2956 2956 </ul>
2957 2957 <p>
2958 2958 Lastly, there is Mercurial's internal format:
2959 2959 </p>
2960 2960 <ul>
2961 2961 <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
2962 2962 </ul>
2963 2963 <p>
2964 2964 This is the internal representation format for dates. The first number
2965 2965 is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
2966 2966 second is the offset of the local timezone, in seconds west of UTC
2967 2967 (negative if the timezone is east of UTC).
2968 2968 </p>
2969 2969 <p>
2970 2970 The log command also accepts date ranges:
2971 2971 </p>
2972 2972 <ul>
2973 2973 <li> &quot;&lt;DATE&quot; - at or before a given date/time
2974 2974 <li> &quot;&gt;DATE&quot; - on or after a given date/time
2975 2975 <li> &quot;DATE to DATE&quot; - a date range, inclusive
2976 2976 <li> &quot;-DAYS&quot; - within a given number of days of today
2977 2977 </ul>
2978 2978
2979 2979 </div>
2980 2980 </div>
2981 2981 </div>
2982 2982
2983 2983
2984 2984
2985 2985 </body>
2986 2986 </html>
2987 2987
2988 2988
2989 2989 Sub-topic indexes rendered properly
2990 2990
2991 2991 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
2992 2992 200 Script output follows
2993 2993
2994 2994 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2995 2995 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2996 2996 <head>
2997 2997 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2998 2998 <meta name="robots" content="index, nofollow" />
2999 2999 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3000 3000 <script type="text/javascript" src="/static/mercurial.js"></script>
3001 3001
3002 3002 <title>Help: internals</title>
3003 3003 </head>
3004 3004 <body>
3005 3005
3006 3006 <div class="container">
3007 3007 <div class="menu">
3008 3008 <div class="logo">
3009 3009 <a href="https://mercurial-scm.org/">
3010 3010 <img src="/static/hglogo.png" alt="mercurial" /></a>
3011 3011 </div>
3012 3012 <ul>
3013 3013 <li><a href="/shortlog">log</a></li>
3014 3014 <li><a href="/graph">graph</a></li>
3015 3015 <li><a href="/tags">tags</a></li>
3016 3016 <li><a href="/bookmarks">bookmarks</a></li>
3017 3017 <li><a href="/branches">branches</a></li>
3018 3018 </ul>
3019 3019 <ul>
3020 3020 <li><a href="/help">help</a></li>
3021 3021 </ul>
3022 3022 </div>
3023 3023
3024 3024 <div class="main">
3025 3025 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3026 3026
3027 3027 <form class="search" action="/log">
3028 3028
3029 3029 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3030 3030 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3031 3031 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3032 3032 </form>
3033 3033 <table class="bigtable">
3034 3034 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
3035 3035
3036 3036 <tr><td>
3037 3037 <a href="/help/internals.bundles">
3038 3038 bundles
3039 3039 </a>
3040 3040 </td><td>
3041 3041 Bundles
3042 3042 </td></tr>
3043 3043 <tr><td>
3044 3044 <a href="/help/internals.censor">
3045 3045 censor
3046 3046 </a>
3047 3047 </td><td>
3048 3048 Censor
3049 3049 </td></tr>
3050 3050 <tr><td>
3051 3051 <a href="/help/internals.changegroups">
3052 3052 changegroups
3053 3053 </a>
3054 3054 </td><td>
3055 3055 Changegroups
3056 3056 </td></tr>
3057 3057 <tr><td>
3058 3058 <a href="/help/internals.config">
3059 3059 config
3060 3060 </a>
3061 3061 </td><td>
3062 3062 Config Register
3063 3063 </td></tr>
3064 3064 <tr><td>
3065 3065 <a href="/help/internals.requirements">
3066 3066 requirements
3067 3067 </a>
3068 3068 </td><td>
3069 3069 Repository Requirements
3070 3070 </td></tr>
3071 3071 <tr><td>
3072 3072 <a href="/help/internals.revlogs">
3073 3073 revlogs
3074 3074 </a>
3075 3075 </td><td>
3076 3076 Revision Logs
3077 3077 </td></tr>
3078 3078 <tr><td>
3079 3079 <a href="/help/internals.wireprotocol">
3080 3080 wireprotocol
3081 3081 </a>
3082 3082 </td><td>
3083 3083 Wire Protocol
3084 3084 </td></tr>
3085 3085
3086 3086
3087 3087
3088 3088
3089 3089
3090 3090 </table>
3091 3091 </div>
3092 3092 </div>
3093 3093
3094 3094
3095 3095
3096 3096 </body>
3097 3097 </html>
3098 3098
3099 3099
3100 3100 Sub-topic topics rendered properly
3101 3101
3102 3102 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
3103 3103 200 Script output follows
3104 3104
3105 3105 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3106 3106 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3107 3107 <head>
3108 3108 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3109 3109 <meta name="robots" content="index, nofollow" />
3110 3110 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3111 3111 <script type="text/javascript" src="/static/mercurial.js"></script>
3112 3112
3113 3113 <title>Help: internals.changegroups</title>
3114 3114 </head>
3115 3115 <body>
3116 3116
3117 3117 <div class="container">
3118 3118 <div class="menu">
3119 3119 <div class="logo">
3120 3120 <a href="https://mercurial-scm.org/">
3121 3121 <img src="/static/hglogo.png" alt="mercurial" /></a>
3122 3122 </div>
3123 3123 <ul>
3124 3124 <li><a href="/shortlog">log</a></li>
3125 3125 <li><a href="/graph">graph</a></li>
3126 3126 <li><a href="/tags">tags</a></li>
3127 3127 <li><a href="/bookmarks">bookmarks</a></li>
3128 3128 <li><a href="/branches">branches</a></li>
3129 3129 </ul>
3130 3130 <ul>
3131 3131 <li class="active"><a href="/help">help</a></li>
3132 3132 </ul>
3133 3133 </div>
3134 3134
3135 3135 <div class="main">
3136 3136 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3137 3137 <h3>Help: internals.changegroups</h3>
3138 3138
3139 3139 <form class="search" action="/log">
3140 3140
3141 3141 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3142 3142 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3143 3143 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3144 3144 </form>
3145 3145 <div id="doc">
3146 3146 <h1>Changegroups</h1>
3147 3147 <p>
3148 3148 Changegroups are representations of repository revlog data, specifically
3149 3149 the changelog data, root/flat manifest data, treemanifest data, and
3150 3150 filelogs.
3151 3151 </p>
3152 3152 <p>
3153 3153 There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
3154 3154 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
3155 3155 only difference being an additional item in the *delta header*. Version
3156 3156 &quot;3&quot; adds support for revlog flags in the *delta header* and optionally
3157 3157 exchanging treemanifests (enabled by setting an option on the
3158 3158 &quot;changegroup&quot; part in the bundle2).
3159 3159 </p>
3160 3160 <p>
3161 3161 Changegroups when not exchanging treemanifests consist of 3 logical
3162 3162 segments:
3163 3163 </p>
3164 3164 <pre>
3165 3165 +---------------------------------+
3166 3166 | | | |
3167 3167 | changeset | manifest | filelogs |
3168 3168 | | | |
3169 3169 | | | |
3170 3170 +---------------------------------+
3171 3171 </pre>
3172 3172 <p>
3173 3173 When exchanging treemanifests, there are 4 logical segments:
3174 3174 </p>
3175 3175 <pre>
3176 3176 +-------------------------------------------------+
3177 3177 | | | | |
3178 3178 | changeset | root | treemanifests | filelogs |
3179 3179 | | manifest | | |
3180 3180 | | | | |
3181 3181 +-------------------------------------------------+
3182 3182 </pre>
3183 3183 <p>
3184 3184 The principle building block of each segment is a *chunk*. A *chunk*
3185 3185 is a framed piece of data:
3186 3186 </p>
3187 3187 <pre>
3188 3188 +---------------------------------------+
3189 3189 | | |
3190 3190 | length | data |
3191 3191 | (4 bytes) | (&lt;length - 4&gt; bytes) |
3192 3192 | | |
3193 3193 +---------------------------------------+
3194 3194 </pre>
3195 3195 <p>
3196 3196 All integers are big-endian signed integers. Each chunk starts with a 32-bit
3197 3197 integer indicating the length of the entire chunk (including the length field
3198 3198 itself).
3199 3199 </p>
3200 3200 <p>
3201 3201 There is a special case chunk that has a value of 0 for the length
3202 3202 (&quot;0x00000000&quot;). We call this an *empty chunk*.
3203 3203 </p>
3204 3204 <h2>Delta Groups</h2>
3205 3205 <p>
3206 3206 A *delta group* expresses the content of a revlog as a series of deltas,
3207 3207 or patches against previous revisions.
3208 3208 </p>
3209 3209 <p>
3210 3210 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
3211 3211 to signal the end of the delta group:
3212 3212 </p>
3213 3213 <pre>
3214 3214 +------------------------------------------------------------------------+
3215 3215 | | | | | |
3216 3216 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
3217 3217 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
3218 3218 | | | | | |
3219 3219 +------------------------------------------------------------------------+
3220 3220 </pre>
3221 3221 <p>
3222 3222 Each *chunk*'s data consists of the following:
3223 3223 </p>
3224 3224 <pre>
3225 3225 +---------------------------------------+
3226 3226 | | |
3227 3227 | delta header | delta data |
3228 3228 | (various by version) | (various) |
3229 3229 | | |
3230 3230 +---------------------------------------+
3231 3231 </pre>
3232 3232 <p>
3233 3233 The *delta data* is a series of *delta*s that describe a diff from an existing
3234 3234 entry (either that the recipient already has, or previously specified in the
3235 3235 bundle/changegroup).
3236 3236 </p>
3237 3237 <p>
3238 3238 The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
3239 3239 &quot;3&quot; of the changegroup format.
3240 3240 </p>
3241 3241 <p>
3242 3242 Version 1 (headerlen=80):
3243 3243 </p>
3244 3244 <pre>
3245 3245 +------------------------------------------------------+
3246 3246 | | | | |
3247 3247 | node | p1 node | p2 node | link node |
3248 3248 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3249 3249 | | | | |
3250 3250 +------------------------------------------------------+
3251 3251 </pre>
3252 3252 <p>
3253 3253 Version 2 (headerlen=100):
3254 3254 </p>
3255 3255 <pre>
3256 3256 +------------------------------------------------------------------+
3257 3257 | | | | | |
3258 3258 | node | p1 node | p2 node | base node | link node |
3259 3259 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3260 3260 | | | | | |
3261 3261 +------------------------------------------------------------------+
3262 3262 </pre>
3263 3263 <p>
3264 3264 Version 3 (headerlen=102):
3265 3265 </p>
3266 3266 <pre>
3267 3267 +------------------------------------------------------------------------------+
3268 3268 | | | | | | |
3269 3269 | node | p1 node | p2 node | base node | link node | flags |
3270 3270 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
3271 3271 | | | | | | |
3272 3272 +------------------------------------------------------------------------------+
3273 3273 </pre>
3274 3274 <p>
3275 3275 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
3276 3276 series of *delta*s, densely packed (no separators). These deltas describe a diff
3277 3277 from an existing entry (either that the recipient already has, or previously
3278 3278 specified in the bundle/changegroup). The format is described more fully in
3279 3279 &quot;hg help internals.bdiff&quot;, but briefly:
3280 3280 </p>
3281 3281 <pre>
3282 3282 +---------------------------------------------------------------+
3283 3283 | | | | |
3284 3284 | start offset | end offset | new length | content |
3285 3285 | (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
3286 3286 | | | | |
3287 3287 +---------------------------------------------------------------+
3288 3288 </pre>
3289 3289 <p>
3290 3290 Please note that the length field in the delta data does *not* include itself.
3291 3291 </p>
3292 3292 <p>
3293 3293 In version 1, the delta is always applied against the previous node from
3294 3294 the changegroup or the first parent if this is the first entry in the
3295 3295 changegroup.
3296 3296 </p>
3297 3297 <p>
3298 3298 In version 2 and up, the delta base node is encoded in the entry in the
3299 3299 changegroup. This allows the delta to be expressed against any parent,
3300 3300 which can result in smaller deltas and more efficient encoding of data.
3301 3301 </p>
3302 3302 <h2>Changeset Segment</h2>
3303 3303 <p>
3304 3304 The *changeset segment* consists of a single *delta group* holding
3305 3305 changelog data. The *empty chunk* at the end of the *delta group* denotes
3306 3306 the boundary to the *manifest segment*.
3307 3307 </p>
3308 3308 <h2>Manifest Segment</h2>
3309 3309 <p>
3310 3310 The *manifest segment* consists of a single *delta group* holding manifest
3311 3311 data. If treemanifests are in use, it contains only the manifest for the
3312 3312 root directory of the repository. Otherwise, it contains the entire
3313 3313 manifest data. The *empty chunk* at the end of the *delta group* denotes
3314 3314 the boundary to the next segment (either the *treemanifests segment* or the
3315 3315 *filelogs segment*, depending on version and the request options).
3316 3316 </p>
3317 3317 <h3>Treemanifests Segment</h3>
3318 3318 <p>
3319 3319 The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
3320 3320 only if the 'treemanifest' param is part of the bundle2 changegroup part
3321 3321 (it is not possible to use changegroup version 3 outside of bundle2).
3322 3322 Aside from the filenames in the *treemanifests segment* containing a
3323 3323 trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
3324 3324 (see below). The final sub-segment is followed by an *empty chunk* (logically,
3325 3325 a sub-segment with filename size 0). This denotes the boundary to the
3326 3326 *filelogs segment*.
3327 3327 </p>
3328 3328 <h2>Filelogs Segment</h2>
3329 3329 <p>
3330 3330 The *filelogs segment* consists of multiple sub-segments, each
3331 3331 corresponding to an individual file whose data is being described:
3332 3332 </p>
3333 3333 <pre>
3334 3334 +--------------------------------------------------+
3335 3335 | | | | | |
3336 3336 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
3337 3337 | | | | | (4 bytes) |
3338 3338 | | | | | |
3339 3339 +--------------------------------------------------+
3340 3340 </pre>
3341 3341 <p>
3342 3342 The final filelog sub-segment is followed by an *empty chunk* (logically,
3343 3343 a sub-segment with filename size 0). This denotes the end of the segment
3344 3344 and of the overall changegroup.
3345 3345 </p>
3346 3346 <p>
3347 3347 Each filelog sub-segment consists of the following:
3348 3348 </p>
3349 3349 <pre>
3350 3350 +------------------------------------------------------+
3351 3351 | | | |
3352 3352 | filename length | filename | delta group |
3353 3353 | (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
3354 3354 | | | |
3355 3355 +------------------------------------------------------+
3356 3356 </pre>
3357 3357 <p>
3358 3358 That is, a *chunk* consisting of the filename (not terminated or padded)
3359 3359 followed by N chunks constituting the *delta group* for this file. The
3360 3360 *empty chunk* at the end of each *delta group* denotes the boundary to the
3361 3361 next filelog sub-segment.
3362 3362 </p>
3363 3363
3364 3364 </div>
3365 3365 </div>
3366 3366 </div>
3367 3367
3368 3368
3369 3369
3370 3370 </body>
3371 3371 </html>
3372 3372
3373 3373
3374 3374 $ killdaemons.py
3375 3375
3376 3376 #endif
General Comments 0
You need to be logged in to leave comments. Login now