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

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

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

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

353 354
    ui.pager('annotate')

355
    if rootfm.isplain():
356
        def makefunc(get, fmt):
357
            return lambda x: fmt(get(x))
358 359
    else:
        def makefunc(get, fmt):
360
            return get
361
    datahint = rootfm.datahint()
362
    funcmap = [(makefunc(get, fmt), sep) for fn, sep, get, fmt in opmap
363
               if opts.get(opnamemap.get(fn, fn)) or fn in datahint]
364
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
365
    fields = ' '.join(fn for fn, sep, get, fmt in opmap
366
                      if opts.get(opnamemap.get(fn, fn)) or fn in datahint)
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', tmpl='{rev}: {line}')
390 391
        lines = fctx.annotate(follow=follow, 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 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, n in zip(zip(*formats), zip(*pieces), lines):
409
            fm.startitem()
410
            fm.context(fctx=n.fctx)
411
            fm.write(fields, "".join(f), *p)
412
            if n.skip:
413 414 415
                fmt = "* %s"
            else:
                fmt = ": %s"
416
            fm.write('line', fmt, n.text)
417

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

422
    rootfm.end()
423

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

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

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

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

453
    Valid types are:
454

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

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

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

    Returns 0 on success.
471 472
    '''

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

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

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

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

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

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

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

521
    .. note::
522

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

699 700 701 702
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

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

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

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

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

          hg log -r "bisect(range)"

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

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

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

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

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

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

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

790 791
    state = hbisect.load_state(repo)

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

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

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

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