commands.py 212 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
    repair,
53
    revsetlang,
54
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
55
    scmutil,
56
    server,
57
    state as statemod,
Gregory Szorc's avatar
Gregory Szorc committed
58
    streamclone,
59
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
60 61 62
    templatekw,
    ui as uimod,
    util,
63
    wireprotoserver,
Gregory Szorc's avatar
Gregory Szorc committed
64
)
65 66 67 68
from .utils import (
    dateutil,
    stringutil,
)
Gregory Szorc's avatar
Gregory Szorc committed
69

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

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

# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
85
     _('do not prompt, automatically pick the first choice for all prompts')),
86 87
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
88
    ('', 'color', '',
89 90
     # i18n: 'always', 'auto', 'never', and 'debug' are keywords
     # and should not be translated
91
     _("when to colorize (boolean, always, auto, never, or debug)"),
92
     _('TYPE')),
93 94 95 96 97 98 99 100 101 102 103 104 105 106
    ('', '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')),
107
    ('', 'hidden', False, _('consider hidden changesets')),
108 109
    ('', 'pager', 'auto',
     _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
110 111
]

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
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
127

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

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

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

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

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

    .. container:: verbose

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
       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
173 174

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

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

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

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

timeless's avatar
timeless committed
191 192 193
    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.
194

195
    Use the -s/--similarity option to detect renamed files. This
196
    option takes a percentage between 0 (disabled) and 100 (files must
197 198 199
    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
200
    can be expensive. After using this option, :hg:`status -C` can be
201 202 203
    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.
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 244
    .. 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

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

253 254 255 256 257 258 259 260 261 262 263
@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')),
264 265
    ('l', 'line-number', None, _('show line number at the first appearance')),
    ('', 'skip', [], _('revision to not display (EXPERIMENTAL)'), _('REV')),
266
    ] + diffwsopts + walkopts + formatteropts,
267 268
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
269
def annotate(ui, repo, *pats, **opts):
270
    """show changeset information by line for each file
271

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

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

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

281 282 283 284
    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.
285 286

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

292 293 294
    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
295
        opts['file'] = True
296

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

302
    rootfm = ui.formatter('annotate', opts)
303
    if ui.quiet:
304
        datefunc = dateutil.shortdate
305
    else:
306
        datefunc = dateutil.datestr
307 308 309 310 311
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
312
                return rootfm.hexfunc(node)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
        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:
328
                return '%s+' % rootfm.hexfunc(ctx.p1().node())
329 330 331
            else:
                return '%s ' % hex
    else:
332
        hexfn = rootfm.hexfunc
333
        formatrev = formathex = pycompat.bytestr
334

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

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

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

352 353
    ui.pager('annotate')

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

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

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

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

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

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

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

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

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

421
    rootfm.end()
422

423 424 425 426 427 428 429 430
@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'))
431
def archive(ui, repo, dest, **opts):
432
    '''create an unversioned archive of a repository revision
433

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

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

Matt Mackall's avatar
Matt Mackall committed
440 441 442 443 444 445 446 447 448 449 450 451
    .. 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*"

452
    Valid types are:
453

454 455 456 457 458 459
    :``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
460

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

464 465 466 467
    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.
468 469

    Returns 0 on success.
470 471
    '''

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

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

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

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

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

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

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

520
    .. note::
521

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

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

527 528 529 530 531 532 533 534 535 536 537 538
      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
539
        leave changes uncommitted::
540

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

Matt Mackall's avatar
Matt Mackall committed
544 545 546 547 548 549 550 551 552
      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.
553

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

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

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

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

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

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

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

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

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

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

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

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

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

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
637 638
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
        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()))
659 660
        overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
        with ui.configoverride(overrides, 'backout'):
661
            return hg.merge(repo, hex(repo.changelog.tip()))
662
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
663

664 665 666 667 668 669 670 671 672
@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]"))
673
def bisect(ui, repo, rev=None, extra=None, command=None,
674 675
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
676 677
    """subdivision search of changesets

678 679 680 681 682 683 684 685 686 687 688 689 690
    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.
691 692 693 694 695 696
    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.
697

698 699 700 701
    .. container:: verbose

      Some examples:

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

          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
713
      - mark the current revision, or a known revision, to be skipped (e.g. if
714 715 716 717 718
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

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

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

723 724 725 726 727 728 729 730 731 732
      - 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
733
          hg bisect --command "make && make tests"
734 735 736 737 738 739

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

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

          hg log -r "bisect(range)"

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

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

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

755
    Returns 0 on success.
756 757 758 759 760 761 762 763 764 765 766
    """
    # 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
767
    elif extra:
768
        raise error.Abort(_('incompatible arguments'))
769

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

779 780 781 782 783
    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]))
784

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

789 790
    state = hbisect.load_state(repo)

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

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

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

817 818
    if command:
        changesets = 1
819 820 821 822
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
823
                raise error.Abort(_('current bisect revision is unknown - '
824
                                   'start a new bisect to fix'))
825
        else:
826 827
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
828
                raise error.Abort(_('current bisect revision is a merge'))