commands.py 226 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
    repair,
57
    revsetlang,
58
    rewriteutil,
Gregory Szorc's avatar
Gregory Szorc committed
59
    scmutil,
60
    server,
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 66
    templatekw,
    ui as uimod,
    util,
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
@command('add',
135
    walkopts + subrepoopts + dryrunopts,
136
    _('[OPTION]... [FILE]...'),
137
    helpcategory=command.CATEGORY_WORKING_DIRECTORY,
138
    helpbasic=True, inferrepo=True)
139
def add(ui, repo, *pats, **opts):
140 141
    """add the specified files on the next commit

142 143
    Schedule files to be version controlled and added to the
    repository.
144

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

timeless's avatar
timeless committed
148 149
    If no names are given, add all files to the repository (except
    files matching ``.hgignore``).
150 151 152

    .. container:: verbose

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
       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
178 179

    Returns 0 if all files are successfully added.
180 181
    """

182
    m = scmutil.match(repo[None], pats, pycompat.byteskwargs(opts))
183
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
184
    return rejected and 1 or 0
185

186
@command('addremove',
187
    similarityopts + subrepoopts + walkopts + dryrunopts,
188
    _('[OPTION]... [FILE]...'),
189
    helpcategory=command.CATEGORY_WORKING_DIRECTORY,
190
    inferrepo=True)
191
def addremove(ui, repo, *pats, **opts):
192
    """add all new files, delete all missing files
193

194 195
    Add all new files and remove all missing files from the
    repository.
196

timeless's avatar
timeless committed
197 198 199
    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.
200

201
    Use the -s/--similarity option to detect renamed files. This
202
    option takes a percentage between 0 (disabled) and 100 (files must
203 204 205
    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
206
    can be expensive. After using this option, :hg:`status -C` can be
207 208 209
    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.
210

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    .. 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

251
    Returns 0 if all files are successfully added.
252
    """
253
    opts = pycompat.byteskwargs(opts)
254 255
    if not opts.get('similarity'):
        opts['similarity'] = '100'
256
    matcher = scmutil.match(repo[None], pats, opts)
257
    return scmutil.addremove(repo, matcher, "", opts)
258

259
@command('annotate|blame',
260 261 262 263 264 265 266 267 268 269
    [('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')),
270 271
    ('l', 'line-number', None, _('show line number at the first appearance')),
    ('', 'skip', [], _('revision to not display (EXPERIMENTAL)'), _('REV')),
272
    ] + diffwsopts + walkopts + formatteropts,
273
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
274
    helpcategory=command.CATEGORY_FILE_CONTENTS,
275
    helpbasic=True, inferrepo=True)
276
def annotate(ui, repo, *pats, **opts):
277
    """show changeset information by line for each file
278

279
    List changes in files, showing the revision id responsible for
280
    each line.
281

282 283
    This command is useful for discovering when a change was made and
    by whom.
284

285 286 287
    If you include --file, --user, or --date, the revision number is
    suppressed unless you also include --number.

288 289 290 291
    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.
292

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
    .. 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.

312
    Returns 0 on success.
313
    """
314
    opts = pycompat.byteskwargs(opts)
315
    if not pats:
316
        raise error.Abort(_('at least one filename or pattern is required'))
317

318 319 320
    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
321
        opts['file'] = True
322

323 324 325 326
    rev = opts.get('rev')
    if rev:
        repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
    ctx = scmutil.revsingle(repo, rev)
327

328
    rootfm = ui.formatter('annotate', opts)
329 330 331 332 333
    if ui.debugflag:
        shorthex = pycompat.identity
    else:
        def shorthex(h):
            return h[:12]
334
    if ui.quiet:
335
        datefunc = dateutil.shortdate
336
    else:
337
        datefunc = dateutil.datestr
338 339 340 341
    if ctx.rev() is None:
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
342
                if rev == wdirrev:
343 344 345 346 347
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
348
                if rev == wdirrev:
349 350 351
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
352
        def formathex(h):
353
            if h == wdirhex:
354
                return '%s+' % shorthex(hex(ctx.p1().node()))
355
            else:
356
                return '%s ' % shorthex(h)
357
    else:
358 359
        formatrev = b'%d'.__mod__
        formathex = shorthex
360

361
    opmap = [('user', ' ', lambda x: x.fctx.user(), ui.shortuser),
362 363
             ('rev', ' ', lambda x: scmutil.intrev(x.fctx), formatrev),
             ('node', ' ', lambda x: hex(scmutil.binnode(x.fctx)), formathex),
364
             ('date', ' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
365
             ('path', ' ', lambda x: x.fctx.path(), pycompat.bytestr),
366
             ('lineno', ':', lambda x: x.lineno, pycompat.bytestr),
367
            ]
368 369
    opnamemap = {'rev': 'number', 'node': 'changeset', 'path': 'file',
                 'lineno': 'line_number'}
370

371
    if (not opts.get('user') and not opts.get('changeset')
372
        and not opts.get('date') and not opts.get('file')):
373
        opts['number'] = True
374

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

379 380
    ui.pager('annotate')

381
    if rootfm.isplain():
382
        def makefunc(get, fmt):
383
            return lambda x: fmt(get(x))
384 385
    else:
        def makefunc(get, fmt):
386
            return get
387
    datahint = rootfm.datahint()
388
    funcmap = [(makefunc(get, fmt), sep) for fn, sep, get, fmt in opmap
389
               if opts.get(opnamemap.get(fn, fn)) or fn in datahint]
390
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
391
    fields = ' '.join(fn for fn, sep, get, fmt in opmap
392
                      if opts.get(opnamemap.get(fn, fn)) or fn in datahint)
393

394
    def bad(x, y):
395
        raise error.Abort("%s: %s" % (x, y))
396

397 398
    m = scmutil.match(ctx, pats, opts, badfn=bad)

399
    follow = not opts.get('no_follow')
400 401
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
402 403 404 405
    skiprevs = opts.get('skip')
    if skiprevs:
        skiprevs = scmutil.revrange(repo, skiprevs)

Matt Mackall's avatar
Matt Mackall committed
406 407
    for abs in ctx.walk(m):
        fctx = ctx[abs]
408
        rootfm.startitem()
409
        rootfm.data(path=abs)
Jun Wu's avatar
Jun Wu committed
410
        if not opts.get('text') and fctx.isbinary():
411 412
            rootfm.plain(_("%s: binary file\n")
                         % ((pats and m.rel(abs)) or abs))
413 414
            continue

415
        fm = rootfm.nested('lines', tmpl='{rev}: {line}')
416 417
        lines = fctx.annotate(follow=follow, skiprevs=skiprevs,
                              diffopts=diffopts)
418
        if not lines:
419
            fm.end()
420
            continue
421
        formats = []
422 423
        pieces = []

424
        for f, sep in funcmap:
425
            l = [f(n) for n in lines]
426
            if fm.isplain():
427 428 429
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
430 431
            else:
                formats.append(['%s' for x in l])
432
            pieces.append(l)
433

434
        for f, p, n in zip(zip(*formats), zip(*pieces), lines):
435
            fm.startitem()
436
            fm.context(fctx=n.fctx)
437
            fm.write(fields, "".join(f), *p)
438
            if n.skip:
439 440 441
                fmt = "* %s"
            else:
                fmt = ": %s"
442
            fm.write('line', fmt, n.text)
443

444
        if not lines[-1].text.endswith('\n'):
445
            fm.plain('\n')
446
        fm.end()
447

448
    rootfm.end()
449

450 451 452 453 454 455 456
@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,
457 458
    _('[OPTION]... DEST'),
    helpcategory=command.CATEGORY_IMPORT_EXPORT)
459
def archive(ui, repo, dest, **opts):
460
    '''create an unversioned archive of a repository revision
461

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

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

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

480
    Valid types are:
481

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

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

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

    Returns 0 on success.
498 499
    '''

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

512
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
513
    prefix = opts.get('prefix')
514

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

522
    prefix = cmdutil.makefilename(ctx, prefix)
523
    match = scmutil.match(ctx, [], opts)
524
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
525
                     match, prefix, subrepos=opts.get('subrepos'))
526

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

542
    Prepare a new changeset with the effect of REV undone in the
543 544
    current working directory. If no conflicts were encountered,
    it will be committed immediately.
545

546
    If REV is the parent of the working directory, then this new changeset
547
    is committed automatically (unless --no-commit is specified).
548

549
    .. note::
550

551
       :hg:`backout` cannot be used to fix either an unwanted or
552
       incorrect merge.
553

Matt Mackall's avatar
Matt Mackall committed
554 555
    .. container:: verbose

556 557 558 559 560 561 562 563 564 565 566 567
      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
568
        leave changes uncommitted::
569

570 571
          hg backout -r 23 --no-commit
          hg commit -m "Backout revision 23"
572

Matt Mackall's avatar
Matt Mackall committed
573 574 575 576 577 578 579 580 581
      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.
582

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

585 586 587
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

588 589
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
590
    '''
591
    with repo.wlock(), repo.lock():
592
        return _dobackout(ui, repo, node, rev, **opts)
593

594
def _dobackout(ui, repo, node=None, rev=None, **opts):
595
    opts = pycompat.byteskwargs(opts)
596 597
    if opts.get('commit') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --commit with --no-commit"))
598 599
    if opts.get('merge') and opts.get('no_commit'):
        raise error.Abort(_("cannot use --merge with --no-commit"))
600

Daniel Holth's avatar
Daniel Holth committed
601
    if rev and node:
602
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
603 604 605

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

607
    if not rev:
608
        raise error.Abort(_("please specify a revision to backout"))
609

610 611
    date = opts.get('date')
    if date:
612
        opts['date'] = dateutil.parsedate(date)
613

614
    cmdutil.checkunfinished(repo)
615
    cmdutil.bailifchanged(repo)
616
    node = scmutil.revsingle(repo, rev).node()
617

618
    op1, op2 = repo.dirstate.parents()
619
    if not repo.changelog.isancestor(node, op1):
620
        raise error.Abort(_('cannot backout change that is not an ancestor'))
621

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

638
    # the backout should appear on the same branch
639 640 641 642
    branch = repo.dirstate.branch()
    bheads = repo.branchheads(branch)
    rctx = scmutil.revsingle(repo, hex(parent))
    if not opts.get('merge') and op1 != node:
643
        with dirstateguard.dirstateguard(repo, 'backout'):
644 645
            overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
            with ui.configoverride(overrides, 'backout'):
646 647 648
                stats = mergemod.update(repo, parent, branchmerge=True,
                                        force=True, ancestor=node,
                                        mergeancestor=False)
649
            repo.setparents(op1, op2)
650 651 652 653 654
        hg._showstats(repo, stats)
        if stats.unresolvedcount:
            repo.ui.status(_("use 'hg resolve' to retry unresolved "
                             "file merges\n"))
            return 1
655 656 657 658 659
    else:
        hg.clean(repo, node, show_stats=False)
        repo.dirstate.setbranch(branch)
        cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

660 661 662 663 664
    if opts.get('no_commit'):
        msg = _("changeset %s backed out, "
                "don't forget to commit.\n")
        ui.status(msg % short(node))
        return 0
665 666 667

    def commitfunc(ui, repo, message, match, opts):
        editform = 'backout'
668 669
        e = cmdutil.getcommiteditor(editform=editform,
                                    **pycompat.strkwargs(opts))
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
        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()))
690 691
        overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
        with ui.configoverride(overrides, 'backout'):
692
            return hg.merge(repo, hex(repo.changelog.tip()))
693
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
694

695 696 697 698 699 700 701 702
@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'))],
703 704
    _("[-gbsr] [-U] [-c CMD] [REV]"),
    helpcategory=command.CATEGORY_CHANGE_NAVIGATION)
705
def bisect(ui, repo, rev=None, extra=None, command=None,
706 707
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
708 709
    """subdivision search of changesets

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

730 731 732 733
    .. container:: verbose

      Some examples:

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

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

          hg bisect --skip
          hg bisect --skip 23

751
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
752

753
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
754

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

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

          hg log -r "bisect(pruned)"

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

          hg log -r "bisect(current)"

777 778 779 780
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

781
      - you can even get a nice graph::
782 783 784

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

785
      See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
786

787
    Returns 0 on success.
788 789 790 791 792 793 794 795 796 797 798
    """
    # 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
799
    elif extra:
800
        raise error.Abort(_('incompatible arguments'))
801

802 803 804 805 806 807 808 809 810
    incompatibles = {
        '--bad': bad,
        '--command': bool(command),
        '--extend': extend,
        '--good': good,
        '--reset': reset,
        '--skip': skip,
    }

811 812 813 814 815
    enabled = [x for x in incompatibles if incompatibles[x]]

    if len(enabled) > 1:
        raise error.Abort(_('%s and %s are incompatible') %
                          tuple(sorted(enabled)[0:2]))
816