Read about our upcoming Code of Conduct on this issue

commands.py 207 KB
Newer Older
mpm@selenic.com's avatar
mpm@selenic.com committed
1
2
# commands.py - command processing for mercurial
#
3
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
mpm@selenic.com's avatar
mpm@selenic.com committed
4
#
5
# This software may be used and distributed according to the terms of the
Matt Mackall's avatar
Matt Mackall committed
6
# GNU General Public License version 2 or any later version.
mpm@selenic.com's avatar
mpm@selenic.com committed
7

Gregory Szorc's avatar
Gregory Szorc committed
8
9
10
11
12
13
from __future__ import absolute_import

import difflib
import errno
import os
import re
14
import sys
Gregory Szorc's avatar
Gregory Szorc committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

from .i18n import _
from .node import (
    hex,
    nullid,
    nullrev,
    short,
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    copies,
30
    debugcommands as debugcommandsmod,
Gregory Szorc's avatar
Gregory Szorc committed
31
    destutil,
32
    dirstateguard,
Gregory Szorc's avatar
Gregory Szorc committed
33
34
35
36
37
    discovery,
    encoding,
    error,
    exchange,
    extensions,
Yuya Nishihara's avatar
Yuya Nishihara committed
38
    formatter,
Gregory Szorc's avatar
Gregory Szorc committed
39
40
41
42
    graphmod,
    hbisect,
    help,
    hg,
43
    logcmdutil,
Gregory Szorc's avatar
Gregory Szorc committed
44
45
    merge as mergemod,
    obsolete,
46
    obsutil,
Gregory Szorc's avatar
Gregory Szorc committed
47
48
    patch,
    phases,
49
    pycompat,
50
    rcutil,
51
    registrar,
52
    revsetlang,
53
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
54
    scmutil,
55
    server,
56
    state as statemod,
Gregory Szorc's avatar
Gregory Szorc committed
57
    streamclone,
58
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
59
60
61
    templatekw,
    ui as uimod,
    util,
62
    wireprotoserver,
Gregory Szorc's avatar
Gregory Szorc committed
63
)
64
65
66
67
from .utils import (
    dateutil,
    stringutil,
)
Gregory Szorc's avatar
Gregory Szorc committed
68

69
table = {}
70
table.update(debugcommandsmod.command._table)
71

72
command = registrar.command(table)
73
INTENT_READONLY = registrar.INTENT_READONLY
74
75
76
77
78
79
80
81
82
83

# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
84
     _('do not prompt, automatically pick the first choice for all prompts')),
85
86
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
87
    ('', 'color', '',
88
89
     # i18n: 'always', 'auto', 'never', and 'debug' are keywords
     # and should not be translated
90
     _("when to colorize (boolean, always, auto, never, or debug)"),
91
     _('TYPE')),
92
93
94
95
96
97
98
99
100
101
102
103
104
105
    ('', 'config', [],
     _('set/override config option (use \'section.name=value\')'),
     _('CONFIG')),
    ('', 'debug', None, _('enable debugging output')),
    ('', 'debugger', None, _('start debugger')),
    ('', 'encoding', encoding.encoding, _('set the charset encoding'),
     _('ENCODE')),
    ('', 'encodingmode', encoding.encodingmode,
     _('set the charset encoding mode'), _('MODE')),
    ('', 'traceback', None, _('always print a traceback on exception')),
    ('', 'time', None, _('time how long the command takes')),
    ('', 'profile', None, _('print command execution profile')),
    ('', 'version', None, _('output version information and exit')),
    ('h', 'help', None, _('display help and exit')),
106
    ('', 'hidden', False, _('consider hidden changesets')),
107
108
    ('', 'pager', 'auto',
     _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
109
110
]

111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
dryrunopts = cmdutil.dryrunopts
remoteopts = cmdutil.remoteopts
walkopts = cmdutil.walkopts
commitopts = cmdutil.commitopts
commitopts2 = cmdutil.commitopts2
formatteropts = cmdutil.formatteropts
templateopts = cmdutil.templateopts
logopts = cmdutil.logopts
diffopts = cmdutil.diffopts
diffwsopts = cmdutil.diffwsopts
diffopts2 = cmdutil.diffopts2
mergetoolopts = cmdutil.mergetoolopts
similarityopts = cmdutil.similarityopts
subrepoopts = cmdutil.subrepoopts
debugrevlogopts = cmdutil.debugrevlogopts
126

mpm@selenic.com's avatar
mpm@selenic.com committed
127
# Commands start here, listed alphabetically
128

129
130
@command('^add',
    walkopts + subrepoopts + dryrunopts,
131
132
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
133
def add(ui, repo, *pats, **opts):
134
135
    """add the specified files on the next commit

136
137
    Schedule files to be version controlled and added to the
    repository.
138

139
    The files will be added to the repository at the next commit. To
140
    undo an add before that, see :hg:`forget`.
141

timeless's avatar
timeless committed
142
143
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
144
145
146

    .. container:: verbose

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
       Examples:

         - New (unknown) files are added
           automatically by :hg:`add`::

             $ ls
             foo.c
             $ hg status
             ? foo.c
             $ hg add
             adding foo.c
             $ hg status
             A foo.c

         - Specific files to be added can be specified::

             $ ls
             bar.c  foo.c
             $ hg status
             ? bar.c
             ? foo.c
             $ hg add bar.c
             $ hg status
             A bar.c
             ? foo.c
172
173

    Returns 0 if all files are successfully added.
174
175
    """

176
    m = scmutil.match(repo[None], pats, pycompat.byteskwargs(opts))
177
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
178
    return rejected and 1 or 0
179

180
@command('addremove',
181
    similarityopts + subrepoopts + walkopts + dryrunopts,
182
183
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
184
def addremove(ui, repo, *pats, **opts):
185
    """add all new files, delete all missing files
186

187
188
    Add all new files and remove all missing files from the
    repository.
189

timeless's avatar
timeless committed
190
191
192
    Unless names are given, new files are ignored if they match any of
    the patterns in ``.hgignore``. As with add, these changes take
    effect at the next commit.
193

194
    Use the -s/--similarity option to detect renamed files. This
195
    option takes a percentage between 0 (disabled) and 100 (files must
196
197
198
    be identical) as its parameter. With a parameter greater than 0,
    this compares every removed file with every added file and records
    those similar enough as renames. Detecting renamed files this way
199
    can be expensive. After using this option, :hg:`status -C` can be
200
201
202
    used to check which files were identified as moved or renamed. If
    not specified, -s/--similarity defaults to 100 and only renames of
    identical files are detected.
203

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    .. container:: verbose

       Examples:

         - A number of files (bar.c and foo.c) are new,
           while foobar.c has been removed (without using :hg:`remove`)
           from the repository::

             $ ls
             bar.c foo.c
             $ hg status
             ! foobar.c
             ? bar.c
             ? foo.c
             $ hg addremove
             adding bar.c
             adding foo.c
             removing foobar.c
             $ hg status
             A bar.c
             A foo.c
             R foobar.c

         - A file foobar.c was moved to foo.c without using :hg:`rename`.
           Afterwards, it was edited slightly::

             $ ls
             foo.c
             $ hg status
             ! foobar.c
             ? foo.c
             $ hg addremove --similarity 90
             removing foobar.c
             adding foo.c
             recording removal of foobar.c as rename to foo.c (94% similar)
             $ hg status -C
             A foo.c
               foobar.c
             R foobar.c

244
    Returns 0 if all files are successfully added.
245
    """
246
    opts = pycompat.byteskwargs(opts)
247
248
    if not opts.get('similarity'):
        opts['similarity'] = '100'
249
    matcher = scmutil.match(repo[None], pats, opts)
250
    return scmutil.addremove(repo, matcher, "", opts)
251

252
253
254
255
256
257
258
259
260
261
262
@command('^annotate|blame',
    [('r', 'rev', '', _('annotate the specified revision'), _('REV')),
    ('', 'follow', None,
     _('follow copies/renames and list the filename (DEPRECATED)')),
    ('', 'no-follow', None, _("don't follow copies and renames")),
    ('a', 'text', None, _('treat all files as text')),
    ('u', 'user', None, _('list the author (long with -v)')),
    ('f', 'file', None, _('list the filename')),
    ('d', 'date', None, _('list the date (short with -q)')),
    ('n', 'number', None, _('list the revision number (default)')),
    ('c', 'changeset', None, _('list the changeset')),
263
264
    ('l', 'line-number', None, _('show line number at the first appearance')),
    ('', 'skip', [], _('revision to not display (EXPERIMENTAL)'), _('REV')),
265
    ] + diffwsopts + walkopts + formatteropts,
266
267
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
268
def annotate(ui, repo, *pats, **opts):
269
    """show changeset information by line for each file
270

271
    List changes in files, showing the revision id responsible for
272
    each line.
273

274
275
    This command is useful for discovering when a change was made and
    by whom.
276

277
278
279
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

280
281
282
283
    Without the -a/--text option, annotate will avoid processing files
    it detects as binary. With -a, annotate will annotate the file
    anyway, although the results will probably be neither useful
    nor desirable.
284
285

    Returns 0 on success.
286
    """
287
    opts = pycompat.byteskwargs(opts)
288
    if not pats:
289
        raise error.Abort(_('at least one filename or pattern is required'))
290

291
292
293
    if opts.get('follow'):
        # --follow is deprecated and now just an alias for -f/--file
        # to mimic the behavior of Mercurial before version 1.5
294
        opts['file'] = True
295

296
297
298
299
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
300

301
    rootfm = ui.formatter('annotate', opts)
302
    if ui.quiet:
303
        datefunc = dateutil.shortdate
304
    else:
305
        datefunc = dateutil.datestr
306
307
308
309
310
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
311
                return rootfm.hexfunc(node)
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
                if rev is None:
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
                if rev is None:
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
        def formathex(hex):
            if hex is None:
327
                return '%s+' % rootfm.hexfunc(ctx.p1().node())
328
329
330
            else:
                return '%s ' % hex
    else:
331
        hexfn = rootfm.hexfunc
332
        formatrev = formathex = pycompat.bytestr
333

334
    opmap = [('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
335
336
             ('rev', ' ', lambda x: x.fctx.rev(), formatrev),
             ('node', ' ', lambda x: hexfn(x.fctx.node()), formathex),
337
             ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
338
339
             ('file', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
             ('line_number', ':', lambda x: x.lineno, pycompat.bytestr),
340
            ]
341
    opnamemap = {'rev': 'number', 'node': 'changeset'}
342

343
    if (not opts.get('user') and not opts.get('changeset')
344
        and not opts.get('date') and not opts.get('file')):
345
        opts['number'] = True
346

347
    linenumber = opts.get('line_number') is not None
348
    if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
349
        raise error.Abort(_('at least one of -n/-c is required for -l'))
350

351
352
    ui.pager('annotate')

353
    if rootfm.isplain():
354
        def makefunc(get, fmt):
355
            return lambda x: fmt(get(x))
356
357
    else:
        def makefunc(get, fmt):
358
            return get
359
    datahint = rootfm.datahint()
360
    funcmap = [(makefunc(get, fmt), sep) for fn, sep, get, fmt in opmap
361
               if opts.get(opnamemap.get(fn, fn)) or fn in datahint]
362
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
363
    fields = ' '.join(fn for fn, sep, get, fmt in opmap
364
                      if opts.get(opnamemap.get(fn, fn)) or fn in datahint)
365

366
    def bad(x, y):
367
        raise error.Abort("%s: %s" % (x, y))
368

369
370
    m = scmutil.match(ctx, pats, opts, badfn=bad)

371
    follow = not opts.get('no_follow')
372
373
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
374
375
376
377
    skiprevs = opts.get('skip')
    if skiprevs:
        skiprevs = scmutil.revrange(repo, skiprevs)

Matt Mackall's avatar
Matt Mackall committed
378
379
    for abs in ctx.walk(m):
        fctx = ctx[abs]
380
381
        rootfm.startitem()
        rootfm.data(abspath=abs, path=m.rel(abs))
Jun Wu's avatar
Jun Wu committed
382
        if not opts.get('text') and fctx.isbinary():
383
384
            rootfm.plain(_("%s: binary file\n")
                         % ((pats and m.rel(abs)) or abs))
385
386
            continue

387
        fm = rootfm.nested('lines', tmpl='{rev}: {line}')
388
389
        lines = fctx.annotate(follow=follow, skiprevs=skiprevs,
                              diffopts=diffopts)
390
        if not lines:
391
            fm.end()
392
            continue
393
        formats = []
394
395
        pieces = []

396
        for f, sep in funcmap:
397
            l = [f(n) for n in lines]
398
            if fm.isplain():
399
400
401
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
402
403
            else:
                formats.append(['%s' for x in l])
404
            pieces.append(l)
405

406
        for f, p, n in zip(zip(*formats), zip(*pieces), lines):
407
            fm.startitem()
408
            fm.context(fctx=n.fctx)
409
            fm.write(fields, "".join(f), *p)
410
            if n.skip:
411
412
413
                fmt = "* %s"
            else:
                fmt = ": %s"
414
            fm.write('line', fmt, n.text)
415

416
        if not lines[-1].text.endswith('\n'):
417
            fm.plain('\n')
418
        fm.end()
419

420
    rootfm.end()
421

422
423
424
425
426
427
428
429
@command('archive',
    [('', 'no-decode', None, _('do not pass files through decoders')),
    ('p', 'prefix', '', _('directory prefix for files in archive'),
     _('PREFIX')),
    ('r', 'rev', '', _('revision to distribute'), _('REV')),
    ('t', 'type', '', _('type of distribution to create'), _('TYPE')),
    ] + subrepoopts + walkopts,
    _('[OPTION]... DEST'))
430
def archive(ui, repo, dest, **opts):
431
    '''create an unversioned archive of a repository revision
432

433
434
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
435

436
    The archive type is automatically detected based on file
timeless's avatar
timeless committed
437
    extension (to override, use -t/--type).
438

Matt Mackall's avatar
Matt Mackall committed
439
440
441
442
443
444
445
446
447
448
449
450
    .. container:: verbose

      Examples:

      - create a zip file containing the 1.0 release::

          hg archive -r 1.0 project-1.0.zip

      - create a tarball excluding .hg files::

          hg archive project.tar.gz -X ".hg*"

451
    Valid types are:
452

453
454
455
456
457
458
    :``files``: a directory full of files (default)
    :``tar``:   tar archive, uncompressed
    :``tbz2``:  tar archive, compressed using bzip2
    :``tgz``:   tar archive, compressed using gzip
    :``uzip``:  zip archive, uncompressed
    :``zip``:   zip archive, compressed using deflate
459

460
    The exact name of the destination archive or directory is given
Martin Geisler's avatar
Martin Geisler committed
461
    using a format string; see :hg:`help export` for details.
462

463
464
465
466
    Each member added to an archive file has a directory prefix
    prepended. Use -p/--prefix to specify a format string for the
    prefix. The default is the basename of the archive, with suffixes
    removed.
467
468

    Returns 0 on success.
469
470
    '''

471
    opts = pycompat.byteskwargs(opts)
472
473
474
475
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
476
    if not ctx:
477
        raise error.Abort(_('no working directory: please specify a revision'))
478
    node = ctx.node()
479
    dest = cmdutil.makefilename(ctx, dest)
480
    if os.path.realpath(dest) == repo.root:
481
        raise error.Abort(_('repository root cannot be destination'))
482

483
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
484
    prefix = opts.get('prefix')
485

486
487
    if dest == '-':
        if kind == 'files':
488
            raise error.Abort(_('cannot archive plain files to stdout'))
489
        dest = cmdutil.makefileobj(ctx, dest)
490
491
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
492

493
    prefix = cmdutil.makefilename(ctx, prefix)
494
    match = scmutil.match(ctx, [], opts)
495
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
496
                     match, prefix, subrepos=opts.get('subrepos'))
497

498
499
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
500
501
502
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
503
504
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
505
    ('r', 'rev', '', _('revision to backout'), _('REV')),
506
    ('e', 'edit', False, _('invoke editor on commit messages')),
507
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
508
    _('[OPTION]... [-r] REV'))
509
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
510
511
    '''reverse effect of earlier changeset

512
    Prepare a new changeset with the effect of REV undone in the
513
514
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
515

516
    If REV is the parent of the working directory, then this new changeset
517
    is committed automatically (unless --no-commit is specified).
518

519
    .. note::
520

521
       :hg:`backout` cannot be used to fix either an unwanted or
522
       incorrect merge.
523

Matt Mackall's avatar
Matt Mackall committed
524
525
    .. container:: verbose

526
527
528
529
530
531
532
533
534
535
536
537
      Examples:

      - Reverse the effect of the parent of the working directory.
        This backout will be committed immediately::

          hg backout -r .

      - Reverse the effect of previous bad revision 23::

          hg backout -r 23

      - Reverse the effect of previous bad revision 23 and
538
        leave changes uncommitted::
539

540
541
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
542

Matt Mackall's avatar
Matt Mackall committed
543
544
545
546
547
548
549
550
551
      By default, the pending changeset will have one parent,
      maintaining a linear history. With --merge, the pending
      changeset will instead have two parents: the old parent of the
      working directory and a new child of REV that simply undoes REV.

      Before version 1.7, the behavior without --merge was equivalent
      to specifying --merge followed by :hg:`update --clean .` to
      cancel the merge and leave the child of REV as a head to be
      merged separately.
552

Martin Geisler's avatar
Martin Geisler committed
553
    See :hg:`help dates` for a list of formats valid for -d/--date.
554

555
556
557
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

558
559
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
560
    '''
561
    with repo.wlock(), repo.lock():
562
        return _dobackout(ui, repo, node, rev, **opts)
563

564
def _dobackout(ui, repo, node=None, rev=None, **opts):
565
    opts = pycompat.byteskwargs(opts)
566
567
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
568
569
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
570

Daniel Holth's avatar
Daniel Holth committed
571
    if rev and node:
572
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
573
574
575

    if not rev:
        rev = node
Vadim Gelfer's avatar
Vadim Gelfer committed
576

577
    if not rev:
578
        raise error.Abort(_("please specify a revision to backout"))
579

580
581
    date = opts.get('date')
    if date:
582
        opts['date'] = dateutil.parsedate(date)
583

584
    cmdutil.checkunfinished(repo)
585
    cmdutil.bailifchanged(repo)
586
    node = scmutil.revsingle(repo, rev).node()
587

588
    op1, op2 = repo.dirstate.parents()
589
    if not repo.changelog.isancestor(node, op1):
590
        raise error.Abort(_('cannot backout change that is not an ancestor'))
591

592
593
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
594
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
595
    if p2 != nullid:
596
        if not opts.get('parent'):
597
            raise error.Abort(_('cannot backout a merge changeset'))
598
599
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
600
            raise error.Abort(_('%s is not a parent of %s') %
601
                             (short(p), short(node)))
602
603
        parent = p
    else:
604
        if opts.get('parent'):
605
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
606
        parent = p1
607

608
    # the backout should appear on the same branch
609
610
611
612
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
613
        with dirstateguard.dirstateguard(repo, 'backout'):
614
615
616
            overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
            with ui.configoverride(overrides, 'backout'):
                stats = mergemod.update(repo, parent, True, True, node, False)
617
            repo.setparents(op1, op2)
618
619
620
621
622
        hg._showstats(repo, stats)
        if stats.unresolvedcount:
            repo.ui.status(_("use 'hg resolve' to retry unresolved "
                             "file merges\n"))
            return 1
623
624
625
626
627
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

628
629
630
631
632
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
633
634
635

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
636
637
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
        if not message:
            # we don't translate commit messages
            message = "Backed out changeset %s" % short(node)
            e = cmdutil.getcommiteditor(edit=True, editform=editform)
        return repo.commit(message, opts.get('user'), opts.get('date'),
                           match, editor=e)
    newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
    if not newnode:
        ui.status(_("nothing changed\n"))
        return 1
    cmdutil.commitstatus(repo, newnode, branch, bheads)

    def nice(node):
        return '%d:%s' % (repo.changelog.rev(node), short(node))
    ui.status(_('changeset %s backs out changeset %s\n') %
              (nice(repo.changelog.tip()), nice(node)))
    if opts.get('merge') and op1 != node:
        hg.clean(repo, op1, show_stats=False)
        ui.status(_('merging with changeset %s\n')
                  % nice(repo.changelog.tip()))
658
659
        overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
        with ui.configoverride(overrides, 'backout'):
660
            return hg.merge(repo, hex(repo.changelog.tip()))
661
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
662

663
664
665
666
667
668
669
670
671
@command('bisect',
    [('r', 'reset', False, _('reset bisect state')),
    ('g', 'good', False, _('mark changeset good')),
    ('b', 'bad', False, _('mark changeset bad')),
    ('s', 'skip', False, _('skip testing changeset')),
    ('e', 'extend', False, _('extend the bisect range')),
    ('c', 'command', '', _('use command to check changeset state'), _('CMD')),
    ('U', 'noupdate', False, _('do not update to target'))],
    _("[-gbsr] [-U] [-c CMD] [REV]"))
672
def bisect(ui, repo, rev=None, extra=None, command=None,
673
674
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
675
676
    """subdivision search of changesets

677
678
679
680
681
682
683
684
685
686
687
688
689
    This command helps to find changesets which introduce problems. To
    use, mark the earliest changeset you know exhibits the problem as
    bad, then mark the latest changeset which is free from the problem
    as good. Bisect will update your working directory to a revision
    for testing (unless the -U/--noupdate option is specified). Once
    you have performed tests, mark the working directory as good or
    bad, and bisect will either update to another candidate changeset
    or announce that it has found the bad revision.

    As a shortcut, you can also use the revision argument to mark a
    revision as good or bad without checking it out first.

    If you supply a command, it will be used for automatic bisection.
690
691
692
693
694
695
    The environment variable HG_NODE will contain the ID of the
    changeset being tested. The exit status of the command will be
    used to mark revisions as good or bad: status 0 means good, 125
    means to skip the revision, 127 (command not found) will abort the
    bisection, and any other non-zero exit status means the revision
    is bad.
696

697
698
699
700
    .. container:: verbose

      Some examples:

701
      - start a bisection with known bad revision 34, and good revision 12::
702
703
704
705
706
707
708
709
710
711

          hg bisect --bad 34
          hg bisect --good 12

      - advance the current bisection by marking current revision as good or
        bad::

          hg bisect --good
          hg bisect --bad

kiilerix's avatar
kiilerix committed
712
      - mark the current revision, or a known revision, to be skipped (e.g. if
713
714
715
716
717
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

718
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
719

720
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
721

722
723
724
725
726
727
728
729
730
731
      - forget the current bisection::

          hg bisect --reset

      - use 'make && make tests' to automatically find the first broken
        revision::

          hg bisect --reset
          hg bisect --bad 34
          hg bisect --good 12
732
          hg bisect --command "make && make tests"
733
734
735
736
737
738

      - see all changesets whose states are already known in the current
        bisection::

          hg log -r "bisect(pruned)"

739
740
741
742
743
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

744
745
746
747
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

748
      - you can even get a nice graph::
749
750
751

          hg log --graph -r "bisect(range)"

752
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
753

754
    Returns 0 on success.
755
756
757
758
759
760
761
762
763
764
765
    """
    # backward compatibility
    if rev in "good bad reset init".split():
        ui.warn(_("(use of 'hg bisect <cmd>' is deprecated)\n"))
        cmd, rev, extra = rev, extra, None
        if cmd == "good":
            good = True
        elif cmd == "bad":
            bad = True
        else:
            reset = True
766
    elif extra:
767
        raise error.Abort(_('incompatible arguments'))
768

769
770
771
772
773
774
775
776
777
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

778
779
780
781
782
    enabled = [x for x in incompatibles if incompatibles[x]]

    if len(enabled) > 1:
        raise error.Abort(_('%s and %s are incompatible') %
                          tuple(sorted(enabled)[0:2]))
783

784
    if reset:
785
        hbisect.resetstate(repo)
786
787
        return

788
789
    state = hbisect.load_state(repo)

790
791
792
    # update state
    if good or bad or skip:
        if rev:
793
            nodes = [repo[i].node() for i in scmutil.revrange(repo, [rev])]
794
795
796
797
798
799
800
801
802
        else:
            nodes = [repo.lookup('.')]
        if good:
            state['good'] += nodes
        elif bad:
            state['bad'] += nodes
        elif skip:
            state['skip'] += nodes
        hbisect.save_state(repo, state)
803
804
        if not (state['good'] and state['bad']):
            return
805

806
807
808
809
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
810
        cmdutil.checkunfinished(repo)
811
812
813
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

814
    displayer = logcmdutil.changesetdisplayer(ui, repo, {})
815

816
817
    if command:
        changesets = 1
818
819
820
821
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
822
                raise error.Abort(_('current bisect revision is unknown - '
823
                                   'start a new bisect to fix'))
824
        else:
825
826
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
827
                raise error.Abort(_('current bisect revision is a merge'))
828
829
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
830
831
832
        try:
            while changesets:
                # update state
833
                state['current'] = [node]
834
                hbisect.save_state(repo, state)
835
836
                status = ui.system(command, environ={'HG_NODE': hex(node)},
                                   blockedtag='bisect_check')
837
838
839
840
841
842
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
843
                    raise error.Abort(_("failed to execute %s") % command)
844
                elif status < 0:
845
                    raise error.Abort(_("%s killed") % command)
846
847
                else:
                    transition = "bad"
848
849
                state[transition].append(node)
                ctx = repo[node]
850
851
                ui.status(_('changeset %d:%s: %s\n') % (ctx.rev(), ctx,
                                                        transition))
852
                hbisect.checkstate(state)
853
                # bisect
854
                nodes, changesets, bgood = hbisect.bisect(repo, state)
855
                # update to next check
856
                node = nodes[0]
857
                mayupdate(repo, node, show_stats=False)
858
        finally:
859
            state['current'] = [node]
860
            hbisect.save_state(repo, state)
861
        hbisect.printresult(ui, repo, state, displayer, nodes, bgood)
862
        return
863

864
    hbisect.checkstate(state)
865
866

    # actually bisect
867
    nodes, changesets, good = hbisect.bisect(repo, state)
868
869
    if extend:
        if not changesets:
870
            extendnode = hbisect.extendrange(repo, state, nodes, good)
871
            if extendnode is not None:
872
873
                ui.write(_("Extending search to changeset %d:%s\n")
                         % (extendnode.rev(), extendnode))
874
875
                state['current'] = [extendnode.node()]
                hbisect.save_state(repo, state)
876
                return mayupdate(repo, extendnode.node())
877
        raise error.Abort(_("nothing to extend"))
878

879
    if changesets == 0:
880
        hbisect.printresult(ui, repo, state, displayer, nodes, good)
881
882
883
    else:
        assert len(nodes) == 1 # only a single node can be tested next
        node = nodes[0]
884
885
886
887
888
        # compute the approximate number of remaining tests
        tests, size = 0, 2
        while size <= changesets:
            tests, size = tests + 1, size * 2
        rev = repo.changelog.rev(node)
889
890
        ui.write(_("Testing changeset %d:%s "
                   "(%d changesets remaining, ~%d tests)\n")
891
                 % (rev, short(node), changesets, tests))
892
893
        state['current'] = [node]
        hbisect.save_state(repo, state)
894
        return mayupdate(repo, node)
895

896
@command('bookmarks|bookmark',
897
    [('f', 'force', False, _('force')),
898
    ('r', 'rev', '', _('revision for bookmark action'), _('REV')),
899
    ('d', 'delete', False, _('delete a given bookmark')),
900
    ('m', 'rename', '', _('rename a given bookmark'), _('OLD')),
901
902
    ('i', 'inactive', False, _('mark a bookmark inactive')),
    ] + formatteropts,
903
904
    _('hg bookmarks [OPTIONS]... [NAME]...'))
def bookmark(ui, repo, *names, **opts):
905
906
907
908
909
910
911
    '''create a new bookmark or list existing bookmarks

    Bookmarks are labels on changesets to help track lines of development.
    Bookmarks are unversioned and can be moved, renamed and deleted.
    Deleting or moving a bookmark has no effect on the associated changesets.

    Creating or updating to a bookmark causes it to be marked as 'active'.
912
913
    The active bookmark is indicated with a '*'.
    When a commit is made, the active bookmark will advance to the new commit.
914
915
916
917
918
919
    A plain :hg:`update` will also advance an active bookmark, if possible.
    Updating away from a bookmark will cause it to be deactivated.

    Bookmarks can be pushed and pulled between repositories (see
    :hg:`help push` and :hg:`help pull`). If a shared bookmark has
    diverged, a new 'divergent bookmark' of the form 'name@path' will
920
    be created. Using :hg:`merge` will resolve the divergence.
921

922
923
924
    Specifying bookmark as '.' to -m or -d options is equivalent to specifying
    the active bookmark's name.

925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
    A bookmark named '@' has the special property that :hg:`clone` will
    check it out by default if it exists.

    .. container:: verbose

      Examples:

      - create an active bookmark for a new line of development::

          hg book new-feature

      - create an inactive bookmark as a place marker::

          hg book -i reviewed

      - create an inactive bookmark on another changeset::

          hg book -r .^ tested

944
945
946
947