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

27 28 29 30
table = {}

command = cmdutil.command(table)

31 32 33
# Space delimited list of commands that don't require local repositories.
# This should be populated by passing norepo=True into the @command decorator.
norepo = ''
34 35 36 37
# Space delimited list of commands that optionally require local repositories.
# This should be populated by passing optionalrepo=True into the @command
# decorator.
optionalrepo = ''
38 39 40 41 42
# 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 = ''

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

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

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
58
     _('do not prompt, automatically pick the first choice for all prompts')),
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
    ('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')),
75
    ('', 'hidden', False, _('consider hidden changesets')),
76 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
]

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

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

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

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

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

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

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

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

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

176 177
@command('^add',
    walkopts + subrepoopts + dryrunopts,
178 179
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
180
def add(ui, repo, *pats, **opts):
181 182
    """add the specified files on the next commit

183 184
    Schedule files to be version controlled and added to the
    repository.
185

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

189
    If no names are given, add all files to the repository.
190 191 192

    .. container:: verbose

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
       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
218 219

    Returns 0 if all files are successfully added.
220 221
    """

222
    m = scmutil.match(repo[None], pats, opts)
223
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
224
    return rejected and 1 or 0
225

226
@command('addremove',
227
    similarityopts + subrepoopts + walkopts + dryrunopts,
228 229
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
230
def addremove(ui, repo, *pats, **opts):
231
    """add all new files, delete all missing files
232

233 234
    Add all new files and remove all missing files from the
    repository.
235

236
    New files are ignored if they match any of the patterns in
237
    ``.hgignore``. As with add, these changes take effect at the next
238
    commit.
239

240
    Use the -s/--similarity option to detect renamed files. This
241
    option takes a percentage between 0 (disabled) and 100 (files must
242 243 244
    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
245
    can be expensive. After using this option, :hg:`status -C` can be
246 247 248
    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.
249

250 251 252 253 254 255 256 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
    .. 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

290
    Returns 0 if all files are successfully added.
291
    """
292
    try:
293
        sim = float(opts.get('similarity') or 100)
294
    except ValueError:
295
        raise error.Abort(_('similarity must be a number'))
296
    if sim < 0 or sim > 100:
297
        raise error.Abort(_('similarity must be between 0 and 100'))
298
    matcher = scmutil.match(repo[None], pats, opts)
299
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
300

301 302 303 304 305 306 307 308 309 310 311 312
@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'))
313
    ] + diffwsopts + walkopts + formatteropts,
314 315
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
316
def annotate(ui, repo, *pats, **opts):
317
    """show changeset information by line for each file
318

319 320
    List changes in files, showing the revision id responsible for
    each line
321

322 323
    This command is useful for discovering when a change was made and
    by whom.
324

325 326 327 328
    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.
329 330

    Returns 0 on success.
331
    """
332
    if not pats:
333
        raise error.Abort(_('at least one filename or pattern is required'))
334

335 336 337
    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
338
        opts['file'] = True
339

340 341
    ctx = scmutil.revsingle(repo, opts.get('rev'))

342
    fm = ui.formatter('annotate', opts)
343 344 345 346
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
    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
374

375
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
376 377
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
378 379 380
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
381
            ]
382
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
383

384
    if (not opts.get('user') and not opts.get('changeset')
385
        and not opts.get('date') and not opts.get('file')):
386
        opts['number'] = True
387

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

392 393 394 395 396 397
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
398 399
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
400
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
401 402
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
403

404
    def bad(x, y):
405
        raise error.Abort("%s: %s" % (x, y))
406

407 408
    m = scmutil.match(ctx, pats, opts, badfn=bad)

409
    follow = not opts.get('no_follow')
410 411
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
412 413
    for abs in ctx.walk(m):
        fctx = ctx[abs]
414
        if not opts.get('text') and util.binary(fctx.data()):
415
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
416 417
            continue

418 419
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
420
        formats = []
421 422
        pieces = []

423
        for f, sep in funcmap:
424 425
            l = [f(n) for n, dummy in lines]
            if l:
426 427 428 429 430 431
                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])
432
                pieces.append(l)
433

434
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
435 436 437
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
438

439
        if lines and not lines[-1][1].endswith('\n'):
440 441 442
            fm.plain('\n')

    fm.end()
443

444 445 446 447 448 449 450 451
@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'))
452
def archive(ui, repo, dest, **opts):
453
    '''create an unversioned archive of a repository revision
454

455 456
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
457

458 459 460
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

Matt Mackall's avatar
Matt Mackall committed
461 462 463 464 465 466 467 468 469 470 471 472
    .. 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*"

473
    Valid types are:
474

475 476 477 478 479 480
    :``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
481

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

485 486 487 488
    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.
489 490

    Returns 0 on success.
491 492
    '''

493
    ctx = scmutil.revsingle(repo, opts.get('rev'))
494
    if not ctx:
495
        raise error.Abort(_('no working directory: please specify a revision'))
496
    node = ctx.node()
497
    dest = cmdutil.makefilename(repo, dest, node)
498
    if os.path.realpath(dest) == repo.root:
499
        raise error.Abort(_('repository root cannot be destination'))
500

501
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
502
    prefix = opts.get('prefix')
503

504 505
    if dest == '-':
        if kind == 'files':
506
            raise error.Abort(_('cannot archive plain files to stdout'))
507
        dest = cmdutil.makefileobj(repo, dest)
508 509
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
510

511
    prefix = cmdutil.makefilename(repo, prefix, node)
512
    matchfn = scmutil.match(ctx, [], opts)
513
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
514
                     matchfn, prefix, subrepos=opts.get('subrepos'))
515

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

528 529 530
    Prepare a new changeset with the effect of REV undone in the
    current working directory.

531
    If REV is the parent of the working directory, then this new changeset
532 533 534
    is committed automatically. Otherwise, hg needs to merge the
    changes and the merged result is left uncommitted.

535
    .. note::
536

537 538 539
      backout cannot be used to fix either an unwanted or
      incorrect merge.

Matt Mackall's avatar
Matt Mackall committed
540 541
    .. container:: verbose

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
      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
559 560 561 562 563 564 565 566 567
      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.
568

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

571 572 573
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

574 575
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
576
    '''
577 578 579 580 581 582 583 584 585
    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
586
    if rev and node:
587
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
588 589 590

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

592
    if not rev:
593
        raise error.Abort(_("please specify a revision to backout"))
594

595 596 597 598
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

599
    cmdutil.checkunfinished(repo)
600
    cmdutil.bailifchanged(repo)
601
    node = scmutil.revsingle(repo, rev).node()
602

603
    op1, op2 = repo.dirstate.parents()
604
    if not repo.changelog.isancestor(node, op1):
605
        raise error.Abort(_('cannot backout change that is not an ancestor'))
606

607 608
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
609
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
610
    if p2 != nullid:
611
        if not opts.get('parent'):
612
            raise error.Abort(_('cannot backout a merge changeset'))
613 614
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
615
            raise error.Abort(_('%s is not a parent of %s') %
616
                             (short(p), short(node)))
617 618
        parent = p
    else:
619
        if opts.get('parent'):
620
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
621
        parent = p1
622

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

655

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

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

691 692 693 694 695 696 697 698 699
@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]"))
700
def bisect(ui, repo, rev=None, extra=None, command=None,
701 702
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
703 704
    """subdivision search of changesets

705 706 707 708 709 710 711 712 713 714 715 716 717
    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.
718 719 720 721 722 723
    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.
724

725 726 727 728
    .. container:: verbose

      Some examples:

729
      - start a bisection with known bad revision 34, and good revision 12::
730 731 732 733 734 735 736 737 738 739

          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
740
      - mark the current revision, or a known revision, to be skipped (e.g. if
741 742 743 744 745
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

746
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
747

748
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
749

750 751 752 753 754 755 756 757 758 759
      - 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
760
          hg bisect --command "make && make tests"
761 762 763 764 765 766

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

          hg log -r "bisect(pruned)"

767 768 769 770 771
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

772 773 774 775
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

776
      - you can even get a nice graph::
777 778 779

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

780 781
      See :hg:`help revsets` for more about the `bisect()` keyword.

782
    Returns 0 on success.
783
    """
784 785 786 787 788
    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:
789 790 791 792
            if good:
                side = state['bad']
            else:
                side = state['good']
793 794
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
795
                return parents[0].ancestor(parents[1])
796 797
        return None

798 799 800 801
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
802 803 804 805
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
806
            displayer.show(repo[nodes[0]])
807 808 809 810 811
            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')
812
                         % extendnode)
813 814
        else:
            # multiple possible revisions
815 816 817 818 819 820
            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"))
821
            for n in nodes:
822
                displayer.show(repo[n])
823
        displayer.close()
824 825 826 827 828 829

    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']:
830
                raise error.Abort(_('cannot bisect (no known good revisions)'))
831
            else:
832
                raise error.Abort(_('cannot bisect (no known bad revisions)'))
833 834
        return True

835 836 837 838 839 840 841 842 843 844
    # 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
845
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
846
        raise error.Abort(_('incompatible arguments'))
847

848 849
    cmdutil.checkunfinished(repo)

850 851 852 853 854 855
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

856 857 858 859
    state = hbisect.load_state(repo)

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