commands.py 216 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,
38
    filemerge,
Yuya Nishihara's avatar
Yuya Nishihara committed
39
    formatter,
Gregory Szorc's avatar
Gregory Szorc committed
40 41 42 43
    graphmod,
    hbisect,
    help,
    hg,
44
    logcmdutil,
45
    match as matchmod,
Gregory Szorc's avatar
Gregory Szorc committed
46
    merge as mergemod,
47
    narrowspec,
Gregory Szorc's avatar
Gregory Szorc committed
48
    obsolete,
49
    obsutil,
Gregory Szorc's avatar
Gregory Szorc committed
50 51
    patch,
    phases,
52
    pycompat,
53
    rcutil,
54
    registrar,
55
    repair,
56
    revsetlang,
57
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
58
    scmutil,
59
    server,
60
    state as statemod,
Gregory Szorc's avatar
Gregory Szorc committed
61
    streamclone,
62
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
63 64 65
    templatekw,
    ui as uimod,
    util,
66
    wireprotoserver,
Gregory Szorc's avatar
Gregory Szorc committed
67
)
68 69 70 71
from .utils import (
    dateutil,
    stringutil,
)
Gregory Szorc's avatar
Gregory Szorc committed
72

73
table = {}
74
table.update(debugcommandsmod.command._table)
75

76
command = registrar.command(table)
77
INTENT_READONLY = registrar.INTENT_READONLY
78 79 80 81 82 83 84 85 86 87

# common command options

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

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
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
130

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

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

140 141
    Schedule files to be version controlled and added to the
    repository.
142

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

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

    .. container:: verbose

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

    Returns 0 if all files are successfully added.
178 179
    """

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

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

191 192
    Add all new files and remove all missing files from the
    repository.
193

timeless's avatar
timeless committed
194 195 196
    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.
197

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

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

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

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

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

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

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

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

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

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

305
    rootfm = ui.formatter('annotate', opts)
306 307 308 309 310
    if ui.debugflag:
        shorthex = pycompat.identity
    else:
        def shorthex(h):
            return h[:12]
311
    if ui.quiet:
312
        datefunc = dateutil.shortdate
313
    else:
314
        datefunc = dateutil.datestr
315 316 317 318 319
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
320
                return hex(node)
321 322 323 324 325 326 327 328 329 330 331 332 333
        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
334 335 336
        def formathex(h):
            if h is None:
                return '%s+' % shorthex(hex(ctx.p1().node()))
337
            else:
338
                return '%s ' % shorthex(h)
339
    else:
340 341 342
        hexfn = hex
        formatrev = b'%d'.__mod__
        formathex = shorthex
343

344
    opmap = [('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
345 346
             ('rev', ' ', lambda x: x.fctx.rev(), formatrev),
             ('node', ' ', lambda x: hexfn(x.fctx.node()), formathex),
347
             ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
348
             ('path', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
349
             ('line_number', ':', lambda x: x.lineno, pycompat.bytestr),
350
            ]
351
    opnamemap = {'rev': 'number', 'node': 'changeset', 'path': 'file'}
352

353
    if (not opts.get('user') and not opts.get('changeset')
354
        and not opts.get('date') and not opts.get('file')):
355
        opts['number'] = True
356

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

361 362
    ui.pager('annotate')

363
    if rootfm.isplain():
364
        def makefunc(get, fmt):
365
            return lambda x: fmt(get(x))
366 367
    else:
        def makefunc(get, fmt):
368
            return get
369
    datahint = rootfm.datahint()
370
    funcmap = [(makefunc(get, fmt), sep) for fn, sep, get, fmt in opmap
371
               if opts.get(opnamemap.get(fn, fn)) or fn in datahint]
372
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
373
    fields = ' '.join(fn for fn, sep, get, fmt in opmap
374
                      if opts.get(opnamemap.get(fn, fn)) or fn in datahint)
375

376
    def bad(x, y):
377
        raise error.Abort("%s: %s" % (x, y))
378

379 380
    m = scmutil.match(ctx, pats, opts, badfn=bad)

381
    follow = not opts.get('no_follow')
382 383
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
384 385 386 387
    skiprevs = opts.get('skip')
    if skiprevs:
        skiprevs = scmutil.revrange(repo, skiprevs)

Matt Mackall's avatar
Matt Mackall committed
388 389
    for abs in ctx.walk(m):
        fctx = ctx[abs]
390
        rootfm.startitem()
391
        rootfm.data(path=abs)
Jun Wu's avatar
Jun Wu committed
392
        if not opts.get('text') and fctx.isbinary():
393 394
            rootfm.plain(_("%s: binary file\n")
                         % ((pats and m.rel(abs)) or abs))
395 396
            continue

397
        fm = rootfm.nested('lines', tmpl='{rev}: {line}')
398 399
        lines = fctx.annotate(follow=follow, skiprevs=skiprevs,
                              diffopts=diffopts)
400
        if not lines:
401
            fm.end()
402
            continue
403
        formats = []
404 405
        pieces = []

406
        for f, sep in funcmap:
407
            l = [f(n) for n in lines]
408
            if fm.isplain():
409 410 411
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
412 413
            else:
                formats.append(['%s' for x in l])
414
            pieces.append(l)
415

416
        for f, p, n in zip(zip(*formats), zip(*pieces), lines):
417
            fm.startitem()
418
            fm.context(fctx=n.fctx)
419
            fm.write(fields, "".join(f), *p)
420
            if n.skip:
421 422 423
                fmt = "* %s"
            else:
                fmt = ": %s"
424
            fm.write('line', fmt, n.text)
425

426
        if not lines[-1].text.endswith('\n'):
427
            fm.plain('\n')
428
        fm.end()
429

430
    rootfm.end()
431

432 433 434 435 436 437 438 439
@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'))
440
def archive(ui, repo, dest, **opts):
441
    '''create an unversioned archive of a repository revision
442

443 444
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
445

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

Matt Mackall's avatar
Matt Mackall committed
449 450 451 452 453 454 455 456 457 458 459 460
    .. 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*"

461
    Valid types are:
462

463 464 465 466 467 468
    :``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
469

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

473 474 475 476
    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.
477 478

    Returns 0 on success.
479 480
    '''

481
    opts = pycompat.byteskwargs(opts)
482 483 484 485
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
486
    if not ctx:
487
        raise error.Abort(_('no working directory: please specify a revision'))
488
    node = ctx.node()
489
    dest = cmdutil.makefilename(ctx, dest)
490
    if os.path.realpath(dest) == repo.root:
491
        raise error.Abort(_('repository root cannot be destination'))
492

493
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
494
    prefix = opts.get('prefix')
495

496 497
    if dest == '-':
        if kind == 'files':
498
            raise error.Abort(_('cannot archive plain files to stdout'))
499
        dest = cmdutil.makefileobj(ctx, dest)
500 501
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
502

503
    prefix = cmdutil.makefilename(ctx, prefix)
504
    match = scmutil.match(ctx, [], opts)
505
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
506
                     match, prefix, subrepos=opts.get('subrepos'))
507

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

522
    Prepare a new changeset with the effect of REV undone in the
523 524
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
525

526
    If REV is the parent of the working directory, then this new changeset
527
    is committed automatically (unless --no-commit is specified).
528

529
    .. note::
530

531
       :hg:`backout` cannot be used to fix either an unwanted or
532
       incorrect merge.
533

Matt Mackall's avatar
Matt Mackall committed
534 535
    .. container:: verbose

536 537 538 539 540 541 542 543 544 545 546 547
      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
548
        leave changes uncommitted::
549

550 551
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
552

Matt Mackall's avatar
Matt Mackall committed
553 554 555 556 557 558 559 560 561
      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.
562

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

565 566 567
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

568 569
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
570
    '''
571
    with repo.wlock(), repo.lock():
572
        return _dobackout(ui, repo, node, rev, **opts)
573

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

Daniel Holth's avatar
Daniel Holth committed
581
    if rev and node:
582
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
583 584 585

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

587
    if not rev:
588
        raise error.Abort(_("please specify a revision to backout"))
589

590 591
    date = opts.get('date')
    if date:
592
        opts['date'] = dateutil.parsedate(date)
593

594
    cmdutil.checkunfinished(repo)
595
    cmdutil.bailifchanged(repo)
596
    node = scmutil.revsingle(repo, rev).node()
597

598
    op1, op2 = repo.dirstate.parents()
599
    if not repo.changelog.isancestor(node, op1):
600
        raise error.Abort(_('cannot backout change that is not an ancestor'))
601

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

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

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

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

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

687 688 689 690 691 692 693 694 695 696 697 698 699
    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.
700 701 702 703 704 705
    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.
706

707 708 709 710
    .. container:: verbose

      Some examples:

711
      - start a bisection with known bad revision 34, and good revision 12::
712 713 714 715 716 717 718 719 720 721

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

          hg bisect --skip
          hg bisect --skip 23

728
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
729

730
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
731

732 733 734 735 736 737 738 739 740 741
      - 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
742
          hg bisect --command "make && make tests"
743 744 745 746 747 748

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

          hg log -r "bisect(pruned)"

749 750 751 752 753
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

754 755 756 757
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

758
      - you can even get a nice graph::
759 760 761

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

762
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
763

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

779 780 781 782 783 784 785 786 787
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

788 789 790 791 792
    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]))
793

794
    if reset:
795
        hbisect.resetstate(repo)
796 797
        return

798 799
    state = hbisect.load_state(repo)

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

816 817 818 819
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
820
        cmdutil.checkunfinished(repo)
821 822 823
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

824
    displayer = logcmdutil.changesetdisplayer(ui, repo, {})
825