commands.py 244 KB
Newer Older
mpm@selenic.com's avatar
mpm@selenic.com committed
1 2
# commands.py - command processing for mercurial
#
3
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
mpm@selenic.com's avatar
mpm@selenic.com committed
4
#
5
# This software may be used and distributed according to the terms of the
Matt Mackall's avatar
Matt Mackall committed
6
# GNU General Public License version 2 or any later version.
mpm@selenic.com's avatar
mpm@selenic.com committed
7

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

28 29 30 31
table = {}

command = cmdutil.command(table)

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

44 45 46 47 48 49
# label constants
# until 3.5, bookmarks.current was the advertised name, not
# bookmarks.active, so we must use both to avoid breaking old
# custom styles
activebookmarklabel = 'bookmarks.active bookmarks.current'

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

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
59
     _('do not prompt, automatically pick the first choice for all prompts')),
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
    ('q', 'quiet', None, _('suppress output')),
    ('v', 'verbose', None, _('enable additional output')),
    ('', 'config', [],
     _('set/override config option (use \'section.name=value\')'),
     _('CONFIG')),
    ('', 'debug', None, _('enable debugging output')),
    ('', 'debugger', None, _('start debugger')),
    ('', 'encoding', encoding.encoding, _('set the charset encoding'),
     _('ENCODE')),
    ('', 'encodingmode', encoding.encodingmode,
     _('set the charset encoding mode'), _('MODE')),
    ('', 'traceback', None, _('always print a traceback on exception')),
    ('', 'time', None, _('time how long the command takes')),
    ('', 'profile', None, _('print command execution profile')),
    ('', 'version', None, _('output version information and exit')),
    ('h', 'help', None, _('display help and exit')),
76
    ('', 'hidden', False, _('consider hidden changesets')),
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
]

dryrunopts = [('n', 'dry-run', None,
               _('do not perform actions, just print output'))]

remoteopts = [
    ('e', 'ssh', '',
     _('specify ssh command to use'), _('CMD')),
    ('', 'remotecmd', '',
     _('specify hg command to run on the remote side'), _('CMD')),
    ('', 'insecure', None,
     _('do not verify server certificate (ignoring web.cacerts config)')),
]

walkopts = [
    ('I', 'include', [],
     _('include names matching the given patterns'), _('PATTERN')),
    ('X', 'exclude', [],
     _('exclude names matching the given patterns'), _('PATTERN')),
]

commitopts = [
    ('m', 'message', '',
     _('use text as commit message'), _('TEXT')),
    ('l', 'logfile', '',
     _('read commit message from file'), _('FILE')),
]

commitopts2 = [
    ('d', 'date', '',
     _('record the specified date as commit date'), _('DATE')),
    ('u', 'user', '',
     _('record the specified user as committer'), _('USER')),
]

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

118 119
templateopts = [
    ('', 'style', '',
120
     _('display using template map file (DEPRECATED)'), _('STYLE')),
121
    ('T', 'template', '',
122 123 124 125 126 127 128 129 130 131
     _('display with template'), _('TEMPLATE')),
]

logopts = [
    ('p', 'patch', None, _('show patch')),
    ('g', 'git', None, _('use git extended diff format')),
    ('l', 'limit', '',
     _('limit number of changes displayed'), _('NUM')),
    ('M', 'no-merges', None, _('do not show merges')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
132
    ('G', 'graph', None, _("show the revision DAG")),
133 134 135 136 137 138 139 140
] + templateopts

diffopts = [
    ('a', 'text', None, _('treat all files as text')),
    ('g', 'git', None, _('use git extended diff format')),
    ('', 'nodates', None, _('omit dates from diff headers'))
]

141
diffwsopts = [
142 143 144 145 146 147
    ('w', 'ignore-all-space', None,
     _('ignore white space when comparing lines')),
    ('b', 'ignore-space-change', None,
     _('ignore changes in the amount of white space')),
    ('B', 'ignore-blank-lines', None,
     _('ignore changes whose lines are all blank')),
148 149 150
    ]

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

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

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

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

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

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

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

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

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

    .. container:: verbose

       An example showing how new (unknown) files are added
Martin Geisler's avatar
Martin Geisler committed
195
       automatically by :hg:`add`::
196 197 198 199 200 201 202 203

         $ ls
         foo.c
         $ hg status
         ? foo.c
         $ hg add
         adding foo.c
         $ hg status
204
         A foo.c
205 206

    Returns 0 if all files are successfully added.
207 208
    """

209
    m = scmutil.match(repo[None], pats, opts)
210
    rejected = cmdutil.add(ui, repo, m, "", False, **opts)
211
    return rejected and 1 or 0
212

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

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

223
    New files are ignored if they match any of the patterns in
224
    ``.hgignore``. As with add, these changes take effect at the next
225
    commit.
226

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

    Returns 0 if all files are successfully added.
238
    """
239
    try:
240
        sim = float(opts.get('similarity') or 100)
241
    except ValueError:
242
        raise error.Abort(_('similarity must be a number'))
243
    if sim < 0 or sim > 100:
244
        raise error.Abort(_('similarity must be between 0 and 100'))
245
    matcher = scmutil.match(repo[None], pats, opts)
246
    return scmutil.addremove(repo, matcher, "", opts, similarity=sim / 100.0)
247

248 249 250 251 252 253 254 255 256 257 258 259
@command('^annotate|blame',
    [('r', 'rev', '', _('annotate the specified revision'), _('REV')),
    ('', 'follow', None,
     _('follow copies/renames and list the filename (DEPRECATED)')),
    ('', 'no-follow', None, _("don't follow copies and renames")),
    ('a', 'text', None, _('treat all files as text')),
    ('u', 'user', None, _('list the author (long with -v)')),
    ('f', 'file', None, _('list the filename')),
    ('d', 'date', None, _('list the date (short with -q)')),
    ('n', 'number', None, _('list the revision number (default)')),
    ('c', 'changeset', None, _('list the changeset')),
    ('l', 'line-number', None, _('show line number at the first appearance'))
260
    ] + diffwsopts + walkopts + formatteropts,
261 262
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
263
def annotate(ui, repo, *pats, **opts):
264
    """show changeset information by line for each file
265

266 267
    List changes in files, showing the revision id responsible for
    each line
268

269 270
    This command is useful for discovering when a change was made and
    by whom.
271

272 273 274 275
    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.
276 277

    Returns 0 on success.
278
    """
279
    if not pats:
280
        raise error.Abort(_('at least one filename or pattern is required'))
281

282 283 284
    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
285
        opts['file'] = True
286

287 288
    ctx = scmutil.revsingle(repo, opts.get('rev'))

289
    fm = ui.formatter('annotate', opts)
290 291 292 293
    if ui.quiet:
        datefunc = util.shortdate
    else:
        datefunc = util.datestr
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
    if ctx.rev() is None:
        def hexfn(node):
            if node is None:
                return None
            else:
                return fm.hexfunc(node)
        if opts.get('changeset'):
            # omit "+" suffix which is appended to node hex
            def formatrev(rev):
                if rev is None:
                    return '%d' % ctx.p1().rev()
                else:
                    return '%d' % rev
        else:
            def formatrev(rev):
                if rev is None:
                    return '%d+' % ctx.p1().rev()
                else:
                    return '%d ' % rev
        def formathex(hex):
            if hex is None:
                return '%s+' % fm.hexfunc(ctx.p1().node())
            else:
                return '%s ' % hex
    else:
        hexfn = fm.hexfunc
        formatrev = formathex = str
321

322
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
323 324
             ('number', ' ', lambda x: x[0].rev(), formatrev),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), formathex),
325 326 327
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
328
            ]
329
    fieldnamemap = {'number': 'rev', 'changeset': 'node'}
330

331
    if (not opts.get('user') and not opts.get('changeset')
332
        and not opts.get('date') and not opts.get('file')):
333
        opts['number'] = True
334

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

339 340 341 342 343 344
    if fm:
        def makefunc(get, fmt):
            return get
    else:
        def makefunc(get, fmt):
            return lambda x: fmt(get(x))
345 346
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
347
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
348 349
    fields = ' '.join(fieldnamemap.get(op, op) for op, sep, get, fmt in opmap
                      if opts.get(op))
350

351
    def bad(x, y):
352
        raise error.Abort("%s: %s" % (x, y))
353

354 355
    m = scmutil.match(ctx, pats, opts, badfn=bad)

356
    follow = not opts.get('no_follow')
357 358
    diffopts = patch.difffeatureopts(ui, opts, section='annotate',
                                     whitespace=True)
Matt Mackall's avatar
Matt Mackall committed
359 360
    for abs in ctx.walk(m):
        fctx = ctx[abs]
361
        if not opts.get('text') and util.binary(fctx.data()):
362
            fm.plain(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
363 364
            continue

365 366
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
367
        formats = []
368 369
        pieces = []

370
        for f, sep in funcmap:
371 372
            l = [f(n) for n, dummy in lines]
            if l:
373 374 375 376 377 378
                if fm:
                    formats.append(['%s' for x in l])
                else:
                    sizes = [encoding.colwidth(x) for x in l]
                    ml = max(sizes)
                    formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
379
                pieces.append(l)
380

381
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
382 383 384
            fm.startitem()
            fm.write(fields, "".join(f), *p)
            fm.write('line', ": %s", l[1])
385

386
        if lines and not lines[-1][1].endswith('\n'):
387 388 389
            fm.plain('\n')

    fm.end()
390

391 392 393 394 395 396 397 398
@command('archive',
    [('', 'no-decode', None, _('do not pass files through decoders')),
    ('p', 'prefix', '', _('directory prefix for files in archive'),
     _('PREFIX')),
    ('r', 'rev', '', _('revision to distribute'), _('REV')),
    ('t', 'type', '', _('type of distribution to create'), _('TYPE')),
    ] + subrepoopts + walkopts,
    _('[OPTION]... DEST'))
399
def archive(ui, repo, dest, **opts):
400
    '''create an unversioned archive of a repository revision
401

402 403
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
404

405 406 407
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

Matt Mackall's avatar
Matt Mackall committed
408 409 410 411 412 413 414 415 416 417 418 419
    .. 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*"

420
    Valid types are:
421

422 423 424 425 426 427
    :``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
428

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

432 433 434 435
    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.
436 437

    Returns 0 on success.
438 439
    '''

440
    ctx = scmutil.revsingle(repo, opts.get('rev'))
441
    if not ctx:
442
        raise error.Abort(_('no working directory: please specify a revision'))
443
    node = ctx.node()
444
    dest = cmdutil.makefilename(repo, dest, node)
445
    if os.path.realpath(dest) == repo.root:
446
        raise error.Abort(_('repository root cannot be destination'))
447

448
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
449
    prefix = opts.get('prefix')
450

451 452
    if dest == '-':
        if kind == 'files':
453
            raise error.Abort(_('cannot archive plain files to stdout'))
454
        dest = cmdutil.makefileobj(repo, dest)
455 456
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
457

458
    prefix = cmdutil.makefilename(repo, prefix, node)
459
    matchfn = scmutil.match(ctx, [], opts)
460
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
461
                     matchfn, prefix, subrepos=opts.get('subrepos'))
462

463 464
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
Mateusz Kwapich's avatar
Mateusz Kwapich committed
465
    ('', 'commit', None, _('commit if no conflicts were encountered')),
466 467
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
468
    ('r', 'rev', '', _('revision to backout'), _('REV')),
469
    ('e', 'edit', False, _('invoke editor on commit messages')),
470
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
471
    _('[OPTION]... [-r] REV'))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
472
def backout(ui, repo, node=None, rev=None, commit=False, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
473 474
    '''reverse effect of earlier changeset

475 476 477
    Prepare a new changeset with the effect of REV undone in the
    current working directory.

478
    If REV is the parent of the working directory, then this new changeset
479 480 481
    is committed automatically. Otherwise, hg needs to merge the
    changes and the merged result is left uncommitted.

482
    .. note::
483

484 485 486
      backout cannot be used to fix either an unwanted or
      incorrect merge.

Matt Mackall's avatar
Matt Mackall committed
487 488 489 490 491 492 493 494 495 496 497
    .. container:: verbose

      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.
498

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

501 502 503
    See :hg:`help revert` for a way to restore files to the state
    of another revision.

504 505
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
506
    '''
Daniel Holth's avatar
Daniel Holth committed
507
    if rev and node:
508
        raise error.Abort(_("please specify just one revision"))
Daniel Holth's avatar
Daniel Holth committed
509 510 511

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

513
    if not rev:
514
        raise error.Abort(_("please specify a revision to backout"))
515

516 517 518 519
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

520
    cmdutil.checkunfinished(repo)
521
    cmdutil.bailifchanged(repo)
522
    node = scmutil.revsingle(repo, rev).node()
523

524
    op1, op2 = repo.dirstate.parents()
525
    if not repo.changelog.isancestor(node, op1):
526
        raise error.Abort(_('cannot backout change that is not an ancestor'))
527

528 529
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
530
        raise error.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
531
    if p2 != nullid:
532
        if not opts.get('parent'):
533
            raise error.Abort(_('cannot backout a merge changeset'))
534 535
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
536
            raise error.Abort(_('%s is not a parent of %s') %
537
                             (short(p), short(node)))
538 539
        parent = p
    else:
540
        if opts.get('parent'):
541
            raise error.Abort(_('cannot use --parent on non-merge changeset'))
542
        parent = p1
543

544
    # the backout should appear on the same branch
545 546 547
    wlock = repo.wlock()
    try:
        branch = repo.dirstate.branch()
548
        bheads = repo.branchheads(branch)
549
        rctx = scmutil.revsingle(repo, hex(parent))
550
        if not opts.get('merge') and op1 != node:
551
            dsguard = cmdutil.dirstateguard(repo, 'backout')
552
            try:
553 554
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
555 556
                stats = mergemod.update(repo, parent, True, True, False,
                                        node, False)
557
                repo.setparents(op1, op2)
558
                dsguard.close()
559 560
                hg._showstats(repo, stats)
                if stats[3]:
561 562
                    repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                     "file merges\n"))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
563 564
                    return 1
                elif not commit:
565 566 567
                    msg = _("changeset %s backed out, "
                            "don't forget to commit.\n")
                    ui.status(msg % short(node))
Mateusz Kwapich's avatar
Mateusz Kwapich committed
568
                    return 0
569
            finally:
570
                ui.setconfig('ui', 'forcemerge', '', '')
571
                lockmod.release(dsguard)
572 573 574 575 576
        else:
            hg.clean(repo, node, show_stats=False)
            repo.dirstate.setbranch(branch)
            cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

577

578
        def commitfunc(ui, repo, message, match, opts):
579 580
            editform = 'backout'
            e = cmdutil.getcommiteditor(editform=editform, **opts)
581 582 583
            if not message:
                # we don't translate commit messages
                message = "Backed out changeset %s" % short(node)
584
                e = cmdutil.getcommiteditor(edit=True, editform=editform)
585 586 587
            return repo.commit(message, opts.get('user'), opts.get('date'),
                               match, editor=e)
        newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
588 589 590
        if not newnode:
            ui.status(_("nothing changed\n"))
            return 1
591
        cmdutil.commitstatus(repo, newnode, branch, bheads)
592

593 594 595 596 597 598 599 600 601
        def nice(node):
            return '%d:%s' % (repo.changelog.rev(node), short(node))
        ui.status(_('changeset %s backs out changeset %s\n') %
                  (nice(repo.changelog.tip()), nice(node)))
        if opts.get('merge') and op1 != node:
            hg.clean(repo, op1, show_stats=False)
            ui.status(_('merging with changeset %s\n')
                      % nice(repo.changelog.tip()))
            try:
602 603
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
604 605
                return hg.merge(repo, hex(repo.changelog.tip()))
            finally:
606
                ui.setconfig('ui', 'forcemerge', '', '')
607 608
    finally:
        wlock.release()
609
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
610

611 612 613 614 615 616 617 618 619
@command('bisect',
    [('r', 'reset', False, _('reset bisect state')),
    ('g', 'good', False, _('mark changeset good')),
    ('b', 'bad', False, _('mark changeset bad')),
    ('s', 'skip', False, _('skip testing changeset')),
    ('e', 'extend', False, _('extend the bisect range')),
    ('c', 'command', '', _('use command to check changeset state'), _('CMD')),
    ('U', 'noupdate', False, _('do not update to target'))],
    _("[-gbsr] [-U] [-c CMD] [REV]"))
620
def bisect(ui, repo, rev=None, extra=None, command=None,
621 622
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
623 624
    """subdivision search of changesets

625 626 627 628 629 630 631 632 633 634 635 636 637
    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.
638 639 640 641 642 643
    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.
644

645 646 647 648
    .. container:: verbose

      Some examples:

649
      - start a bisection with known bad revision 34, and good revision 12::
650 651 652 653 654 655 656 657 658 659

          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
660
      - mark the current revision, or a known revision, to be skipped (e.g. if
661 662 663 664 665
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

666
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
667

668
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
669

670 671 672 673 674 675 676 677 678 679
      - 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
680
          hg bisect --command "make && make tests"
681 682 683 684 685 686

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

          hg log -r "bisect(pruned)"

687 688 689 690 691
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

692 693 694 695
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

696
      - you can even get a nice graph::
697 698 699

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

700 701
      See :hg:`help revsets` for more about the `bisect()` keyword.

702
    Returns 0 on success.
703
    """
704 705 706 707 708
    def extendbisectrange(nodes, good):
        # bisect is incomplete when it ends on a merge node and
        # one of the parent was not checked.
        parents = repo[nodes[0]].parents()
        if len(parents) > 1:
709 710 711 712
            if good:
                side = state['bad']
            else:
                side = state['good']
713 714
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
715
                return parents[0].ancestor(parents[1])
716 717
        return None

718 719 720 721
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
722 723 724 725
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
726
            displayer.show(repo[nodes[0]])
727 728 729 730 731
            extendnode = extendbisectrange(nodes, good)
            if extendnode is not None:
                ui.write(_('Not all ancestors of this changeset have been'
                           ' checked.\nUse bisect --extend to continue the '
                           'bisection from\nthe common ancestor, %s.\n')
732
                         % extendnode)
733 734
        else:
            # multiple possible revisions
735 736 737 738 739 740
            if good:
                ui.write(_("Due to skipped revisions, the first "
                        "good revision could be any of:\n"))
            else:
                ui.write(_("Due to skipped revisions, the first "
                        "bad revision could be any of:\n"))
741
            for n in nodes:
742
                displayer.show(repo[n])
743
        displayer.close()
744 745 746 747 748 749

    def check_state(state, interactive=True):
        if not state['good'] or not state['bad']:
            if (good or bad or skip or reset) and interactive:
                return
            if not state['good']:
750
                raise error.Abort(_('cannot bisect (no known good revisions)'))
751
            else:
752
                raise error.Abort(_('cannot bisect (no known bad revisions)'))
753 754
        return True

755 756 757 758 759 760 761 762 763 764
    # 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
765
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
766
        raise error.Abort(_('incompatible arguments'))
767

768 769
    cmdutil.checkunfinished(repo)

770 771 772 773 774 775
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

776 777 778 779
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
780 781 782 783
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
784
                raise error.Abort(_('current bisect revision is unknown - '
785
                                   'start a new bisect to fix'))
786
        else:
787 788
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
789
                raise error.Abort(_('current bisect revision is a merge'))
790 791 792
        try:
            while changesets:
                # update state
793
                state['current'] = [node]
794
                hbisect.save_state(repo, state)
795
                status = ui.system(command, environ={'HG_NODE': hex(node)})
796 797 798 799 800 801
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
802
                    raise error.Abort(_("failed to execute %s") % command)
803
                elif status < 0:
804
                    raise error.Abort(_("%s killed") % command)
805 806
                else:
                    transition = "bad"
807
                ctx = scmutil.revsingle(repo, rev, node)
808
                rev = None # clear for future iterations
809
                state[transition].append(ctx.node())
810
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
811 812
                check_state(state, interactive=False)
                # bisect
813
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
814
                # update to next check
815 816 817 818
                node = nodes[0]
                if not noupdate:
                    cmdutil.bailifchanged(repo)
                    hg.clean(repo, node, show_stats=False)
819
        finally:
820
            state['current'] = [node]
821
            hbisect.save_state(repo, state)
822
        print_result(nodes, bgood)
823
        return
824 825

    # update state
826 827

    if rev:
828
        nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
829 830 831
    else:
        nodes = [repo.lookup('.')]

832 833
    if good or bad or skip:
        if good:
834
            state['good'] += nodes
835
        elif bad:
836
            state['bad'] += nodes
837
        elif skip:
838
            state['skip'] += nodes
839
        hbisect.save_state(repo, state)
840

841 842
    if not check_state(state):
        return
843 844

    # actually bisect
845
    nodes, changesets, good = hbisect.bisect(repo.changelog, state)
846 847 848 849
    if extend:
        if not changesets:
            extendnode = extendbisectrange(nodes, good)
            if extendnode is not None:
850 851
                ui.write(_("Extending search to changeset %d:%s\n")
                         % (extendnode.rev(), extendnode))
852 853
                state['current'] = [extendnode.node()]
                hbisect.save_state(repo, state)
854 855
                if noupdate:
                    return
856
                cmdutil.bailifchanged(repo)
857
                return hg.clean(repo, extendnode.node())
858
        raise error.Abort(_("nothing to extend"))
859

860
    if changesets == 0:
861
        print_result(nodes, good)
862 863 864
    else:
        assert len(nodes) == 1 # only a single node can be tested next
        node = nodes[0]
865 866 867 868 869
        # compute the approximate number of remaining tests
        tests, size = 0, 2
        while size <= changesets:
            tests, size = tests + 1, size * 2
        rev = repo.changelog.rev(node)
870 871
        ui.write(_("Testing changeset %d:%s "
                   "(%d changesets remaining, ~%d tests)\n")
872
                 % (rev, short(node), changesets, tests))
873 874
        state['current'] = [node]
        hbisect.save_state(repo, state)
875
        if not noupdate:
876
            cmdutil.bailifchanged(repo)
877 878
            return hg.clean(repo, node)

879
@command('bookmarks|bookmark',
880 881 882
    [('f', 'force', False, _('force')),
    ('r', 'rev', '', _('revision'), _('REV')),
    ('d', 'delete', False, _('delete a given bookmark')),
883
    ('m', 'rename', '', _('rename a given bookmark'), _('OLD')),
884 885
    ('i', 'inactive', False, _('mark a bookmark inactive')),
    ] + formatteropts,
886 887
    _('hg bookmarks [OPTIONS]... [NAME]...'))
def bookmark(ui, repo, *names, **opts):
888 889 890 891 892 893 894
    '''create a new bookmark or list existing bookmarks

    Bookmarks are labels on changesets to help track lines of development.
    Bookmarks are unversioned and can be moved, renamed and deleted.
    Deleting or moving a bookmark has no effect on the associated changesets.

    Creating or updating to a bookmark causes it to be marked as 'active'.
895 896
    The active bookmark is indicated with a '*'.
    When a commit is made, the active bookmark will advance to the new commit.
897 898 899 900 901 902
    A plain :hg:`update` will also advance an active bookmark, if possible.
    Updating away from a bookmark will cause it to be deactivated.

    Bookmarks can be pushed and pulled between repositories (see
    :hg:`help push` and :hg:`help pull`). If a shared bookmark has
    diverged, a new 'divergent bookmark' of the form 'name@path' will
903
    be created. Using :hg:`merge` will resolve the divergence.
904 905 906 907