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

8
from node import hex, bin, nullhex, nullid, nullrev, short
9
from lock import release
10
from i18n import _
11
import os, re, difflib, time, tempfile, errno, shlex
12
import sys, socket
13
import hg, scmutil, util, revlog, copies, error, bookmarks
14
import patch, help, encoding, templatekw, discovery
15
import archival, changegroup, cmdutil, hbisect
Gregory Szorc's avatar
Gregory Szorc committed
16
import sshserver, hgweb
17
import extensions
18
import merge as mergemod
19
import minirst, revset, fileset
20
import dagparser, context, simplemerge, graphmod, copies
21
import random, operator
22
import setdiscovery, treediscovery, dagutil, pvec, localrepo, destutil
23
import phases, obsolete, exchange, bundle2, repair, lock as lockmod
24
import ui as uimod
25
import streamclone
26
import commandserver
27

28 29 30 31
table = {}

command = cmdutil.command(table)

32 33 34
# Space delimited list of commands that don't require local repositories.
# This should be populated by passing norepo=True into the @command decorator.
norepo = ''
35 36 37 38
# Space delimited list of commands that optionally require local repositories.
# This should be populated by passing optionalrepo=True into the @command
# decorator.
optionalrepo = ''
39 40 41 42 43
# Space delimited list of commands that will examine arguments looking for
# a repository. This should be populated by passing inferrepo=True into the
# @command decorator.
inferrepo = ''

44 45 46 47 48 49
# 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'

50 51 52 53 54 55 56 57 58
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
59
     _('do not prompt, automatically pick the first choice for all prompts')),
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
    ('', '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')),
76
    ('', 'hidden', False, _('consider hidden changesets')),
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
]

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

112 113 114
# hidden for now
formatteropts = [
    ('T', 'template', '',
115
     _('display with template (EXPERIMENTAL)'), _('TEMPLATE')),
116 117
]

118 119
templateopts = [
    ('', 'style', '',
120
     _('display using template map file (DEPRECATED)'), _('STYLE')),
121
    ('T', 'template', '',
122 123 124 125 126 127 128 129 130 131
     _('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')),
132
    ('G', 'graph', None, _("show the revision DAG")),
133 134 135 136 137 138 139 140
] + 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'))
]

141
diffwsopts = [
142 143 144 145 146 147
    ('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')),
148 149 150
    ]

diffopts2 = [
151
    ('', 'noprefix', None, _('omit a/ and b/ prefixes from filenames')),
152 153 154
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
155 156 157
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
158
    ('', 'root', '', _('produce diffs relative to subdirectory'), _('DIR')),
159 160
]

161 162 163 164
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

165 166 167 168 169 170 171 172 173 174
similarityopts = [
    ('s', 'similarity', '',
     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
]

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

175 176 177 178 179 180
debugrevlogopts = [
    ('c', 'changelog', False, _('open changelog')),
    ('m', 'manifest', False, _('open manifest')),
    ('', 'dir', False, _('open directory manifest')),
]

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

183 184
@command('^add',
    walkopts + subrepoopts + dryrunopts,
185 186
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
187
def add(ui, repo, *pats, **opts):
188 189
    """add the specified files on the next commit

190 191
    Schedule files to be version controlled and added to the
    repository.
192

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

timeless's avatar
timeless committed
196 197
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
198 199 200

    .. container:: verbose

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
       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
226 227

    Returns 0 if all files are successfully added.
228 229
    """

230
    m = scmutil.match(repo[None], pats, opts)
231
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
232
    return rejected and 1 or 0
233

234
@command('addremove',
235
    similarityopts + subrepoopts + walkopts + dryrunopts,
236 237
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
238
def addremove(ui, repo, *pats, **opts):
239
    """add all new files, delete all missing files
240

241 242
    Add all new files and remove all missing files from the
    repository.
243

timeless's avatar
timeless committed
244 245 246
    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.
247

248
    Use the -s/--similarity option to detect renamed files. This
249
    option takes a percentage between 0 (disabled) and 100 (files must
250 251 252
    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
253
    can be expensive. After using this option, :hg:`status -C` can be
254 255 256
    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.
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    .. 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

298
    Returns 0 if all files are successfully added.
299
    """
300
    try:
301
        sim = float(opts.get('similarity') or 100)
302
    except ValueError:
303
        raise error.Abort(_('similarity must be a number'))
304
    if sim < 0 or sim > 100:
305
        raise error.Abort(_('similarity must be between 0 and 100'))
306
    matcher = scmutil.match(repo[None], pats, opts)
307
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
308

309 310 311 312 313 314 315 316 317 318 319 320
@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'))
321
    ] + diffwsopts + walkopts + formatteropts,
322 323
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
324
def annotate(ui, repo, *pats, **opts):
325
    """show changeset information by line for each file
326

327 328
    List changes in files, showing the revision id responsible for
    each line
329

330 331
    This command is useful for discovering when a change was made and
    by whom.
332

333 334 335 336
    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.
337 338

    Returns 0 on success.
339
    """
340
    if not pats:
341
        raise error.Abort(_('at least one filename or pattern is required'))
342

343 344 345
    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
346
        opts['file'] = True
347

348 349
    ctx = scmutil.revsingle(repo, opts.get('rev'))

350
    fm = ui.formatter('annotate', opts)
351 352 353 354
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
    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
382

383
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
384 385
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
386 387 388
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
389
            ]
390
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
391

392
    if (not opts.get('user') and not opts.get('changeset')
393
        and not opts.get('date') and not opts.get('file')):
394
        opts['number'] = True
395

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

400 401 402 403 404 405
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
406 407
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
408
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
409 410
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
411

412
    def bad(x, y):
413
        raise error.Abort("%s: %s" % (x, y))
414

415 416
    m = scmutil.match(ctx, pats, opts, badfn=bad)

417
    follow = not opts.get('no_follow')
418 419
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
420 421
    for abs in ctx.walk(m):
        fctx = ctx[abs]
422
        if not opts.get('text') and util.binary(fctx.data()):
423
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
424 425
            continue

426 427
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
428
        formats = []
429 430
        pieces = []

431
        for f, sep in funcmap:
432 433
            l = [f(n) for n, dummy in lines]
            if l:
434 435 436 437 438 439
                if fm:
                    formats.append(['%s' for x in l])
                else:
                    sizes = [encoding.colwidth(x) for x in l]
                    ml = max(sizes)
                    formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
440
                pieces.append(l)
441

442
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
443 444 445
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
446

447
        if lines and not lines[-1][1].endswith('\n'):
448 449 450
            fm.plain('\n')

    fm.end()
451

452 453 454 455 456 457 458 459
@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'))
460
def archive(ui, repo, dest, **opts):
461
    '''create an unversioned archive of a repository revision
462

463 464
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
465

466 467 468
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

Matt Mackall's avatar
Matt Mackall committed
469 470 471 472 473 474 475 476 477 478 479 480
    .. 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*"

481
    Valid types are:
482

483 484 485 486 487 488
    :``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
489

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

493 494 495 496
    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.
497 498

    Returns 0 on success.
499 500
    '''

501
    ctx = scmutil.revsingle(repo, opts.get('rev'))
502
    if not ctx:
503
        raise error.Abort(_('no working directory: please specify a revision'))
504
    node = ctx.node()
505
    dest = cmdutil.makefilename(repo, dest, node)
506
    if os.path.realpath(dest) == repo.root:
507
        raise error.Abort(_('repository root cannot be destination'))
508

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

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

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

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

536 537 538
    Prepare a new changeset with the effect of REV undone in the
    current working directory.

539
    If REV is the parent of the working directory, then this new changeset
540 541 542
    is committed automatically. Otherwise, hg needs to merge the
    changes and the merged result is left uncommitted.

543
    .. note::
544

545 546 547
      backout cannot be used to fix either an unwanted or
      incorrect merge.

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

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
      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
          hg commit -m "Backout revision 23"

      - Reverse the effect of previous bad revision 23 and
        commit the backout immediately::

          hg backout -r 23 --commit

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

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

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

582 583
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
584
    '''
585 586 587 588 589 590 591 592 593
    wlock = lock = None
    try:
        wlock = repo.wlock()
        lock = repo.lock()
        return _dobackout(ui, repo, node, rev, commit, **opts)
    finally:
        release(lock, wlock)

def _dobackout(ui, repo, node=None, rev=None, commit=False, **opts):
Daniel Holth's avatar
Daniel Holth committed
594
    if rev and node:
595
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
596 597 598

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

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

603 604 605 606
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

607
    cmdutil.checkunfinished(repo)
608
    cmdutil.bailifchanged(repo)
609
    node = scmutil.revsingle(repo, rev).node()
610

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

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

631
    # the backout should appear on the same branch
632 633
    try:
        branch = repo.dirstate.branch()
634
        bheads = repo.branchheads(branch)
635
        rctx = scmutil.revsingle(repo, hex(parent))
636
        if not opts.get('merge') and op1 != node:
637
            dsguard = cmdutil.dirstateguard(repo, 'backout')
638
            try:
639 640
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
641
                stats = mergemod.update(repo, parent, True, True, node, False)
642
                repo.setparents(op1, op2)
643
                dsguard.close()
644 645
                hg._showstats(repo, stats)
                if stats[3]:
646 647
                    repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                     "file merges\n"))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
648 649
                    return 1
                elif not commit:
650 651 652
                    msg = _("changeset %s backed out, "
                            "don't forget to commit.\n")
                    ui.status(msg % short(node))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
653
                    return 0
654
            finally:
655
                ui.setconfig('ui', 'forcemerge', '', '')
656
                lockmod.release(dsguard)
657 658 659 660 661
        else:
            hg.clean(repo, node, show_stats=False)
            repo.dirstate.setbranch(branch)
            cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

662

663
        def commitfunc(ui, repo, message, match, opts):
664 665
            editform = 'backout'
            e = cmdutil.getcommiteditor(editform=editform, **opts)
666 667 668
            if not message:
                # we don't translate commit messages
                message = "Backed out changeset %s" % short(node)
669
                e = cmdutil.getcommiteditor(edit=True, editform=editform)
670 671 672
            return repo.commit(message, opts.get('user'), opts.get('date'),
                               match, editor=e)
        newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
673 674 675
        if not newnode:
            ui.status(_("nothing changed\n"))
            return 1
676
        cmdutil.commitstatus(repo, newnode, branch, bheads)
677

678 679 680 681 682 683 684 685 686
        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:
687 688
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
689 690
                return hg.merge(repo, hex(repo.changelog.tip()))
            finally:
691
                ui.setconfig('ui', 'forcemerge', '', '')
692
    finally:
693 694 695
        # TODO: get rid of this meaningless try/finally enclosing.
        # this is kept only to reduce changes in a patch.
        pass
696
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
697

698 699 700 701 702 703 704 705 706
@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]"))
707
def bisect(ui, repo, rev=None, extra=None, command=None,
708 709
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
710 711
    """subdivision search of changesets

712 713 714 715 716 717 718 719 720 721 722 723 724
    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.
725 726 727 728 729 730
    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.
731

732 733 734 735
    .. container:: verbose

      Some examples:

736
      - start a bisection with known bad revision 34, and good revision 12::
737 738 739 740 741 742 743 744 745 746

          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
747
      - mark the current revision, or a known revision, to be skipped (e.g. if
748 749 750 751 752
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

753
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
754

755
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
756

757 758 759 760 761 762 763 764 765 766
      - 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
767
          hg bisect --command "make && make tests"
768 769 770 771 772 773

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

          hg log -r "bisect(pruned)"

774 775 776 777 778
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

779 780 781 782
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

783
      - you can even get a nice graph::
784 785 786

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

787 788
      See :hg:`help revsets` for more about the `bisect()` keyword.

789
    Returns 0 on success.
790
    """
791 792 793 794 795
    def extendbisectrange(nodes, good):
        # bisect is incomplete when it ends on a merge node and
        # one of the parent was not checked.
        parents = repo[nodes[0]].parents()
        if len(parents) > 1:
796 797 798 799
            if good:
                side = state['bad']
            else:
                side = state['good']
800 801
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
802
                return parents[0].ancestor(parents[1])
803 804
        return None

805 806 807 808
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
809 810 811 812
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
813
            displayer.show(repo[nodes[0]])
814 815 816 817 818
            extendnode = extendbisectrange(nodes, good)
            if extendnode is not None:
                ui.write(_('Not all ancestors of this changeset have been'
                           ' checked.\nUse bisect --extend to continue the '
                           'bisection from\nthe common ancestor, %s.\n')
819
                         % extendnode)
820 821
        else:
            # multiple possible revisions
822 823 824 825 826 827
            if good:
                ui.write(_("Due to skipped revisions, the first "
                        "good revision could be any of:\n"))
            else:
                ui.write(_("Due to skipped revisions, the first "
                        "bad revision could be any of:\n"))
828
            for n in nodes:
829
                displayer.show(repo[n])
830
        displayer.close()
831 832 833 834 835 836

    def check_state(state, interactive=True):
        if not state['good'] or not state['bad']:
            if (good or bad or skip or reset) and interactive:
                return
            if not state['good']:
837
                raise error.Abort(_('cannot bisect (no known good revisions)'))
838
            else:
839
                raise error.Abort(_('cannot bisect (no known bad revisions)'))
840 841
        return True

842 843 844 845 846 847 848 849 850 851
    # 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
852
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
853
        raise error.Abort(_('incompatible arguments'))
854

855 856
    cmdutil.checkunfinished(repo)

857 858 859 860 861 862
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

863 864 865 866
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
867 868 869 870
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
871
                raise error.Abort(_('current bisect revision is unknown - '
872
                                   'start a new bisect to fix'))
873
        else:
874 875
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
876
                raise error.Abort(_('current bisect revision is a merge'))
877 878 879
        try:
            while changesets:
                # update state
880
                state['current'] = [node]
881
                hbisect.save_state(repo, state)
882
                status = ui.system(command, environ={'HG_NODE': hex(node)})
Benoit Boissinot's avatar