commands.py 195 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
    revsetlang,
Gregory Szorc's avatar
Gregory Szorc committed
47
    scmutil,
48
    server,
Gregory Szorc's avatar
Gregory Szorc committed
49 50 51 52 53 54 55 56
    sshserver,
    streamclone,
    templatekw,
    ui as uimod,
    util,
)

release = lockmod.release
57

58 59 60 61
table = {}

command = cmdutil.command(table)

62 63 64 65 66 67
# 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'

68 69 70 71 72 73 74 75 76
# common command options

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

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')),
]

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

143 144
templateopts = [
    ('', 'style', '',
145
     _('display using template map file (DEPRECATED)'), _('STYLE')),
146
    ('T', 'template', '',
147 148 149 150 151 152 153 154 155 156
     _('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')),
157
    ('G', 'graph', None, _("show the revision DAG")),
158 159 160 161 162 163 164 165
] + templateopts

diffopts = [
    ('a', 'text', None, _('treat all files as text')),
    ('g', 'git', None, _('use git extended diff format')),
    ('', 'nodates', None, _('omit dates from diff headers'))
]

166
diffwsopts = [
167 168 169 170 171 172
    ('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')),
173 174 175
    ]

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

186 187 188 189
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

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

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

200 201 202
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
203
    ('', 'dir', '', _('open directory manifest')),
204 205
]

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

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

215 216
    Schedule files to be version controlled and added to the
    repository.
217

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

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

    .. container:: verbose

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

    Returns 0 if all files are successfully added.
253 254
    """

255
    m = scmutil.match(repo[None], pats, opts)
256
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
257
    return rejected and 1 or 0
258

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

266 267
    Add all new files and remove all missing files from the
    repository.
268

timeless's avatar
timeless committed
269 270 271
    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.
272

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

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

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

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

352
    List changes in files, showing the revision id responsible for
353
    each line.
354

355 356
    This command is useful for discovering when a change was made and
    by whom.
357

358 359 360
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

361 362 363 364
    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.
365 366

    Returns 0 on success.
367
    """
368
    if not pats:
369
        raise error.Abort(_('at least one filename or pattern is required'))
370

371 372 373
    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
374
        opts['file'] = True
375

376 377
    ctx = scmutil.revsingle(repo, opts.get('rev'))

378
    fm = ui.formatter('annotate', opts)
379 380 381 382
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
    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
410

411
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
412 413
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
414 415 416
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
417
            ]
418
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
419

420
    if (not opts.get('user') and not opts.get('changeset')
421
        and not opts.get('date') and not opts.get('file')):
422
        opts['number'] = True
423

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

428 429
    ui.pager('annotate')

430
    if fm.isplain():
431
        def makefunc(get, fmt):
432
            return lambda x: fmt(get(x))
433 434
    else:
        def makefunc(get, fmt):
435
            return get
436 437
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
438
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
439 440
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
441

442
    def bad(x, y):
443
        raise error.Abort("%s: %s" % (x, y))
444

445 446
    m = scmutil.match(ctx, pats, opts, badfn=bad)

447
    follow = not opts.get('no_follow')
448 449
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
450 451
    for abs in ctx.walk(m):
        fctx = ctx[abs]
452
        if not opts.get('text') and util.binary(fctx.data()):
453
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
454 455
            continue

456 457
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
458 459
        if not lines:
            continue
460
        formats = []
461 462
        pieces = []

463
        for f, sep in funcmap:
464
            l = [f(n) for n, dummy in lines]
465
            if fm.isplain():
466 467 468
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
469 470
            else:
                formats.append(['%s' for x in l])
471
            pieces.append(l)
472

473
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
474 475 476
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
477

478
        if not lines[-1][1].endswith('\n'):
479 480 481
            fm.plain('\n')

    fm.end()
482

483 484 485 486 487 488 489 490
@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'))
491
def archive(ui, repo, dest, **opts):
492
    '''create an unversioned archive of a repository revision
493

494 495
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
496

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

Matt Mackall's avatar
Matt Mackall committed
500 501 502 503 504 505 506 507 508 509 510 511
    .. 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*"

512
    Valid types are:
513

514 515 516 517 518 519
    :``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
520

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

524 525 526 527
    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.
528 529

    Returns 0 on success.
530 531
    '''

532
    ctx = scmutil.revsingle(repo, opts.get('rev'))
533
    if not ctx:
534
        raise error.Abort(_('no working directory: please specify a revision'))
535
    node = ctx.node()
536
    dest = cmdutil.makefilename(repo, dest, node)
537
    if os.path.realpath(dest) == repo.root:
538
        raise error.Abort(_('repository root cannot be destination'))
539

540
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
541
    prefix = opts.get('prefix')
542

543 544
    if dest == '-':
        if kind == 'files':
545
            raise error.Abort(_('cannot archive plain files to stdout'))
546
        dest = cmdutil.makefileobj(repo, dest)
547 548
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
549

550
    prefix = cmdutil.makefilename(repo, prefix, node)
551
    matchfn = scmutil.match(ctx, [], opts)
552
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
553
                     matchfn, prefix, subrepos=opts.get('subrepos'))
554

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

569
    Prepare a new changeset with the effect of REV undone in the
570 571
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
572

573
    If REV is the parent of the working directory, then this new changeset
574
    is committed automatically (unless --no-commit is specified).
575

576
    .. note::
577

578
       :hg:`backout` cannot be used to fix either an unwanted or
579
       incorrect merge.
580

Matt Mackall's avatar
Matt Mackall committed
581 582
    .. container:: verbose

583 584 585 586 587 588 589 590 591 592 593 594
      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
595
        leave changes uncommitted::
596

597 598
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
599

Matt Mackall's avatar
Matt Mackall committed
600 601 602 603 604 605 606 607 608
      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.
609

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

612 613 614
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

615 616
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
617
    '''
618 619 620 621
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
622
        return _dobackout(ui, repo, node, rev, **opts)
623 624 625
    finally:
        release(lock, wlock)

626 627 628
def _dobackout(ui, repo, node=None, rev=None, **opts):
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
629 630
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
631

Daniel Holth's avatar
Daniel Holth committed
632
    if rev and node:
633
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
634 635 636

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

638
    if not rev:
639
        raise error.Abort(_("please specify a revision to backout"))
640

641 642 643 644
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

645
    cmdutil.checkunfinished(repo)
646
    cmdutil.bailifchanged(repo)
647
    node = scmutil.revsingle(repo, rev).node()
648

649
    op1, op2 = repo.dirstate.parents()
650
    if not repo.changelog.isancestor(node, op1):
651
        raise error.Abort(_('cannot backout change that is not an ancestor'))
652

653 654
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
655
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
656
    if p2 != nullid:
657
        if not opts.get('parent'):
658
            raise error.Abort(_('cannot backout a merge changeset'))
659 660
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
661
            raise error.Abort(_('%s is not a parent of %s') %
662
                             (short(p), short(node)))
663 664
        parent = p
    else:
665
        if opts.get('parent'):
666
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
667
        parent = p1
668

669
    # the backout should appear on the same branch
670 671 672 673
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
674
        dsguard = dirstateguard.dirstateguard(repo, 'backout')
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
        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())

694 695 696 697 698
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728

    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', '', '')
729
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
730

731 732 733 734 735 736 737 738 739
@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]"))
740
def bisect(ui, repo, rev=None, extra=None, command=None,
741 742
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
743 744
    """subdivision search of changesets

745 746 747 748 749 750 751 752 753 754 755 756 757
    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.
758 759 760 761 762 763
    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.
764

765 766 767 768
    .. container:: verbose

      Some examples:

769
      - start a bisection with known bad revision 34, and good revision 12::
770 771 772 773 774 775 776 777 778 779

          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
780
      - mark the current revision, or a known revision, to be skipped (e.g. if
781 782 783 784 785
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

786
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
787

788
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
789

790 791 792 793 794 795 796 797 798 799
      - 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
800
          hg bisect --command "make && make tests"
801 802 803 804 805 806

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

          hg log -r "bisect(pruned)"

807 808 809 810 811
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

812 813 814 815
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

816
      - you can even get a nice graph::
817 818 819

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

820
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
821

822
    Returns 0 on success.
823 824 825 826 827 828 829 830 831 832 833
    """
    # 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
834
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
835
        raise error.Abort(_('incompatible arguments'))
836

837 838
    cmdutil.checkunfinished(repo)

839
    if reset:
840
        hbisect.resetstate(repo)
841 842
        return

843 844
    state = hbisect.load_state(repo)

845 846 847 848 849 850 851 852 853 854 855 856 857
    # 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)
858 859
        if not (state['good'] and state['bad']):
            return
860

861 862 863 864 865 866 867
    def mayupdate(repo, node, show_stats=True):
        """common used update sequence"""
        if noupdate:
            return
        cmdutil.bailifchanged(repo)
        return hg.clean(repo, node, show_stats=show_stats)

868 869
    displayer = cmdutil.show_changeset(ui, repo, {})

870 871
    if command:
        changesets = 1
872 873 874 875
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
876
                raise error.Abort(_('current bisect revision is unknown - '
877
                                   'start a new bisect to fix'))
878
        else:
879 880
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
881
                raise error.Abort(_('current bisect revision is a merge'))
882 883
        if rev:
            node = repo[scmutil.revsingle(repo, rev, node)].node()
884 885 886
        try:
            while changesets:
                # update state
887
                state['current'] = [node]
888
                hbisect.save_state(repo, state)
889 890
                status = ui.system(command, environ={'HG_NODE': hex(node)},
                                   blockedtag='bisect_check')
891 892 893 894 895 896
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
897
                    raise error.Abort(_("failed to execute %s") % command)
898
                elif status < 0:
899
                    raise error.Abort(_("%s killed") % command)
900 901
                else:
                    transition = "bad"
902 903
                state[transition].append(node)
                ctx = repo[node]
904
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
905
                hbisect.checkstate(state)
906
                # bisect
907
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
908
                # update to next check
909
                node = nodes[0]
910
                mayupdate(repo, node, show_stats=False)
911