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

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,
47
    match as matchmod,
Gregory Szorc's avatar
Gregory Szorc committed
48
    merge as mergemod,
49
    narrowspec,
Gregory Szorc's avatar
Gregory Szorc committed
50
    obsolete,
51
    obsutil,
Gregory Szorc's avatar
Gregory Szorc committed
52 53
    patch,
    phases,
54
    pycompat,
55
    rcutil,
56
    registrar,
57
    repair,
58
    revsetlang,
59
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
60
    scmutil,
61
    server,
62
    state as statemod,
Gregory Szorc's avatar
Gregory Szorc committed
63
    streamclone,
64
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
65 66 67
    templatekw,
    ui as uimod,
    util,
68
    wireprotoserver,
Gregory Szorc's avatar
Gregory Szorc committed
69
)
70 71 72 73
from .utils import (
    dateutil,
    stringutil,
)
Gregory Szorc's avatar
Gregory Szorc committed
74

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

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

# common command options

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

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

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

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

307
    rootfm = ui.formatter('annotate', opts)
308 309 310 311 312
    if ui.debugflag:
        shorthex = pycompat.identity
    else:
        def shorthex(h):
            return h[:12]
313
    if ui.quiet:
314
        datefunc = dateutil.shortdate
315
    else:
316
        datefunc = dateutil.datestr
317 318 319 320
    if ctx.rev() is None:
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
321
                if rev == wdirrev:
322 323 324 325 326
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
327
                if rev == wdirrev:
328 329 330
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
331
        def formathex(h):
332
            if h == wdirhex:
333
                return '%s+' % shorthex(hex(ctx.p1().node()))
334
            else:
335
                return '%s ' % shorthex(h)
336
    else:
337 338
        formatrev = b'%d'.__mod__
        formathex = shorthex
339

340
    opmap = [('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
341 342
             ('rev', ' ', lambda x: scmutil.intrev(x.fctx), formatrev),
             ('node', ' ', lambda x: hex(scmutil.binnode(x.fctx)), formathex),
343
             ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
344
             ('path', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
345
             ('lineno', ':', lambda x: x.lineno, pycompat.bytestr),
346
            ]
347 348
    opnamemap = {'rev': 'number', 'node': 'changeset', 'path': 'file',
                 'lineno': 'line_number'}
349

350
    if (not opts.get('user') and not opts.get('changeset')
351
        and not opts.get('date') and not opts.get('file')):
352
        opts['number'] = True
353

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

358 359
    ui.pager('annotate')

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

373
    def bad(x, y):
374
        raise error.Abort("%s: %s" % (x, y))
375

376 377
    m = scmutil.match(ctx, pats, opts, badfn=bad)

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

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

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

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

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

423
        if not lines[-1].text.endswith('\n'):
424
            fm.plain('\n')
425
        fm.end()
426

427
    rootfm.end()
428

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

440 441
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
442

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

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

458
    Valid types are:
459

460 461 462 463 464 465
    :``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
466

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

470 471 472 473
    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.
474 475

    Returns 0 on success.
476 477
    '''

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

490
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
491
    prefix = opts.get('prefix')
492

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

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

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

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

523
    If REV is the parent of the working directory, then this new changeset
524
    is committed automatically (unless --no-commit is specified).
525

526
    .. note::
527

528
       :hg:`backout` cannot be used to fix either an unwanted or
529
       incorrect merge.
530

Matt Mackall's avatar
Matt Mackall committed
531 532
    .. container:: verbose

533 534 535 536 537 538 539 540 541 542 543 544
      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
545
        leave changes uncommitted::
546

547 548
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
549

Matt Mackall's avatar
Matt Mackall committed
550 551 552 553 554 555 556 557 558
      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.
559

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

562 563 564
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

704 705 706 707
    .. container:: verbose

      Some examples:

708
      - start a bisection with known bad revision 34, and good revision 12::
709 710 711 712 713 714 715 716 717 718

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

          hg bisect --skip
          hg bisect --skip 23

725
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
726

727
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
728

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

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

          hg log -r "bisect(pruned)"

746 747 748 749 750
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

751 752 753 754
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

755
      - you can even get a nice graph::
756 757 758

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

759
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
760

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

776 777 778 779 780 781 782 783 784
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

785 786 787 788 789
    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]))
790

791
    if reset:
792
        hbisect.resetstate(repo)
793 794
        return

795 796
    state = hbisect.load_state(repo)

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

813 814 815 816
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
817
        cmdutil.checkunfinished(repo)