commands.py 221 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

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

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

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

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
    .. container:: verbose

      Template:

      The following keywords are supported in addition to the common template
      keywords and functions. See also :hg:`help templates`.

      :lines:   List of lines with annotation data.
      :path:    String. Repository-absolute path of the specified file.

      And each entry of ``{lines}`` provides the following sub-keywords in
      addition to ``{date}``, ``{node}``, ``{rev}``, ``{user}``, etc.

      :line:    String. Line content.
      :lineno:  Integer. Line number at that revision.
      :path:    String. Repository-absolute path of the file at that revision.

      See :hg:`help templates.operators` for the list expansion syntax.

309
    Returns 0 on success.
310
    """
311
    opts = pycompat.byteskwargs(opts)
312
    if not pats:
313
        raise error.Abort(_('at least one filename or pattern is required'))
314

315 316 317
    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
318
        opts['file'] = True
319

320 321 322 323
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
324

325
    rootfm = ui.formatter('annotate', opts)
326 327 328 329 330
    if ui.debugflag:
        shorthex = pycompat.identity
    else:
        def shorthex(h):
            return h[:12]
331
    if ui.quiet:
332
        datefunc = dateutil.shortdate
333
    else:
334
        datefunc = dateutil.datestr
335 336 337 338
    if ctx.rev() is None:
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
339
                if rev == wdirrev:
340 341 342 343 344
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
345
                if rev == wdirrev:
346 347 348
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
349
        def formathex(h):
350
            if h == wdirhex:
351
                return '%s+' % shorthex(hex(ctx.p1().node()))
352
            else:
353
                return '%s ' % shorthex(h)
354
    else:
355 356
        formatrev = b'%d'.__mod__
        formathex = shorthex
357

358
    opmap = [('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
359 360
             ('rev', ' ', lambda x: scmutil.intrev(x.fctx), formatrev),
             ('node', ' ', lambda x: hex(scmutil.binnode(x.fctx)), formathex),
361
             ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
362
             ('path', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
363
             ('lineno', ':', lambda x: x.lineno, pycompat.bytestr),
364
            ]
365 366
    opnamemap = {'rev': 'number', 'node': 'changeset', 'path': 'file',
                 'lineno': 'line_number'}
367

368
    if (not opts.get('user') and not opts.get('changeset')
369
        and not opts.get('date') and not opts.get('file')):
370
        opts['number'] = True
371

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

376 377
    ui.pager('annotate')

378
    if rootfm.isplain():
379
        def makefunc(get, fmt):
380
            return lambda x: fmt(get(x))
381 382
    else:
        def makefunc(get, fmt):
383
            return get
384
    datahint = rootfm.datahint()
385
    funcmap = [(makefunc(get, fmt), sep) for fn, sep, get, fmt in opmap
386
               if opts.get(opnamemap.get(fn, fn)) or fn in datahint]
387
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
388
    fields = ' '.join(fn for fn, sep, get, fmt in opmap
389
                      if opts.get(opnamemap.get(fn, fn)) or fn in datahint)
390

391
    def bad(x, y):
392
        raise error.Abort("%s: %s" % (x, y))
393

394 395
    m = scmutil.match(ctx, pats, opts, badfn=bad)

396
    follow = not opts.get('no_follow')
397 398
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
399 400 401 402
    skiprevs = opts.get('skip')
    if skiprevs:
        skiprevs = scmutil.revrange(repo, skiprevs)

Matt Mackall's avatar
Matt Mackall committed
403 404
    for abs in ctx.walk(m):
        fctx = ctx[abs]
405
        rootfm.startitem()
406
        rootfm.data(path=abs)
Jun Wu's avatar
Jun Wu committed
407
        if not opts.get('text') and fctx.isbinary():
408 409
            rootfm.plain(_("%s: binary file\n")
                         % ((pats and m.rel(abs)) or abs))
410 411
            continue

412
        fm = rootfm.nested('lines', tmpl='{rev}: {line}')
413 414
        lines = fctx.annotate(follow=follow, skiprevs=skiprevs,
                              diffopts=diffopts)
415
        if not lines:
416
            fm.end()
417
            continue
418
        formats = []
419 420
        pieces = []

421
        for f, sep in funcmap:
422
            l = [f(n) for n in lines]
423
            if fm.isplain():
424 425 426
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
427 428
            else:
                formats.append(['%s' for x in l])
429
            pieces.append(l)
430

431
        for f, p, n in zip(zip(*formats), zip(*pieces), lines):
432
            fm.startitem()
433
            fm.context(fctx=n.fctx)
434
            fm.write(fields, "".join(f), *p)
435
            if n.skip:
436 437 438
                fmt = "* %s"
            else:
                fmt = ": %s"
439
            fm.write('line', fmt, n.text)
440

441
        if not lines[-1].text.endswith('\n'):
442
            fm.plain('\n')
443
        fm.end()
444

445
    rootfm.end()
446

447 448 449 450 451 452 453 454
@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'))
455
def archive(ui, repo, dest, **opts):
456
    '''create an unversioned archive of a repository revision
457

458 459
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
460

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

Matt Mackall's avatar
Matt Mackall committed
464 465 466 467 468 469 470 471 472 473 474 475
    .. 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*"

476
    Valid types are:
477

478 479 480 481 482 483
    :``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
484

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

488 489 490 491
    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.
492 493

    Returns 0 on success.
494 495
    '''

496
    opts = pycompat.byteskwargs(opts)
497 498 499 500
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
501
    if not ctx:
502
        raise error.Abort(_('no working directory: please specify a revision'))
503
    node = ctx.node()
504
    dest = cmdutil.makefilename(ctx, dest)
505
    if os.path.realpath(dest) == repo.root:
506
        raise error.Abort(_('repository root cannot be destination'))
507

508
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
509
    prefix = opts.get('prefix')
510

511 512
    if dest == '-':
        if kind == 'files':
513
            raise error.Abort(_('cannot archive plain files to stdout'))
514
        dest = cmdutil.makefileobj(ctx, dest)
515 516
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
517

518
    prefix = cmdutil.makefilename(ctx, prefix)
519
    match = scmutil.match(ctx, [], opts)
520
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
521
                     match, prefix, subrepos=opts.get('subrepos'))
522

523 524
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
525 526 527
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
528 529
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
530
    ('r', 'rev', '', _('revision to backout'), _('REV')),
531
    ('e', 'edit', False, _('invoke editor on commit messages')),
532
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
533
    _('[OPTION]... [-r] REV'))
534
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
535 536
    '''reverse effect of earlier changeset

537
    Prepare a new changeset with the effect of REV undone in the
538 539
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
540

541
    If REV is the parent of the working directory, then this new changeset
542
    is committed automatically (unless --no-commit is specified).
543

544
    .. note::
545

546
       :hg:`backout` cannot be used to fix either an unwanted or
547
       incorrect merge.
548

Matt Mackall's avatar
Matt Mackall committed
549 550
    .. container:: verbose

551 552 553 554 555 556 557 558 559 560 561 562
      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
563
        leave changes uncommitted::
564

565 566
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
567

Matt Mackall's avatar
Matt Mackall committed
568 569 570 571 572 573 574 575 576
      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.
577

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

580 581 582
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

583 584
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
585
    '''
586
    with repo.wlock(), repo.lock():
587
        return _dobackout(ui, repo, node, rev, **opts)
588

589
def _dobackout(ui, repo, node=None, rev=None, **opts):
590
    opts = pycompat.byteskwargs(opts)
591 592
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
593 594
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
595

Daniel Holth's avatar
Daniel Holth committed
596
    if rev and node:
597
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
598 599 600

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

602
    if not rev:
603
        raise error.Abort(_("please specify a revision to backout"))
604

605 606
    date = opts.get('date')
    if date:
607
        opts['date'] = dateutil.parsedate(date)
608

609
    cmdutil.checkunfinished(repo)
610
    cmdutil.bailifchanged(repo)
611
    node = scmutil.revsingle(repo, rev).node()
612

613
    op1, op2 = repo.dirstate.parents()
614
    if not repo.changelog.isancestor(node, op1):
615
        raise error.Abort(_('cannot backout change that is not an ancestor'))
616

617 618
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
619
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
620
    if p2 != nullid:
621
        if not opts.get('parent'):
622
            raise error.Abort(_('cannot backout a merge changeset'))
623 624
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
625
            raise error.Abort(_('%s is not a parent of %s') %
626
                             (short(p), short(node)))
627 628
        parent = p
    else:
629
        if opts.get('parent'):
630
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
631
        parent = p1
632

633
    # the backout should appear on the same branch
634 635 636 637
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
638
        with dirstateguard.dirstateguard(repo, 'backout'):
639 640 641
            overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
            with ui.configoverride(overrides, 'backout'):
                stats = mergemod.update(repo, parent, True, True, node, False)
642
            repo.setparents(op1, op2)
643 644 645 646 647
        hg._showstats(repo, stats)
        if stats.unresolvedcount:
            repo.ui.status(_("use 'hg resolve' to retry unresolved "
                             "file merges\n"))
            return 1
648 649 650 651 652
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

653 654 655 656 657
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
658 659 660

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
661 662
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
        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()))
683 684
        overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
        with ui.configoverride(overrides, 'backout'):
685
            return hg.merge(repo, hex(repo.changelog.tip()))
686
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
687

688 689 690 691 692 693 694 695 696
@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]"))
697
def bisect(ui, repo, rev=None, extra=None, command=None,
698 699
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
700 701
    """subdivision search of changesets

702 703 704 705 706 707 708 709 710 711 712 713 714
    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.
715 716 717 718 719 720
    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.
721

722 723 724 725
    .. container:: verbose

      Some examples:

726
      - start a bisection with known bad revision 34, and good revision 12::
727 728 729 730 731 732 733 734 735 736

          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
737
      - mark the current revision, or a known revision, to be skipped (e.g. if
738 739 740 741 742
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

743
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
744

745
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
746

747 748 749 750 751 752 753 754 755 756
      - 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
757
          hg bisect --command "make && make tests"
758 759 760 761 762 763

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

          hg log -r "bisect(pruned)"

764 765 766 767 768
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

769 770 771 772
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

773
      - you can even get a nice graph::
774 775 776

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

777
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
778

779
    Returns 0 on success.
780 781 782 783 784 785 786 787 788 789 790
    """
    # 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
791
    elif extra:
792
        raise error.Abort(_('incompatible arguments'))
793

794 795 796 797 798 799 800 801 802
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

803 804 805 806 807
    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]))
808

809
    if reset:
810
        hbisect.resetstate(repo)
811 812
        return

813 814
    state = hbisect.load_state(repo)

815 816 817
    # update state
    if good or bad or skip:
        if rev:
818
            nodes = [repo[i].node() for i in scmutil.revrange(repo, [rev])]
819 820 821 822 823 824 825 826 827
        else:
            nodes = [repo.lookup('.')]
        if good:
            state['good'] += nodes
        elif bad:
            state['bad'] += nodes
        elif skip:
            state['skip'] += nodes
        hbisect.save_state(repo, state)
828 829
        if not