commands.py 202 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 43
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
44
    logcmdutil,
Gregory Szorc's avatar
Gregory Szorc committed
45 46
    merge as mergemod,
    obsolete,
47
    obsutil,
Gregory Szorc's avatar
Gregory Szorc committed
48 49
    patch,
    phases,
50
    pycompat,
51
    rcutil,
52
    registrar,
53
    revsetlang,
54
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
55
    scmutil,
56
    server,
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
from .utils import dateutil
Gregory Szorc's avatar
Gregory Szorc committed
65 66

release = lockmod.release
67

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

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

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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
    .. 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

243
    Returns 0 if all files are successfully added.
244
    """
245
    opts = pycompat.byteskwargs(opts)
246
    try:
247
        sim = float(opts.get('similarity') or 100)
248
    except ValueError:
249
        raise error.Abort(_('similarity must be a number'))
250
    if sim < 0 or sim > 100:
251
        raise error.Abort(_('similarity must be between 0 and 100'))
252
    matcher = scmutil.match(repo[None], pats, opts)
253
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
254

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

274
    List changes in files, showing the revision id responsible for
275
    each line.
276

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

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

283 284 285 286
    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.
287 288

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

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

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

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

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

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

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

354 355
    ui.pager('annotate')

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

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

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

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

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

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

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

408
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
409 410
            fm.startitem()
            fm.write(fields, "".join(f), *p)
411 412 413 414 415
            if l[0].skip:
                fmt = "* %s"
            else:
                fmt = ": %s"
            fm.write('line', fmt, l[1])
416

417
        if not lines[-1][1].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 563 564 565
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
566
        return _dobackout(ui, repo, node, rev, **opts)
567 568 569
    finally:
        release(lock, wlock)

570
def _dobackout(ui, repo, node=None, rev=None, **opts):
571
    opts = pycompat.byteskwargs(opts)
572 573
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
574 575
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
576

Daniel Holth's avatar
Daniel Holth committed
577
    if rev and node:
578
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
579 580 581

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

583
    if not rev:
584
        raise error.Abort(_("please specify a revision to backout"))
585

586 587
    date = opts.get('date')
    if date:
588
        opts['date'] = dateutil.parsedate(date)
589

590
    cmdutil.checkunfinished(repo)
591
    cmdutil.bailifchanged(repo)
592
    node = scmutil.revsingle(repo, rev).node()
593

594
    op1, op2 = repo.dirstate.parents()
595
    if not repo.changelog.isancestor(node, op1):
596
        raise error.Abort(_('cannot backout change that is not an ancestor'))
597

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

614
    # the backout should appear on the same branch
615 616 617 618
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
619
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
        try:
            ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                         'backout')
            stats = mergemod.update(repo, parent, True, True, node, False)
            repo.setparents(op1, op2)
            dsguard.close()
            hg._showstats(repo, stats)
            if stats[3]:
                repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                 "file merges\n"))
                return 1
        finally:
            ui.setconfig('ui', 'forcemerge', '', '')
            lockmod.release(dsguard)
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

639 640 641 642 643
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
644 645 646

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
647 648
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
        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()))
        try:
            ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                         'backout')
            return hg.merge(repo, hex(repo.changelog.tip()))
        finally:
            ui.setconfig('ui', 'forcemerge', '', '')
675
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
676

677 678 679 680 681 682 683 684 685
@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]"))
686
def bisect(ui, repo, rev=None, extra=None, command=None,
687 688
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
689 690
    """subdivision search of changesets

691 692 693 694 695 696 697 698 699 700 701 702 703
    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.
704 705 706 707 708 709
    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.
710

711 712 713 714
    .. container:: verbose

      Some examples:

715
      - start a bisection with known bad revision 34, and good revision 12::
716 717 718 719 720 721 722 723 724 725

          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
726
      - mark the current revision, or a known revision, to be skipped (e.g. if
727 728 729 730 731
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

732
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
733

734
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
735

736 737 738 739 740 741 742 743 744 745
      - 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
746
          hg bisect --command "make && make tests"
747 748 749 750 751 752

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

          hg log -r "bisect(pruned)"

753 754 755 756 757
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

758 759 760 761
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

762
      - you can even get a nice graph::
763 764 765

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

766
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
767

768
    Returns 0 on success.
769 770 771 772 773 774 775 776 777 778 779
    """
    # 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
780
    elif extra:
781
        raise error.Abort(_('incompatible arguments'))
782

783 784 785 786 787 788 789 790 791
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

792 793 794 795 796
    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]))
797

798
    if reset:
799
        hbisect.resetstate(repo)
800 801
        return

802 803
    state = hbisect.load_state(repo)

804 805 806 807 808 809 810 811 812 813 814 815 816
    # update state
    if good or bad or skip:
        if rev:
            nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
        else:
            nodes = [repo.lookup('.')]
        if good:
            state['good'] += nodes
        elif bad:
            state['bad'] += nodes
        elif skip:
            state['skip'] += nodes
        hbisect.save_state(repo, state)
817 818
        if not (state['good'] and state['bad']):
            return
819

820 821 822 823
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
824
        cmdutil.checkunfinished(repo)
825 826 827
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

828
    displayer = logcmdutil.changesetdisplayer(ui, repo, {})
829

830 831
    if command:
        changesets = 1
832 833 834 835
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
836
                raise error.Abort(_('current bisect revision is unknown - '
837
                                   'start a new bisect to fix'))
838
        else:
839 840
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
841
                raise error.Abort(_('current bisect revision is a merge'))
842 843
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
844 845 846
        try:
            while changesets:
                # update state
847
                state['current'] = [node]
848
                hbisect.save_state(repo, state)