commands.py 237 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
from __future__ import absolute_import

import difflib
import errno
import os
import re
14
import sys
Gregory Szorc's avatar
Gregory Szorc committed
15 16 17 18 19 20 21

from .i18n import _
from .node import (
    hex,
    nullid,
    nullrev,
    short,
22 23
    wdirhex,
    wdirrev,
Gregory Szorc's avatar
Gregory Szorc committed
24 25 26 27 28 29 30 31
)
from . import (
    archival,
    bookmarks,
    bundle2,
    changegroup,
    cmdutil,
    copies,
32
    debugcommands as debugcommandsmod,
Gregory Szorc's avatar
Gregory Szorc committed
33
    destutil,
34
    dirstateguard,
Gregory Szorc's avatar
Gregory Szorc committed
35 36 37 38 39
    discovery,
    encoding,
    error,
    exchange,
    extensions,
40
    filemerge,
Yuya Nishihara's avatar
Yuya Nishihara committed
41
    formatter,
Gregory Szorc's avatar
Gregory Szorc committed
42 43 44 45
    graphmod,
    hbisect,
    help,
    hg,
46
    logcmdutil,
Gregory Szorc's avatar
Gregory Szorc committed
47
    merge as mergemod,
48
    narrowspec,
Gregory Szorc's avatar
Gregory Szorc committed
49
    obsolete,
50
    obsutil,
Gregory Szorc's avatar
Gregory Szorc committed
51 52
    patch,
    phases,
53
    pycompat,
54
    rcutil,
55
    registrar,
56
    revsetlang,
57
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
58
    scmutil,
59
    server,
60
    shelve as shelvemod,
61
    state as statemod,
Gregory Szorc's avatar
Gregory Szorc committed
62
    streamclone,
63
    tags as tagsmod,
Gregory Szorc's avatar
Gregory Szorc committed
64 65
    ui as uimod,
    util,
66
    verify as verifymod,
67
    wireprotoserver,
Gregory Szorc's avatar
Gregory Szorc committed
68
)
69 70 71 72
from .utils import (
    dateutil,
    stringutil,
)
Gregory Szorc's avatar
Gregory Szorc committed
73

74
table = {}
75
table.update(debugcommandsmod.command._table)
76

77
command = registrar.command(table)
78
INTENT_READONLY = registrar.INTENT_READONLY
79 80 81 82 83 84 85 86 87 88

# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
89
     _('do not prompt, automatically pick the first choice for all prompts')),
90 91
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
92
    ('', 'color', '',
93 94
     # i18n: 'always', 'auto', 'never', and 'debug' are keywords
     # and should not be translated
95
     _("when to colorize (boolean, always, auto, never, or debug)"),
96
     _('TYPE')),
97 98 99 100 101 102 103 104 105 106 107 108 109 110
    ('', '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')),
111
    ('', 'hidden', False, _('consider hidden changesets')),
112 113
    ('', 'pager', 'auto',
     _("when to paginate (boolean, always, auto, or never)"), _('TYPE')),
114 115
]

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
dryrunopts = cmdutil.dryrunopts
remoteopts = cmdutil.remoteopts
walkopts = cmdutil.walkopts
commitopts = cmdutil.commitopts
commitopts2 = cmdutil.commitopts2
formatteropts = cmdutil.formatteropts
templateopts = cmdutil.templateopts
logopts = cmdutil.logopts
diffopts = cmdutil.diffopts
diffwsopts = cmdutil.diffwsopts
diffopts2 = cmdutil.diffopts2
mergetoolopts = cmdutil.mergetoolopts
similarityopts = cmdutil.similarityopts
subrepoopts = cmdutil.subrepoopts
debugrevlogopts = cmdutil.debugrevlogopts
131

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

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
@command('abort',
    dryrunopts, helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
    helpbasic=True)
def abort(ui, repo, **opts):
    """abort an unfinished operation (EXPERIMENTAL)

    Aborts a multistep operation like graft, histedit, rebase, merge,
    and unshelve if they are in an unfinished state.

    use --dry-run/-n to dry run the command.
    """
    dryrun = opts.get(r'dry_run')
    abortstate = cmdutil.getunfinishedstate(repo)
    if not abortstate:
        raise error.Abort(_('no operation in progress'))
    if not abortstate.abortfunc:
        raise error.Abort((_("%s in progress but does not support 'hg abort'") %
                            (abortstate._opname)), hint=abortstate.hint())
    if dryrun:
        ui.status(_('%s in progress, will be aborted\n') % (abortstate._opname))
        return
    return abortstate.abortfunc(ui, repo)

157
@command('add',
158
    walkopts + subrepoopts + dryrunopts,
159
    _('[OPTION]... [FILE]...'),
160
    helpcategory=command.CATEGORY_WORKING_DIRECTORY,
161
    helpbasic=True, inferrepo=True)
162
def add(ui, repo, *pats, **opts):
163 164
    """add the specified files on the next commit

165 166
    Schedule files to be version controlled and added to the
    repository.
167

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

timeless's avatar
timeless committed
171 172
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
173 174 175

    .. container:: verbose

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
       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
201 202

    Returns 0 if all files are successfully added.
203 204
    """

205
    m = scmutil.match(repo[None], pats, pycompat.byteskwargs(opts))
206
    uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
207
    rejected = cmdutil.add(ui, repo, m, "", uipathfn, False, **opts)
208
    return rejected and 1 or 0
209

210
@command('addremove',
211
    similarityopts + subrepoopts + walkopts + dryrunopts,
212
    _('[OPTION]... [FILE]...'),
213
    helpcategory=command.CATEGORY_WORKING_DIRECTORY,
214
    inferrepo=True)
215
def addremove(ui, repo, *pats, **opts):
216
    """add all new files, delete all missing files
217

218 219
    Add all new files and remove all missing files from the
    repository.
220

timeless's avatar
timeless committed
221 222 223
    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.
224

225
    Use the -s/--similarity option to detect renamed files. This
226
    option takes a percentage between 0 (disabled) and 100 (files must
227 228 229
    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
230
    can be expensive. After using this option, :hg:`status -C` can be
231 232 233
    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.
234

235 236 237 238 239 240 241 242 243 244 245 246 247 248 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
    .. 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

275
    Returns 0 if all files are successfully added.
276
    """
277
    opts = pycompat.byteskwargs(opts)
278 279
    if not opts.get('similarity'):
        opts['similarity'] = '100'
280
    matcher = scmutil.match(repo[None], pats, opts)
281
    relative = scmutil.anypats(pats, opts)
282
    uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=relative)
283
    return scmutil.addremove(repo, matcher, "", uipathfn, opts)
284

285
@command('annotate|blame',
286 287 288 289 290 291 292 293 294 295
    [('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')),
296 297
    ('l', 'line-number', None, _('show line number at the first appearance')),
    ('', 'skip', [], _('revision to not display (EXPERIMENTAL)'), _('REV')),
298
    ] + diffwsopts + walkopts + formatteropts,
299
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
300
    helpcategory=command.CATEGORY_FILE_CONTENTS,
301
    helpbasic=True, inferrepo=True)
302
def annotate(ui, repo, *pats, **opts):
303
    """show changeset information by line for each file
304

305
    List changes in files, showing the revision id responsible for
306
    each line.
307

308 309
    This command is useful for discovering when a change was made and
    by whom.
310

311 312 313
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

314 315 316 317
    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.
318

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
    .. container:: verbose

      Template:

      The following keywords are supported in addition to the common template
      keywords and functions. See also :hg:`help templates`.

      :lines:   List of lines with annotation data.
      :path:    String. Repository-absolute path of the specified file.

      And each entry of ``{lines}`` provides the following sub-keywords in
      addition to ``{date}``, ``{node}``, ``{rev}``, ``{user}``, etc.

      :line:    String. Line content.
      :lineno:  Integer. Line number at that revision.
      :path:    String. Repository-absolute path of the file at that revision.

      See :hg:`help templates.operators` for the list expansion syntax.

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

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

349 350 351 352 353 354 355 356
    if (not opts.get('user') and not opts.get('changeset')
        and not opts.get('date') and not opts.get('file')):
        opts['number'] = True

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

357 358 359 360
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
361

362
    ui.pager('annotate')
363
    rootfm = ui.formatter('annotate', opts)
364 365 366 367 368
    if ui.debugflag:
        shorthex = pycompat.identity
    else:
        def shorthex(h):
            return h[:12]
369
    if ui.quiet:
370
        datefunc = dateutil.shortdate
371
    else:
372
        datefunc = dateutil.datestr
373 374 375 376
    if ctx.rev() is None:
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
377
                if rev == wdirrev:
378 379 380 381 382
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
383
                if rev == wdirrev:
384 385 386
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
387
        def formathex(h):
388
            if h == wdirhex:
389
                return '%s+' % shorthex(hex(ctx.p1().node()))
390
            else:
391
                return '%s ' % shorthex(h)
392
    else:
393 394
        formatrev = b'%d'.__mod__
        formathex = shorthex
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409
    opmap = [
        ('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
        ('rev', ' ', lambda x: scmutil.intrev(x.fctx), formatrev),
        ('node', ' ', lambda x: hex(scmutil.binnode(x.fctx)), formathex),
        ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
        ('path', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
        ('lineno', ':', lambda x: x.lineno, pycompat.bytestr),
    ]
    opnamemap = {
        'rev': 'number',
        'node': 'changeset',
        'path': 'file',
        'lineno': 'line_number',
    }
410

411
    if rootfm.isplain():
412
        def makefunc(get, fmt):
413
            return lambda x: fmt(get(x))
414 415
    else:
        def makefunc(get, fmt):
416
            return get
417
    datahint = rootfm.datahint()
418
    funcmap = [(makefunc(get, fmt), sep) for fn, sep, get, fmt in opmap
419
               if opts.get(opnamemap.get(fn, fn)) or fn in datahint]
420
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
421
    fields = ' '.join(fn for fn, sep, get, fmt in opmap
422
                      if opts.get(opnamemap.get(fn, fn)) or fn in datahint)
423

424
    def bad(x, y):
425
        raise error.Abort("%s: %s" % (x, y))
426

427 428
    m = scmutil.match(ctx, pats, opts, badfn=bad)

429
    follow = not opts.get('no_follow')
430 431
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
432 433 434 435
    skiprevs = opts.get('skip')
    if skiprevs:
        skiprevs = scmutil.revrange(repo, skiprevs)

436
    uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
Matt Mackall's avatar
Matt Mackall committed
437 438
    for abs in ctx.walk(m):
        fctx = ctx[abs]
439
        rootfm.startitem()
440
        rootfm.data(path=abs)
Jun Wu's avatar
Jun Wu committed
441
        if not opts.get('text') and fctx.isbinary():
442
            rootfm.plain(_("%s: binary file\n") % uipathfn(abs))
443 444
            continue

445
        fm = rootfm.nested('lines', tmpl='{rev}: {line}')
446 447
        lines = fctx.annotate(follow=follow, skiprevs=skiprevs,
                              diffopts=diffopts)
448
        if not lines:
449
            fm.end()
450
            continue
451
        formats = []
452 453
        pieces = []

454
        for f, sep in funcmap:
455
            l = [f(n) for n in lines]
456
            if fm.isplain():
457 458 459
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
460 461
            else:
                formats.append(['%s' for x in l])
462
            pieces.append(l)
463

464
        for f, p, n in zip(zip(*formats), zip(*pieces), lines):
465
            fm.startitem()
466
            fm.context(fctx=n.fctx)
467
            fm.write(fields, "".join(f), *p)
468
            if n.skip:
469 470 471
                fmt = "* %s"
            else:
                fmt = ": %s"
472
            fm.write('line', fmt, n.text)
473

474
        if not lines[-1].text.endswith('\n'):
475
            fm.plain('\n')
476
        fm.end()
477

478
    rootfm.end()
479

480 481 482 483 484 485 486
@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,
487 488
    _('[OPTION]... DEST'),
    helpcategory=command.CATEGORY_IMPORT_EXPORT)
489
def archive(ui, repo, dest, **opts):
490
    '''create an unversioned archive of a repository revision
491

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

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

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

510
    Valid types are:
511

512 513 514 515 516 517
    :``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
518

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

522 523 524 525
    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.
526 527

    Returns 0 on success.
528 529
    '''

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

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

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

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

557 558
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
559 560 561
    ('', 'commit', None,
     _('commit if no conflicts were encountered (DEPRECATED)')),
    ('', 'no-commit', None, _('do not commit')),
562 563
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
564
    ('r', 'rev', '', _('revision to backout'), _('REV')),
565
    ('e', 'edit', False, _('invoke editor on commit messages')),
566
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
567 568
    _('[OPTION]... [-r] REV'),
    helpcategory=command.CATEGORY_CHANGE_MANAGEMENT)
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
    with repo.wlock(), repo.lock():
622
        return _dobackout(ui, repo, node, rev, **opts)
623

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

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

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

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

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

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

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

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

668
    # the backout should appear on the same branch
669 670 671 672
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
673
        with dirstateguard.dirstateguard(repo, 'backout'):
674 675
            overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
            with ui.configoverride(overrides, 'backout'):
676 677 678
                stats = mergemod.update(repo, parent, branchmerge=True,
                                        force=True, ancestor=node,
                                        mergeancestor=False)
679
            repo.setparents(op1, op2)
680 681 682 683 684
        hg._showstats(repo, stats)
        if stats.unresolvedcount:
            repo.ui.status(_("use 'hg resolve' to retry unresolved "
                             "file merges\n"))
            return 1
685 686 687 688 689
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

690 691 692 693 694
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
695 696 697

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
698 699
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
        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()))
720 721
        overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
        with ui.configoverride(overrides, 'backout'):
722
            return hg.merge(repo, hex(repo.changelog.tip()))
723
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
724

725 726 727 728 729 730 731 732
@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'))],
733 734
    _("[-gbsr] [-U] [-c CMD] [REV]"),
    helpcategory=command.CATEGORY_CHANGE_NAVIGATION)
735
def bisect(ui, repo, rev=None, extra=None, command=None,
736 737
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
738 739
    """subdivision search of changesets

740 741 742 743 744 745 746 747 748 749 750 751 752
    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.
753 754 755 756 757 758
    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.
759

760 761 762 763
    .. container:: verbose

      Some examples:

764
      - start a bisection with known bad revision 34, and good revision 12::
765 766 767 768 769 770 771 772 773 774

          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
775
      - mark the current revision, or a known revision, to be skipped (e.g. if
776 777 778 779 780
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

781
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
782

783
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
784

785 786 787 788 789 790 791 792 793 794
      - 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
795
          hg bisect --command "make && make tests"
796 797 798 799 800 801

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

          hg log -r "bisect(pruned)"

802 803 804 805 806
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

807 808 809 810
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

811
      - you can even get a nice graph::
812 813 814

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

815
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
816

817
    Returns 0 on success.
818 819 820 821 822 823 824 825 826 827 828
    """
    # 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
829
    elif extra:
830
        raise error.Abort(_('incompatible arguments'))
831

832 833 834 835 836 837 838 839 840
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

841 842 843