commands.py 223 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
13
import hg, scmutil, util, revlog, copies, error, bookmarks
14
import patch, help, encoding, templatekw, discovery
15
import archival, changegroup, cmdutil, hbisect
16
import sshserver, hgweb, commandserver
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
22 23
import random
import setdiscovery, treediscovery, dagutil, pvec, localrepo
24
import phases, obsolete, exchange
25

26 27 28 29
table = {}

command = cmdutil.command(table)

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

42 43 44 45 46 47 48 49 50
# common command options

globalopts = [
    ('R', 'repository', '',
     _('repository root directory or name of overlay bundle file'),
     _('REPO')),
    ('', 'cwd', '',
     _('change working directory'), _('DIR')),
    ('y', 'noninteractive', None,
51
     _('do not prompt, automatically pick the first choice for all prompts')),
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
    ('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')),
68
    ('', 'hidden', False, _('consider hidden changesets')),
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
]

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

104 105 106 107 108 109
# hidden for now
formatteropts = [
    ('T', 'template', '',
     _('display with template (DEPRECATED)'), _('TEMPLATE')),
]

110 111
templateopts = [
    ('', 'style', '',
112
     _('display using template map file (DEPRECATED)'), _('STYLE')),
113
    ('T', 'template', '',
114 115 116 117 118 119 120 121 122 123
     _('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')),
124
    ('G', 'graph', None, _("show the revision DAG")),
125 126 127 128 129 130 131 132
] + 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'))
]

133
diffwsopts = [
134 135 136 137 138 139
    ('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')),
140 141 142 143 144 145
    ]

diffopts2 = [
    ('p', 'show-function', None, _('show which function each change is in')),
    ('', 'reverse', None, _('produce a diff that undoes the changes')),
    ] + diffwsopts + [
146 147 148 149 150
    ('U', 'unified', '',
     _('number of lines of context to show'), _('NUM')),
    ('', 'stat', None, _('output diffstat-style summary of changes')),
]

151 152 153 154
mergetoolopts = [
    ('t', 'tool', '', _('specify merge tool')),
]

155 156 157 158 159 160 161 162 163 164
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
165
# Commands start here, listed alphabetically
166

167 168
@command('^add',
    walkopts + subrepoopts + dryrunopts,
169 170
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
171
def add(ui, repo, *pats, **opts):
172 173
    """add the specified files on the next commit

174 175
    Schedule files to be version controlled and added to the
    repository.
176

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

180
    If no names are given, add all files to the repository.
181 182 183 184

    .. container:: verbose

       An example showing how new (unknown) files are added
Martin Geisler's avatar
Martin Geisler committed
185
       automatically by :hg:`add`::
186 187 188 189 190 191 192 193

         $ ls
         foo.c
         $ hg status
         ? foo.c
         $ hg add
         adding foo.c
         $ hg status
194
         A foo.c
195 196

    Returns 0 if all files are successfully added.
197 198
    """

199
    m = scmutil.match(repo[None], pats, opts)
200
    rejected = cmdutil.add(ui, repo, m, opts.get('dry_run'),
201
                           opts.get('subrepos'), prefix="", explicitonly=False)
202
    return rejected and 1 or 0
203

204 205
@command('addremove',
    similarityopts + walkopts + dryrunopts,
206 207
    _('[OPTION]... [FILE]...'),
    inferrepo=True)
208
def addremove(ui, repo, *pats, **opts):
209
    """add all new files, delete all missing files
210

211 212
    Add all new files and remove all missing files from the
    repository.
213

214
    New files are ignored if they match any of the patterns in
215
    ``.hgignore``. As with add, these changes take effect at the next
216
    commit.
217

218
    Use the -s/--similarity option to detect renamed files. This
219
    option takes a percentage between 0 (disabled) and 100 (files must
220 221 222
    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
223
    can be expensive. After using this option, :hg:`status -C` can be
224 225 226
    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.
227 228

    Returns 0 if all files are successfully added.
229
    """
230
    try:
231
        sim = float(opts.get('similarity') or 100)
232 233
    except ValueError:
        raise util.Abort(_('similarity must be a number'))
234 235
    if sim < 0 or sim > 100:
        raise util.Abort(_('similarity must be between 0 and 100'))
236
    return scmutil.addremove(repo, pats, opts, similarity=sim / 100.0)
237

238 239 240 241 242 243 244 245 246 247 248 249
@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'))
250
    ] + diffwsopts + walkopts,
251 252
    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
    inferrepo=True)
253
def annotate(ui, repo, *pats, **opts):
254
    """show changeset information by line for each file
255

256 257
    List changes in files, showing the revision id responsible for
    each line
258

259 260
    This command is useful for discovering when a change was made and
    by whom.
261

262 263 264 265
    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.
266 267

    Returns 0 on success.
268
    """
269 270 271
    if not pats:
        raise util.Abort(_('at least one filename or pattern is required'))

272 273 274
    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
275
        opts['file'] = True
276

277
    datefunc = ui.quiet and util.shortdate or util.datestr
278 279
    hexfn = ui.debugflag and hex or short

280 281 282 283 284 285
    opmap = [('user', ' ', lambda x: x[0].user(), ui.shortuser),
             ('number', ' ', lambda x: x[0].rev(), str),
             ('changeset', ' ', lambda x: hexfn(x[0].node()), str),
             ('date', ' ', lambda x: x[0].date(), util.cachefunc(datefunc)),
             ('file', ' ', lambda x: x[0].path(), str),
             ('line_number', ':', lambda x: x[1], str),
286 287
            ]

288
    if (not opts.get('user') and not opts.get('changeset')
289
        and not opts.get('date') and not opts.get('file')):
290
        opts['number'] = True
291

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

296 297 298 299
    def makefunc(get, fmt):
        return lambda x: fmt(get(x))
    funcmap = [(makefunc(get, fmt), sep) for op, sep, get, fmt in opmap
               if opts.get(op)]
300
    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
301

302 303 304
    def bad(x, y):
        raise util.Abort("%s: %s" % (x, y))

305
    ctx = scmutil.revsingle(repo, opts.get('rev'))
306
    m = scmutil.match(ctx, pats, opts)
307
    m.bad = bad
308
    follow = not opts.get('no_follow')
309
    diffopts = patch.diffopts(ui, opts, section='annotate')
Matt Mackall's avatar
Matt Mackall committed
310 311
    for abs in ctx.walk(m):
        fctx = ctx[abs]
312
        if not opts.get('text') and util.binary(fctx.data()):
313
            ui.write(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
314 315
            continue

316 317
        lines = fctx.annotate(follow=follow, linenumber=linenumber,
                              diffopts=diffopts)
318
        formats = []
319 320
        pieces = []

321
        for f, sep in funcmap:
322 323
            l = [f(n) for n, dummy in lines]
            if l:
324 325 326
                sizes = [encoding.colwidth(x) for x in l]
                ml = max(sizes)
                formats.append([sep + ' ' * (ml - w) + '%s' for w in sizes])
327
                pieces.append(l)
328

329 330 331
        for f, p, l in zip(zip(*formats), zip(*pieces), lines):
            ui.write("".join(f) % p)
            ui.write(": %s" % l[1])
332

333 334
        if lines and not lines[-1][1].endswith('\n'):
            ui.write('\n')
335

336 337 338 339 340 341 342 343
@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'))
344
def archive(ui, repo, dest, **opts):
345
    '''create an unversioned archive of a repository revision
346

347 348
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
349

350 351 352
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

Matt Mackall's avatar
Matt Mackall committed
353 354 355 356 357 358 359 360 361 362 363 364
    .. 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*"

365
    Valid types are:
366

367 368 369 370 371 372
    :``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
373

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

377 378 379 380
    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.
381 382

    Returns 0 on success.
383 384
    '''

385
    ctx = scmutil.revsingle(repo, opts.get('rev'))
386
    if not ctx:
387
        raise util.Abort(_('no working directory: please specify a revision'))
388
    node = ctx.node()
389
    dest = cmdutil.makefilename(repo, dest, node)
390
    if os.path.realpath(dest) == repo.root:
391
        raise util.Abort(_('repository root cannot be destination'))
392

393
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
394
    prefix = opts.get('prefix')
395

396 397 398
    if dest == '-':
        if kind == 'files':
            raise util.Abort(_('cannot archive plain files to stdout'))
399
        dest = cmdutil.makefileobj(repo, dest)
400 401
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
402

403
    prefix = cmdutil.makefilename(repo, prefix, node)
404
    matchfn = scmutil.match(ctx, [], opts)
405
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
406
                     matchfn, prefix, subrepos=opts.get('subrepos'))
407

408 409
@command('backout',
    [('', 'merge', None, _('merge with old dirstate parent after backout')),
410 411
    ('', 'parent', '',
     _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
412
    ('r', 'rev', '', _('revision to backout'), _('REV')),
413
    ('e', 'edit', False, _('invoke editor on commit messages')),
414
    ] + mergetoolopts + walkopts + commitopts + commitopts2,
415
    _('[OPTION]... [-r] REV'))
Daniel Holth's avatar
Daniel Holth committed
416
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
417 418
    '''reverse effect of earlier changeset

419 420 421
    Prepare a new changeset with the effect of REV undone in the
    current working directory.

422
    If REV is the parent of the working directory, then this new changeset
423 424 425
    is committed automatically. Otherwise, hg needs to merge the
    changes and the merged result is left uncommitted.

426
    .. note::
427

428 429 430
      backout cannot be used to fix either an unwanted or
      incorrect merge.

Matt Mackall's avatar
Matt Mackall committed
431 432 433 434 435 436 437 438 439 440 441
    .. 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.
442

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

445 446
    Returns 0 on success, 1 if nothing to backout or there are unresolved
    files.
447
    '''
Daniel Holth's avatar
Daniel Holth committed
448 449 450 451 452
    if rev and node:
        raise util.Abort(_("please specify just one revision"))

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

454 455 456
    if not rev:
        raise util.Abort(_("please specify a revision to backout"))

457 458 459 460
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

461
    cmdutil.checkunfinished(repo)
462
    cmdutil.bailifchanged(repo)
463
    node = scmutil.revsingle(repo, rev).node()
464

465
    op1, op2 = repo.dirstate.parents()
466
    if not repo.changelog.isancestor(node, op1):
467
        raise util.Abort(_('cannot backout change that is not an ancestor'))
468

469 470
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
471
        raise util.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
472
    if p2 != nullid:
473
        if not opts.get('parent'):
474
            raise util.Abort(_('cannot backout a merge changeset'))
475 476
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
477
            raise util.Abort(_('%s is not a parent of %s') %
478
                             (short(p), short(node)))
479 480
        parent = p
    else:
481
        if opts.get('parent'):
482 483
            raise util.Abort(_('cannot use --parent on non-merge changeset'))
        parent = p1
484

485
    # the backout should appear on the same branch
486 487 488
    wlock = repo.wlock()
    try:
        branch = repo.dirstate.branch()
489
        bheads = repo.branchheads(branch)
490
        rctx = scmutil.revsingle(repo, hex(parent))
491 492
        if not opts.get('merge') and op1 != node:
            try:
493 494
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
495
                repo.dirstate.beginparentchange()
496 497
                stats = mergemod.update(repo, parent, True, True, False,
                                        node, False)
498
                repo.setparents(op1, op2)
499
                repo.dirstate.endparentchange()
500 501
                hg._showstats(repo, stats)
                if stats[3]:
502 503 504 505 506 507
                    repo.ui.status(_("use 'hg resolve' to retry unresolved "
                                     "file merges\n"))
                else:
                    msg = _("changeset %s backed out, "
                            "don't forget to commit.\n")
                    ui.status(msg % short(node))
508
                return stats[3] > 0
509
            finally:
510
                ui.setconfig('ui', 'forcemerge', '', '')
511 512 513 514 515
        else:
            hg.clean(repo, node, show_stats=False)
            repo.dirstate.setbranch(branch)
            cmdutil.revert(ui, repo, rctx, repo.dirstate.parents())

516

517
        def commitfunc(ui, repo, message, match, opts):
518 519
            editform = 'backout'
            e = cmdutil.getcommiteditor(editform=editform, **opts)
520 521 522
            if not message:
                # we don't translate commit messages
                message = "Backed out changeset %s" % short(node)
523
                e = cmdutil.getcommiteditor(edit=True, editform=editform)
524 525 526
            return repo.commit(message, opts.get('user'), opts.get('date'),
                               match, editor=e)
        newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
527 528 529
        if not newnode:
            ui.status(_("nothing changed\n"))
            return 1
530
        cmdutil.commitstatus(repo, newnode, branch, bheads)
531

532 533 534 535 536 537 538 539 540
        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:
541 542
                ui.setconfig('ui', 'forcemerge', opts.get('tool', ''),
                             'backout')
543 544
                return hg.merge(repo, hex(repo.changelog.tip()))
            finally:
545
                ui.setconfig('ui', 'forcemerge', '', '')
546 547
    finally:
        wlock.release()
548
    return 0
Vadim Gelfer's avatar
Vadim Gelfer committed
549

550 551 552 553 554 555 556 557 558
@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]"))
559
def bisect(ui, repo, rev=None, extra=None, command=None,
560 561
               reset=None, good=None, bad=None, skip=None, extend=None,
               noupdate=None):
562 563
    """subdivision search of changesets

564 565 566 567 568 569 570 571 572 573 574 575 576
    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.
577 578 579 580 581 582
    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.
583

584 585 586 587
    .. container:: verbose

      Some examples:

588
      - start a bisection with known bad revision 34, and good revision 12::
589 590 591 592 593 594 595 596 597 598

          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
599
      - mark the current revision, or a known revision, to be skipped (e.g. if
600 601 602 603 604
        that revision is not usable because of another issue)::

          hg bisect --skip
          hg bisect --skip 23

605
      - skip all revisions that do not touch directories ``foo`` or ``bar``::
606

607
          hg bisect --skip "!( file('path:foo') & file('path:bar') )"
608

609 610 611 612 613 614 615 616 617 618
      - 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
619
          hg bisect --command "make && make tests"
620 621 622 623 624 625

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

          hg log -r "bisect(pruned)"

626 627 628 629 630
      - see the changeset currently being bisected (especially useful
        if running with -U/--noupdate)::

          hg log -r "bisect(current)"

631 632 633 634
      - see all changesets that took part in the current bisection::

          hg log -r "bisect(range)"

635
      - you can even get a nice graph::
636 637 638

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

639 640
      See :hg:`help revsets` for more about the `bisect()` keyword.

641
    Returns 0 on success.
642
    """
643 644 645 646 647 648 649 650
    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:
            side = good and state['bad'] or state['good']
            num = len(set(i.node() for i in parents) & set(side))
            if num == 1:
Yuya Nishihara's avatar
Yuya Nishihara committed
651
                return parents[0].ancestor(parents[1])
652 653
        return None

654 655 656 657
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
658 659 660 661
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
662
            displayer.show(repo[nodes[0]])
663 664 665 666 667
            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')
668
                         % extendnode)
669 670
        else:
            # multiple possible revisions
671 672 673 674 675 676
            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"))
677
            for n in nodes:
678
                displayer.show(repo[n])
679
        displayer.close()
680 681 682 683 684 685 686 687 688 689 690

    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']:
                raise util.Abort(_('cannot bisect (no known good revisions)'))
            else:
                raise util.Abort(_('cannot bisect (no known bad revisions)'))
        return True

691 692 693 694 695 696 697 698 699 700
    # 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
701
    elif extra or good + bad + skip + reset + extend + bool(command) > 1:
702
        raise util.Abort(_('incompatible arguments'))
703

704 705
    cmdutil.checkunfinished(repo)

706 707 708 709 710 711
    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

712 713 714 715
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
716 717 718 719
        if noupdate:
            try:
                node = state['current'][0]
            except LookupError:
720 721
                raise util.Abort(_('current bisect revision is unknown - '
                                   'start a new bisect to fix'))
722
        else:
723 724 725
            node, p2 = repo.dirstate.parents()
            if p2 != nullid:
                raise util.Abort(_('current bisect revision is a merge'))
726 727 728
        try:
            while changesets:
                # update state
729
                state['current'] = [node]
730
                hbisect.save_state(repo, state)
731 732 733
                status = util.system(command,
                                     environ={'HG_NODE': hex(node)},
                                     out=ui.fout)
734 735 736 737 738 739 740 741 742 743 744
                if status == 125:
                    transition = "skip"
                elif status == 0:
                    transition = "good"
                # status < 0 means process was killed
                elif status == 127:
                    raise util.Abort(_("failed to execute %s") % command)
                elif status < 0:
                    raise util.Abort(_("%s killed") % command)
                else:
                    transition = "bad"
745
                ctx = scmutil.revsingle(repo, rev, node)
746
                rev = None # clear for future iterations
747
                state[transition].append(ctx.node())
748
                ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
749 750
                check_state(state, interactive=False)
                # bisect
751
                nodes, changesets, bgood = hbisect.bisect(repo.changelog, state)
752
                # update to next check
753 754 755 756
                node = nodes[0]
                if not noupdate:
                    cmdutil.bailifchanged(repo)
                    hg.clean(repo, node, show_stats=False)
757
        finally:
758
            state['current'] = [node]
759
            hbisect.save_state(repo, state)
760
        print_result(nodes, bgood)
761
        return
762 763

    # update state
764 765

    if rev:
766
        nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
767 768 769
    else:
        nodes = [repo.lookup('.')]

770 771
    if good or bad or skip:
        if good:
772
            state['good'] += nodes
773
        elif bad:
774
            state['bad'] += nodes
775
        elif skip:
776
            state['skip'] += nodes
777
        hbisect.save_state(repo, state)
778

779 780
    if not check_state(state):
        return
781 782

    # actually bisect
783
    nodes, changesets, good = hbisect.bisect(repo.changelog, state)
784 785 786 787
    if extend:
        if not changesets:
            extendnode = extendbisectrange(nodes, good)
            if extendnode is not None:
788 789
                ui.write(_("Extending search to changeset %d:%s\n")
                         % (extendnode.rev(), extendnode))
790 791
                state['current'] = [extendnode.node()]
                hbisect.save_state(repo, state)
792 793
                if noupdate:
                    return
794
                cmdutil.bailifchanged(repo)
795 796 797
                return hg.clean(repo, extendnode.node())
        raise util.Abort(_("nothing to extend"))

798
    if changesets == 0:
799
        print_result(nodes, good)
800 801 802
    else:
        assert len(nodes) == 1 # only a single node can be tested next
        node = nodes[0]
803 804 805 806 807
        # 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)
808 809
        ui.write(_("Testing changeset %d:%s "
                   "(%d changesets remaining, ~%d tests)\n")
810
                 % (rev, short(node), changesets, tests))
811 812
        state['current'] = [node]
        hbisect.save_state(repo, state)
813
        if not noupdate:
814
            cmdutil.bailifchanged(repo)
815 816
            return hg.clean(repo, node)

817
@command('bookmarks|bookmark',
818 819 820 821
    [('f', 'force', False, _('force')),
    ('r', 'rev', '', _('revision'), _('REV')),
    ('d', 'delete', False, _('delete a given bookmark')),
    ('m', 'rename', '', _('rename a given bookmark'), _('NAME')),
822
    ('i', 'inactive', False, _('mark a bookmark inactive'))],
823 824
    _('hg bookmarks [OPTIONS]... [NAME]...'))
def bookmark(ui, repo, *names, **opts):
825 826 827 828 829 830 831
    '''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'.
832 833
    The active bookmark is indicated with a '*'.
    When a commit is made, the active bookmark will advance to the new commit.
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
    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
    be created. Using :hg:'merge' will resolve the divergence.

    A bookmark named '@' has the special property that :hg:`clone` will
    check it out by default if it exists.

    .. container:: verbose

      Examples:

      - create an active bookmark for a new line of development::

          hg book new-feature

      - create an inactive bookmark as a place marker::

          hg book -i reviewed

      - create an inactive bookmark on another changeset::

          hg book -r .^ tested

      - move the '@' bookmark from another branch::