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
dryrunopts = cmdutil.dryrunopts
remoteopts = cmdutil.remoteopts
walkopts = cmdutil.walkopts
commitopts = cmdutil.commitopts
commitopts2 = cmdutil.commitopts2
121
commitopts3 = cmdutil.commitopts3
122 123 124 125 126 127 128 129 130 131
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
132

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

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
@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)

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

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

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

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

    .. container:: verbose

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

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

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

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

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

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

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

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

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

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

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

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

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

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    .. 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.

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

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

350 351 352 353 354 355 356 357
    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'))

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

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

397 398 399 400 401 402 403 404 405 406 407 408 409 410
    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',
    }
411

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

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

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

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

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

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

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

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

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

479
    rootfm.end()
480

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

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

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

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

511
    Valid types are:
512

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

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

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

    Returns 0 on success.
529 530
    '''

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

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

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

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

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

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

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

580
    .. note::
581

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

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

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

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

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

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

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

619 620
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
621
    '''
622
    with repo.wlock(), repo.lock():
623
        return _dobackout(ui, repo, node, rev, **opts)
624

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

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

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

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

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

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

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

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

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

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

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

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

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

761 762 763 764
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

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

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

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

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

          hg log -r "bisect(range)"

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

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

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

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

833 834 835 836 837 838 839 840 841
    incompatibles = {
        '--bad':