commands.py 196 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
    m = scmutil.match(repo[None], pats, opts)
259
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
260
    return rejected and 1 or 0
261

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

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

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

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

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

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

355
    List changes in files, showing the revision id responsible for
356
    each line.
357

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

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

364 365 366 367
    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.
368 369

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

374 375 376
    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
377
        opts['file'] = True
378

379 380
    ctx = scmutil.revsingle(repo, opts.get('rev'))

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

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

423
    if (not opts.get('user') and not opts.get('changeset')
424
        and not opts.get('date') and not opts.get('file')):
425
        opts['number'] = True
426

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

431 432
    ui.pager('annotate')

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

445
    def bad(x, y):
446
        raise error.Abort("%s: %s" % (x, y))
447

448 449
    m = scmutil.match(ctx, pats, opts, badfn=bad)

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

459 460
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
461 462
        if not lines:
            continue
463
        formats = []
464 465
        pieces = []

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

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

481
        if not lines[-1][1].endswith('\n'):
482 483 484
            fm.plain('\n')

    fm.end()
485

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

497 498
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
499

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

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

515
    Valid types are:
516

517 518 519 520 521 522
    :``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
523

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

527 528 529 530
    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.
531 532

    Returns 0 on success.
533 534
    '''

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

543
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
544
    prefix = opts.get('prefix')
545

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

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

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

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

576
    If REV is the parent of the working directory, then this new changeset
577
    is committed automatically (unless --no-commit is specified).
578

579
    .. note::
580

581
       :hg:`backout` cannot be used to fix either an unwanted or
582
       incorrect merge.
583

Matt Mackall's avatar
Matt Mackall committed
584 585
    .. container:: verbose

586 587 588 589 590 591 592 593 594 595 596 597
      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
598
        leave changes uncommitted::
599

600 601
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
602

Matt Mackall's avatar
Matt Mackall committed
603 604 605 606 607 608 609 610 611
      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.
612

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

615 616 617
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

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

629 630 631
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"))
632 633
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
634

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

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

641
    if not rev:
642
        raise error.Abort(_("please specify a revision to backout"))
643

644 645 646 647
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

648
    cmdutil.checkunfinished(repo)
649
    cmdutil.bailifchanged(repo)
650
    node = scmutil.revsingle(repo, rev).node()
651

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

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

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

697 698 699 700 701
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
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 729 730 731

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

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

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

768 769 770 771
    .. container:: verbose

      Some examples:

772
      - start a bisection with known bad revision 34, and good revision 12::
773 774 775 776 777 778 779 780 781 782

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

          hg bisect --skip
          hg bisect --skip 23

789
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
790

791
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
792

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

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

          hg log -r "bisect(pruned)"

810 811 812 813 814
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

815 816 817 818
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

819
      - you can even get a nice graph::
820 821 822

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

823
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
824

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

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

844 845
    state = hbisect.load_state(repo)

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

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

870 871
    displayer = cmdutil.show_changeset(ui, repo, {})

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