commands.py 198 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 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
from __future__ import absolute_import

import difflib
import errno
import os
import re

from .i18n import _
from .node import (
    hex,
    nullid,
    nullrev,
    short,
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    copies,
    destutil,
30
    dirstateguard,
Gregory Szorc's avatar
Gregory Szorc committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44
    discovery,
    encoding,
    error,
    exchange,
    extensions,
    graphmod,
    hbisect,
    help,
    hg,
    lock as lockmod,
    merge as mergemod,
    obsolete,
    patch,
    phases,
45
    pycompat,
46
    rcutil,
47
    revsetlang,
Gregory Szorc's avatar
Gregory Szorc committed
48
    scmutil,
49
    server,
Gregory Szorc's avatar
Gregory Szorc committed
50 51
    sshserver,
    streamclone,
52
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
53 54 55 56 57 58
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
59

60 61 62 63
table = {}

command = cmdutil.command(table)

64 65 66 67 68 69
# label constants
# until 3.5, bookmarks.current was the advertised name, not
# bookmarks.active, so we must use both to avoid breaking old
# custom styles
activebookmarklabel = 'bookmarks.active bookmarks.current'

70 71 72 73 74 75 76 77 78
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
79
     _('do not prompt, automatically pick the first choice for all prompts')),
80 81
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
82
    ('', 'color', '',
83 84
     # i18n: 'always', 'auto', 'never', and 'debug' are keywords
     # and should not be translated
85
     _("when to colorize (boolean, always, auto, never, or debug)"),
86
     _('TYPE')),
87 88 89 90 91 92 93 94 95 96 97 98 99 100
    ('', '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')),
101
    ('', 'hidden', False, _('consider hidden changesets')),
102 103
    ('', 'pager', 'auto',
     _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
]

dryrunopts = [('n', 'dry-run', None,
               _('do not perform actions, just print output'))]

remoteopts = [
    ('e', 'ssh', '',
     _('specify ssh command to use'), _('CMD')),
    ('', 'remotecmd', '',
     _('specify hg command to run on the remote side'), _('CMD')),
    ('', 'insecure', None,
     _('do not verify server certificate (ignoring web.cacerts config)')),
]

walkopts = [
    ('I', 'include', [],
     _('include names matching the given patterns'), _('PATTERN')),
    ('X', 'exclude', [],
     _('exclude names matching the given patterns'), _('PATTERN')),
]

commitopts = [
    ('m', 'message', '',
     _('use text as commit message'), _('TEXT')),
    ('l', 'logfile', '',
     _('read commit message from file'), _('FILE')),
]

commitopts2 = [
    ('d', 'date', '',
     _('record the specified date as commit date'), _('DATE')),
    ('u', 'user', '',
     _('record the specified user as committer'), _('USER')),
]

139 140 141
# hidden for now
formatteropts = [
    ('T', 'template', '',
142
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
143 144
]

145 146
templateopts = [
    ('', 'style', '',
147
     _('display using template map file (DEPRECATED)'), _('STYLE')),
148
    ('T', 'template', '',
149 150 151 152 153 154 155 156 157 158
     _('display with template'), _('TEMPLATE')),
]

logopts = [
    ('p', 'patch', None, _('show patch')),
    ('g', 'git', None, _('use git extended diff format')),
    ('l', 'limit', '',
     _('limit number of changes displayed'), _('NUM')),
    ('M', 'no-merges', None, _('do not show merges')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
159
    ('G', 'graph', None, _("show the revision DAG")),
160 161 162 163 164
] + templateopts

diffopts = [
    ('a', 'text', None, _('treat all files as text')),
    ('g', 'git', None, _('use git extended diff format')),
165
    ('', 'binary', None, _('generate binary diffs in git mode (default)')),
166 167 168
    ('', 'nodates', None, _('omit dates from diff headers'))
]

169
diffwsopts = [
170 171 172 173 174 175
    ('w', 'ignore-all-space', None,
     _('ignore white space when comparing lines')),
    ('b', 'ignore-space-change', None,
     _('ignore changes in the amount of white space')),
    ('B', 'ignore-blank-lines', None,
     _('ignore changes whose lines are all blank')),
176 177 178
    ]

diffopts2 = [
179
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
180 181 182
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
183 184 185
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
186
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
187 188
]

189 190 191 192
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

193 194 195 196 197 198 199 200 201 202
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

subrepoopts = [
    ('S', 'subrepos', None,
     _('recurse into subrepositories'))
]

203 204 205
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
206
    ('', 'dir', '', _('open directory manifest')),
207 208
]

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

211 212
@command('^add',
    walkopts + subrepoopts + dryrunopts,
213 214
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
215
def add(ui, repo, *pats, **opts):
216 217
    """add the specified files on the next commit

218 219
    Schedule files to be version controlled and added to the
    repository.
220

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

timeless's avatar
timeless committed
224 225
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
226 227 228

    .. container:: verbose

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
       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
254 255

    Returns 0 if all files are successfully added.
256 257
    """

258
    opts = pycompat.byteskwargs(opts)
259
    m = scmutil.match(repo[None], pats, opts)
260
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
261
    return rejected and 1 or 0
262

263
@command('addremove',
264
    similarityopts + subrepoopts + walkopts + dryrunopts,
265 266
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
267
def addremove(ui, repo, *pats, **opts):
268
    """add all new files, delete all missing files
269

270 271
    Add all new files and remove all missing files from the
    repository.
272

timeless's avatar
timeless committed
273 274 275
    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.
276

277
    Use the -s/--similarity option to detect renamed files. This
278
    option takes a percentage between 0 (disabled) and 100 (files must
279 280 281
    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
282
    can be expensive. After using this option, :hg:`status -C` can be
283 284 285
    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.
286

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
    .. 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

327
    Returns 0 if all files are successfully added.
328
    """
329
    opts = pycompat.byteskwargs(opts)
330
    try:
331
        sim = float(opts.get('similarity') or 100)
332
    except ValueError:
333
        raise error.Abort(_('similarity must be a number'))
334
    if sim < 0 or sim > 100:
335
        raise error.Abort(_('similarity must be between 0 and 100'))
336
    matcher = scmutil.match(repo[None], pats, opts)
337
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
338

339 340 341 342 343 344 345 346 347 348 349 350
@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')),
    ('l', 'line-number', None, _('show line number at the first appearance'))
351
    ] + diffwsopts + walkopts + formatteropts,
352 353
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
354
def annotate(ui, repo, *pats, **opts):
355
    """show changeset information by line for each file
356

357
    List changes in files, showing the revision id responsible for
358
    each line.
359

360 361
    This command is useful for discovering when a change was made and
    by whom.
362

363 364 365
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

366 367 368 369
    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.
370 371

    Returns 0 on success.
372
    """
373
    opts = pycompat.byteskwargs(opts)
374
    if not pats:
375
        raise error.Abort(_('at least one filename or pattern is required'))
376

377 378 379
    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
380
        opts['file'] = True
381

382 383
    ctx = scmutil.revsingle(repo, opts.get('rev'))

384
    fm = ui.formatter('annotate', opts)
385 386 387 388
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
                return fm.hexfunc(node)
        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:
                return '%s+' % fm.hexfunc(ctx.p1().node())
            else:
                return '%s ' % hex
    else:
        hexfn = fm.hexfunc
        formatrev = formathex = str
416

417
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
418 419
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
420 421 422
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
423
            ]
424
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
425

426
    if (not opts.get('user') and not opts.get('changeset')
427
        and not opts.get('date') and not opts.get('file')):
428
        opts['number'] = True
429

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

434 435
    ui.pager('annotate')

436
    if fm.isplain():
437
        def makefunc(get, fmt):
438
            return lambda x: fmt(get(x))
439 440
    else:
        def makefunc(get, fmt):
441
            return get
442 443
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
444
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
445 446
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
447

448
    def bad(x, y):
449
        raise error.Abort("%s: %s" % (x, y))
450

451 452
    m = scmutil.match(ctx, pats, opts, badfn=bad)

453
    follow = not opts.get('no_follow')
454 455
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
456 457
    for abs in ctx.walk(m):
        fctx = ctx[abs]
Jun Wu's avatar
Jun Wu committed
458
        if not opts.get('text') and fctx.isbinary():
459
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
460 461
            continue

462 463
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
464 465
        if not lines:
            continue
466
        formats = []
467 468
        pieces = []

469
        for f, sep in funcmap:
470
            l = [f(n) for n, dummy in lines]
471
            if fm.isplain():
472 473 474
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
475 476
            else:
                formats.append(['%s' for x in l])
477
            pieces.append(l)
478

479
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
480 481 482
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
483

484
        if not lines[-1][1].endswith('\n'):
485 486 487
            fm.plain('\n')

    fm.end()
488

489 490 491 492 493 494 495 496
@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'))
497
def archive(ui, repo, dest, **opts):
498
    '''create an unversioned archive of a repository revision
499

500 501
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
502

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

Matt Mackall's avatar
Matt Mackall committed
506 507 508 509 510 511 512 513 514 515 516 517
    .. 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*"

518
    Valid types are:
519

520 521 522 523 524 525
    :``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
526

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

530 531 532 533
    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.
534 535

    Returns 0 on success.
536 537
    '''

538
    opts = pycompat.byteskwargs(opts)
539
    ctx = scmutil.revsingle(repo, opts.get('rev'))
540
    if not ctx:
541
        raise error.Abort(_('no working directory: please specify a revision'))
542
    node = ctx.node()
543
    dest = cmdutil.makefilename(repo, dest, node)
544
    if os.path.realpath(dest) == repo.root:
545
        raise error.Abort(_('repository root cannot be destination'))
546

547
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
548
    prefix = opts.get('prefix')
549

550 551
    if dest == '-':
        if kind == 'files':
552
            raise error.Abort(_('cannot archive plain files to stdout'))
553
        dest = cmdutil.makefileobj(repo, dest)
554 555
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
556

557
    prefix = cmdutil.makefilename(repo, prefix, node)
558
    matchfn = scmutil.match(ctx, [], opts)
559
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
560
                     matchfn, prefix, subrepos=opts.get('subrepos'))
561

562 563
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
564 565 566
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
567 568
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
569
    ('r', 'rev', '', _('revision to backout'), _('REV')),
570
    ('e', 'edit', False, _('invoke editor on commit messages')),
571
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
572
    _('[OPTION]... [-r] REV'))
573
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
574 575
    '''reverse effect of earlier changeset

576
    Prepare a new changeset with the effect of REV undone in the
577 578
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
579

580
    If REV is the parent of the working directory, then this new changeset
581
    is committed automatically (unless --no-commit is specified).
582

583
    .. note::
584

585
       :hg:`backout` cannot be used to fix either an unwanted or
586
       incorrect merge.
587

Matt Mackall's avatar
Matt Mackall committed
588 589
    .. container:: verbose

590 591 592 593 594 595 596 597 598 599 600 601
      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
602
        leave changes uncommitted::
603

604 605
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
606

Matt Mackall's avatar
Matt Mackall committed
607 608 609 610 611 612 613 614 615
      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.
616

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

619 620 621
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

622 623
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
624
    '''
625 626 627 628
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
629
        return _dobackout(ui, repo, node, rev, **opts)
630 631 632
    finally:
        release(lock, wlock)

633
def _dobackout(ui, repo, node=None, rev=None, **opts):
634
    opts = pycompat.byteskwargs(opts)
635 636
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
637 638
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
639

Daniel Holth's avatar
Daniel Holth committed
640
    if rev and node:
641
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
642 643 644

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

646
    if not rev:
647
        raise error.Abort(_("please specify a revision to backout"))
648

649 650 651 652
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

653
    cmdutil.checkunfinished(repo)
654
    cmdutil.bailifchanged(repo)
655
    node = scmutil.revsingle(repo, rev).node()
656

657
    op1, op2 = repo.dirstate.parents()
658
    if not repo.changelog.isancestor(node, op1):
659
        raise error.Abort(_('cannot backout change that is not an ancestor'))
660

661 662
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
663
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
664
    if p2 != nullid:
665
        if not opts.get('parent'):
666
            raise error.Abort(_('cannot backout a merge changeset'))
667 668
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
669
            raise error.Abort(_('%s is not a parent of %s') %
670
                             (short(p), short(node)))
671 672
        parent = p
    else:
673
        if opts.get('parent'):
674
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
675
        parent = p1
676

677
    # the backout should appear on the same branch
678 679 680 681
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
682
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
        try:
            ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                         'backout')
            stats = mergemod.update(repo, parent, True, True, node, False)
            repo.setparents(op1, op2)
            dsguard.close()
            hg._showstats(repo, stats)
            if stats[3]:
                repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                 "file merges\n"))
                return 1
        finally:
            ui.setconfig('ui', 'forcemerge', '', '')
            lockmod.release(dsguard)
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

702 703 704 705 706
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
        e = cmdutil.getcommiteditor(editform=editform, **opts)
        if not message:
            # we don't translate commit messages
            message = "Backed out changeset %s" % short(node)
            e = cmdutil.getcommiteditor(edit=True, editform=editform)
        return repo.commit(message, opts.get('user'), opts.get('date'),
                           match, editor=e)
    newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
    if not newnode:
        ui.status(_("nothing changed\n"))
        return 1
    cmdutil.commitstatus(repo, newnode, branch, bheads)

    def nice(node):
        return '%d:%s' % (repo.changelog.rev(node), short(node))
    ui.status(_('changeset %s backs out changeset %s\n') %
              (nice(repo.changelog.tip()), nice(node)))
    if opts.get('merge') and op1 != node:
        hg.clean(repo, op1, show_stats=False)
        ui.status(_('merging with changeset %s\n')
                  % nice(repo.changelog.tip()))
        try:
            ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                         'backout')
            return hg.merge(repo, hex(repo.changelog.tip()))
        finally:
            ui.setconfig('ui', 'forcemerge', '', '')
737
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
738

739 740 741 742 743 744 745 746 747
@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]"))
748
def bisect(ui, repo, rev=None, extra=None, command=None,
749 750
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
751 752
    """subdivision search of changesets

753 754 755 756 757 758 759 760 761 762 763 764 765
    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.
766 767 768 769 770 771
    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.
772

773 774 775 776
    .. container:: verbose

      Some examples:

777
      - start a bisection with known bad revision 34, and good revision 12::
778 779 780 781 782 783 784 785 786 787

          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
788
      - mark the current revision, or a known revision, to be skipped (e.g. if
789 790 791 792 793
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

794
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
795

796
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
797

798 799 800 801 802 803 804 805 806 807
      - 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
808
          hg bisect --command "make && make tests"
809 810 811 812 813 814

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

          hg log -r "bisect(pruned)"

815 816 817 818 819
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

820 821 822 823
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

824
      - you can even get a nice graph::
825 826 827

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

828
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
829

830
    Returns 0 on success.
831 832 833 834 835 836 837 838 839 840 841
    """
    # 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
842
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
843
        raise error.Abort(_('incompatible arguments'))
844 845

    if reset:
846
        hbisect.resetstate(repo)
847 848
        return

849 850
    state = hbisect.load_state(repo)

851 852 853 854 855 856 857 858 859 860 861 862 863
    # update state
    if good or bad or skip:
        if rev:
            nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
        else:
            nodes = [repo.lookup('.')]
        if good:
            state['good'] += nodes
        elif bad:
            state['bad'] += nodes
        elif skip:
            state['skip'] += nodes
        hbisect.save_state(repo, state)
864 865
        if not (state['good'] and state['bad']):
            return
866

867 868 869 870
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
871
        cmdutil.checkunfinished(repo)
872 873 874
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

875 876
    displayer = cmdutil.show_changeset(ui, repo, {})

877 878
    if command:
        changesets = 1
879 880 881 882
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
883
                raise error.Abort(_('current bisect revision is unknown - '
884
                                   'start a new bisect to fix'))
885
        else:
886 887
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
888
                raise error.Abort(_('current bisect revision is a merge'))
889 890
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
891 892 893
        try:
            while changesets:
                # update state
894
                state['current'] = [node]
895
                hbisect.save_state(repo, state)
896 897
                status = ui.system(command, environ={'HG_NODE': hex(node)},
                                   blockedtag='bisect_check')
898 899 900 901 902 903
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
904
                    raise error.Abort(_("failed to execute %s") % command)
905
                elif status < 0:
906
                    raise error.Abort(_("%s killed") % command)