commands.py 162 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, nullid, nullrev, short
9
from lock import release
10
from i18n import _, gettext
Benoit Boissinot's avatar
Benoit Boissinot committed
11 12
import os, re, sys, difflib, time, tempfile
import hg, util, revlog, bundlerepo, extensions, copies, error
13
import patch, help, mdiff, url, encoding, templatekw, discovery
14
import archival, changegroup, cmdutil, sshserver, hbisect, hgweb, hgweb.server
15
import merge as mergemod
16
import minirst, revset
17
import dagparser
18

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

21
def add(ui, repo, *pats, **opts):
22 23
    """add the specified files on the next commit

24 25
    Schedule files to be version controlled and added to the
    repository.
26

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

30
    If no names are given, add all files to the repository.
31 32 33 34

    .. container:: verbose

       An example showing how new (unknown) files are added
Martin Geisler's avatar
Martin Geisler committed
35
       automatically by :hg:`add`::
36 37 38 39 40 41 42 43

         $ ls
         foo.c
         $ hg status
         ? foo.c
         $ hg add
         adding foo.c
         $ hg status
44
         A foo.c
45 46

    Returns 0 if all files are successfully added.
47 48
    """

49
    bad = []
50
    names = []
51
    m = cmdutil.match(repo, pats, opts)
52
    oldbad = m.bad
53
    m.bad = lambda x, y: bad.append(x) or oldbad(x, y)
54 55 56 57 58 59 60

    for f in repo.walk(m):
        exact = m.exact(f)
        if exact or f not in repo.dirstate:
            names.append(f)
            if ui.verbose or not exact:
                ui.status(_('adding %s\n') % m.rel(f))
61
    if not opts.get('dry_run'):
62 63
        rejected = repo[None].add(names)
        bad += [f for f in rejected if f in m.files()]
64
    return bad and 1 or 0
65

66
def addremove(ui, repo, *pats, **opts):
67
    """add all new files, delete all missing files
68

69 70
    Add all new files and remove all missing files from the
    repository.
71

72 73 74
    New files are ignored if they match any of the patterns in
    .hgignore. As with add, these changes take effect at the next
    commit.
75

76 77 78 79 80
    Use the -s/--similarity option to detect renamed files. With a
    parameter greater than 0, this compares every removed file with
    every added file and records those similar enough as renames. This
    option takes a percentage between 0 (disabled) and 100 (files must
    be identical) as its parameter. Detecting renamed files this way
81 82
    can be expensive. After using this option, :hg:`status -C` can be
    used to check which files were identified as moved or renamed.
83 84

    Returns 0 if all files are successfully added.
85
    """
86
    try:
87
        sim = float(opts.get('similarity') or 100)
88 89
    except ValueError:
        raise util.Abort(_('similarity must be a number'))
90 91
    if sim < 0 or sim > 100:
        raise util.Abort(_('similarity must be between 0 and 100'))
92
    return cmdutil.addremove(repo, pats, opts, similarity=sim / 100.0)
93

94
def annotate(ui, repo, *pats, **opts):
95
    """show changeset information by line for each file
96

97 98
    List changes in files, showing the revision id responsible for
    each line
99

100 101
    This command is useful for discovering when a change was made and
    by whom.
102

103 104 105 106
    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.
107 108

    Returns 0 on success.
109
    """
110 111 112 113 114
    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
        opts['file'] = 1

115 116
    datefunc = ui.quiet and util.shortdate or util.datestr
    getdate = util.cachefunc(lambda x: datefunc(x[0].date()))
117

118
    if not pats:
119
        raise util.Abort(_('at least one filename or pattern is required'))
120

121 122 123 124
    opmap = [('user', lambda x: ui.shortuser(x[0].user())),
             ('number', lambda x: str(x[0].rev())),
             ('changeset', lambda x: short(x[0].node())),
             ('date', getdate),
125
             ('file', lambda x: x[0].path()),
126 127
            ]

128
    if (not opts.get('user') and not opts.get('changeset')
129
        and not opts.get('date') and not opts.get('file')):
130
        opts['number'] = 1
131

132
    linenumber = opts.get('line_number') is not None
133
    if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
134 135 136 137 138 139 140
        raise util.Abort(_('at least one of -n/-c is required for -l'))

    funcmap = [func for op, func in opmap if opts.get(op)]
    if linenumber:
        lastfunc = funcmap[-1]
        funcmap[-1] = lambda x: "%s:%s" % (lastfunc(x), x[1])

141
    ctx = repo[opts.get('rev')]
142
    m = cmdutil.match(repo, pats, opts)
143
    follow = not opts.get('no_follow')
Matt Mackall's avatar
Matt Mackall committed
144 145
    for abs in ctx.walk(m):
        fctx = ctx[abs]
146
        if not opts.get('text') and util.binary(fctx.data()):
147
            ui.write(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
148 149
            continue

150
        lines = fctx.annotate(follow=follow, linenumber=linenumber)
151 152
        pieces = []

153 154 155
        for f in funcmap:
            l = [f(n) for n, dummy in lines]
            if l:
156 157 158
                sized = [(x, encoding.colwidth(x)) for x in l]
                ml = max([w for x, w in sized])
                pieces.append(["%s%s" % (' ' * (ml - w), x) for x, w in sized])
159

mpm@selenic.com's avatar
mpm@selenic.com committed
160 161 162
        if pieces:
            for p, l in zip(zip(*pieces), lines):
                ui.write("%s: %s" % (" ".join(p), l[1]))
163

164
def archive(ui, repo, dest, **opts):
165
    '''create an unversioned archive of a repository revision
166

167 168
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
169

170 171 172 173
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

    Valid types are:
174

175 176 177 178 179 180
    :``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
181

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

185 186 187 188
    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.
189 190

    Returns 0 on success.
191 192
    '''

193
    ctx = repo[opts.get('rev')]
194
    if not ctx:
195
        raise util.Abort(_('no working directory: please specify a revision'))
196
    node = ctx.node()
Vadim Gelfer's avatar
Vadim Gelfer committed
197
    dest = cmdutil.make_filename(repo, dest, node)
198 199
    if os.path.realpath(dest) == repo.root:
        raise util.Abort(_('repository root cannot be destination'))
200

201
    kind = opts.get('type') or archival.guesskind(dest) or 'files'
202
    prefix = opts.get('prefix')
203

204 205 206 207
    if dest == '-':
        if kind == 'files':
            raise util.Abort(_('cannot archive plain files to stdout'))
        dest = sys.stdout
208 209
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
210

Vadim Gelfer's avatar
Vadim Gelfer committed
211
    prefix = cmdutil.make_filename(repo, prefix, node)
212
    matchfn = cmdutil.match(repo, [], opts)
213
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
214
                     matchfn, prefix)
215

Daniel Holth's avatar
Daniel Holth committed
216
def backout(ui, repo, node=None, rev=None, **opts):
Vadim Gelfer's avatar
Vadim Gelfer committed
217 218
    '''reverse effect of earlier changeset

219 220
    Commit the backed out changes as a new changeset. The new
    changeset is a child of the backed out changeset.
Vadim Gelfer's avatar
Vadim Gelfer committed
221

222 223 224
    If you backout a changeset other than the tip, a new head is
    created. This head will be the new tip and you should merge this
    backout changeset with another head.
Vadim Gelfer's avatar
Vadim Gelfer committed
225

226 227 228 229
    The --merge option remembers the parent of the working directory
    before starting the backout, then merges the new head with that
    changeset afterwards. This saves you from doing the merge by hand.
    The result of this merge is not committed, as with a normal merge.
230

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

    Returns 0 on success.
234
    '''
Daniel Holth's avatar
Daniel Holth committed
235 236 237 238 239
    if rev and node:
        raise util.Abort(_("please specify just one revision"))

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

241 242 243
    if not rev:
        raise util.Abort(_("please specify a revision to backout"))

244 245 246 247
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

248
    cmdutil.bail_if_changed(repo)
Vadim Gelfer's avatar
Vadim Gelfer committed
249
    node = repo.lookup(rev)
250

251
    op1, op2 = repo.dirstate.parents()
252 253
    a = repo.changelog.ancestor(op1, node)
    if a != node:
254
        raise util.Abort(_('cannot backout change on a different branch'))
255

256 257
    p1, p2 = repo.changelog.parents(node)
    if p1 == nullid:
258
        raise util.Abort(_('cannot backout a change with no parents'))
Vadim Gelfer's avatar
Vadim Gelfer committed
259
    if p2 != nullid:
260
        if not opts.get('parent'):
261
            raise util.Abort(_('cannot backout a merge changeset without '
262 263 264
                               '--parent'))
        p = repo.lookup(opts['parent'])
        if p not in (p1, p2):
265
            raise util.Abort(_('%s is not a parent of %s') %
266
                             (short(p), short(node)))
267 268
        parent = p
    else:
269
        if opts.get('parent'):
270 271
            raise util.Abort(_('cannot use --parent on non-merge changeset'))
        parent = p1
272

273 274
    # the backout should appear on the same branch
    branch = repo.dirstate.branch()
275
    hg.clean(repo, node, show_stats=False)
276
    repo.dirstate.setbranch(branch)
Vadim Gelfer's avatar
Vadim Gelfer committed
277
    revert_opts = opts.copy()
278
    revert_opts['date'] = None
279
    revert_opts['all'] = True
Vadim Gelfer's avatar
Vadim Gelfer committed
280
    revert_opts['rev'] = hex(parent)
281
    revert_opts['no_backup'] = None
Vadim Gelfer's avatar
Vadim Gelfer committed
282 283 284
    revert(ui, repo, **revert_opts)
    commit_opts = opts.copy()
    commit_opts['addremove'] = False
285
    if not commit_opts['message'] and not commit_opts['logfile']:
286
        # we don't translate commit messages
287
        commit_opts['message'] = "Backed out changeset %s" % short(node)
288
        commit_opts['force_editor'] = True
Vadim Gelfer's avatar
Vadim Gelfer committed
289 290 291 292 293
    commit(ui, repo, **commit_opts)
    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)))
294
    if op1 != node:
295
        hg.clean(repo, op1, show_stats=False)
296
        if opts.get('merge'):
297 298
            ui.status(_('merging with changeset %s\n')
                      % nice(repo.changelog.tip()))
299
            hg.merge(repo, hex(repo.changelog.tip()))
300 301 302
        else:
            ui.status(_('the backout changeset is a new head - '
                        'do not forget to merge\n'))
303 304
            ui.status(_('(use "backout --merge" '
                        'if you want to auto-merge)\n'))
Vadim Gelfer's avatar
Vadim Gelfer committed
305

306
def bisect(ui, repo, rev=None, extra=None, command=None,
307 308 309
               reset=None, good=None, bad=None, skip=None, noupdate=None):
    """subdivision search of changesets

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
    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.
    Its exit status 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.
327 328

    Returns 0 on success.
329
    """
330 331 332 333
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
334 335 336 337
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
338
            displayer.show(repo[nodes[0]])
339 340
            parents = repo[nodes[0]].parents()
            if len(parents) > 1:
341
                side = good and state['bad'] or state['good']
342 343 344 345 346 347
                num = len(set(i.node() for i in parents) & set(side))
                if num == 1:
                    common = parents[0].ancestor(parents[1])
                    ui.write(_('Not all ancestors of this changeset have been'
                               ' checked.\nTo check the other ancestors, start'
                               ' from the common ancestor, %s.\n' % common))
348 349
        else:
            # multiple possible revisions
350 351 352 353 354 355
            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"))
356
            for n in nodes:
357
                displayer.show(repo[n])
358
        displayer.close()
359 360 361 362 363 364 365 366 367 368 369

    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

370 371 372 373 374 375 376 377 378 379
    # 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
380
    elif extra or good + bad + skip + reset + bool(command) > 1:
381
        raise util.Abort(_('incompatible arguments'))
382 383 384 385 386 387 388

    if reset:
        p = repo.join("bisect.state")
        if os.path.exists(p):
            os.unlink(p)
        return

389 390 391 392
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
393 394 395
        try:
            while changesets:
                # update state
396
                status = util.system(command)
397 398 399 400 401 402 403 404 405 406 407
                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"
408 409 410
                ctx = repo[rev or '.']
                state[transition].append(ctx.node())
                ui.status(_('Changeset %d:%s: %s\n') % (ctx, ctx, transition))
411 412 413 414 415 416 417 418
                check_state(state, interactive=False)
                # bisect
                nodes, changesets, good = hbisect.bisect(repo.changelog, state)
                # update to next check
                cmdutil.bail_if_changed(repo)
                hg.clean(repo, nodes[0], show_stats=False)
        finally:
            hbisect.save_state(repo, state)
419 420
        print_result(nodes, good)
        return
421 422

    # update state
423 424 425 426 427 428

    if rev:
        nodes = [repo.lookup(i) for i in cmdutil.revrange(repo, [rev])]
    else:
        nodes = [repo.lookup('.')]

429 430
    if good or bad or skip:
        if good:
431
            state['good'] += nodes
432
        elif bad:
433
            state['bad'] += nodes
434
        elif skip:
435
            state['skip'] += nodes
436
        hbisect.save_state(repo, state)
437

438 439
    if not check_state(state):
        return
440 441

    # actually bisect
442
    nodes, changesets, good = hbisect.bisect(repo.changelog, state)
443
    if changesets == 0:
444
        print_result(nodes, good)
445 446 447
    else:
        assert len(nodes) == 1 # only a single node can be tested next
        node = nodes[0]
448 449 450 451 452
        # 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)
453 454
        ui.write(_("Testing changeset %d:%s "
                   "(%d changesets remaining, ~%d tests)\n")
455
                 % (rev, short(node), changesets, tests))
456 457 458 459
        if not noupdate:
            cmdutil.bail_if_changed(repo)
            return hg.clean(repo, node)

460
def branch(ui, repo, label=None, **opts):
461 462
    """set or show the current branch name

463 464 465 466 467
    With no argument, show the current branch name. With one argument,
    set the working directory branch name (the branch will not exist
    in the repository until the next commit). Standard practice
    recommends that primary development take place on the 'default'
    branch.
468

469 470
    Unless -f/--force is specified, branch will not let you set a
    branch name that already exists, even if it's inactive.
471

472 473 474
    Use -C/--clean to reset the working directory branch to that of
    the parent of the working directory, negating a previous branch
    change.
475

Martin Geisler's avatar
Martin Geisler committed
476 477
    Use the command :hg:`update` to switch to an existing branch. Use
    :hg:`commit --close-branch` to mark this branch as closed.
478 479

    Returns 0 on success.
480 481
    """

482 483 484 485 486
    if opts.get('clean'):
        label = repo[None].parents()[0].branch()
        repo.dirstate.setbranch(label)
        ui.status(_('reset working directory to branch %s\n') % label)
    elif label:
487 488
        utflabel = encoding.fromlocal(label)
        if not opts.get('force') and utflabel in repo.branchtags():
489
            if label not in [p.branch() for p in repo.parents()]:
490
                raise util.Abort(_('a branch of the same name already exists'
491
                                   " (use 'hg update' to switch to it)"))
492
        repo.dirstate.setbranch(utflabel)
493
        ui.status(_('marked working directory as branch %s\n') % label)
494
    else:
495
        ui.write("%s\n" % encoding.tolocal(repo.dirstate.branch()))
496

497
def branches(ui, repo, active=False, closed=False):
498 499
    """list repository named branches

500 501
    List the repository's named branches, indicating which ones are
    inactive. If -c/--closed is specified, also list branches which have
502
    been marked closed (see :hg:`commit --close-branch`).
503

504 505
    If -a/--active is specified, only show active branches. A branch
    is considered active if it contains repository heads.
506

Martin Geisler's avatar
Martin Geisler committed
507
    Use the command :hg:`update` to switch to an existing branch.
508 509

    Returns 0.
510
    """
511

512
    hexfunc = ui.debugflag and hex or short
513
    activebranches = [repo[n].branch() for n in repo.heads()]
514 515 516 517 518
    def testactive(tag, node):
        realhead = tag in activebranches
        open = node in repo.branchheads(tag, closed=False)
        return realhead and open
    branches = sorted([(testactive(tag, node), repo.changelog.rev(node), tag)
519 520
                          for tag, node in repo.branchtags().items()],
                      reverse=True)
521 522 523

    for isactive, node, tag in branches:
        if (not active) or isactive:
524
            encodedtag = encoding.tolocal(tag)
525
            if ui.quiet:
526
                ui.write("%s\n" % encodedtag)
527
            else:
528 529
                hn = repo.lookup(node)
                if isactive:
530
                    label = 'branches.active'
531 532
                    notice = ''
                elif hn not in repo.branchheads(tag, closed=False):
533 534
                    if not closed:
                        continue
535
                    label = 'branches.closed'
536
                    notice = _(' (closed)')
537
                else:
538
                    label = 'branches.inactive'
539
                    notice = _(' (inactive)')
540 541
                if tag == repo.dirstate.branch():
                    label = 'branches.current'
542
                rev = str(node).rjust(31 - encoding.colwidth(encodedtag))
543 544 545
                rev = ui.label('%s:%s' % (rev, hexfunc(hn)), 'log.changeset')
                encodedtag = ui.label(encodedtag, label)
                ui.write("%s %s%s\n" % (encodedtag, rev, notice))
546

547
def bundle(ui, repo, fname, dest=None, **opts):
548 549
    """create a changegroup file

550 551
    Generate a compressed changegroup file collecting changesets not
    known to be in another repository.
552

timeless's avatar
timeless committed
553 554
    If you omit the destination repository, then hg assumes the
    destination will have all the nodes you specify with --base
555 556
    parameters. To create a bundle containing all changesets, use
    -a/--all (or --base null).
557

558 559 560
    You can change compression method with the -t/--type option.
    The available compression methods are: none, bzip2, and
    gzip (by default, bundles are compressed using bzip2).
561

562 563 564 565
    The bundle file can then be transferred using conventional means
    and applied to another repository with the unbundle or pull
    command. This is useful when direct push and pull are not
    available or when exporting an entire repository is undesirable.
566

567 568
    Applying bundles preserves all changeset contents including
    permissions, copy/rename information, and revision history.
569 570

    Returns 0 on success, 1 if no changes found.
571
    """
572
    revs = opts.get('rev') or None
573 574 575 576
    if opts.get('all'):
        base = ['null']
    else:
        base = opts.get('base')
577 578
    if base:
        if dest:
579
            raise util.Abort(_("--base is incompatible with specifying "
580
                               "a destination"))
581 582 583
        base = [repo.lookup(rev) for rev in base]
        # create the right base
        # XXX: nodesbetween / changegroup* should be "fixed" instead
584
        o = []
585
        has = set((nullid,))
586
        for n in base:
Matt Mackall's avatar
Matt Mackall committed
587
            has.update(repo.changelog.reachable(n))
588
        if revs:
589 590 591
            revs = [repo.lookup(rev) for rev in revs]
            visit = revs[:]
            has.difference_update(visit)
592
        else:
593
            visit = repo.changelog.heads()
Matt Mackall's avatar
Matt Mackall committed
594
        seen = {}
595 596
        while visit:
            n = visit.pop(0)
Matt Mackall's avatar
Matt Mackall committed
597
            parents = [p for p in repo.changelog.parents(n) if p not in has]
598
            if len(parents) == 0:
599 600
                if n not in has:
                    o.append(n)
601
            else:
602 603
                for p in parents:
                    if p not in seen:
Matt Mackall's avatar
Matt Mackall committed
604
                        seen[p] = 1
605
                        visit.append(p)
606
    else:
607
        dest = ui.expandpath(dest or 'default-push', dest or 'default')
608
        dest, branches = hg.parseurl(dest, opts.get('branch'))
609
        other = hg.repository(hg.remoteui(repo, opts), dest)
610
        revs, checkout = hg.addbranchrevs(repo, other, branches, revs)
611 612
        if revs:
            revs = [repo.lookup(rev) for rev in revs]
613
        o = discovery.findoutgoing(repo, other, force=opts.get('force'))
614

615 616
    if not o:
        ui.status(_("no changes found\n"))
617
        return 1
618

619 620 621 622
    if revs:
        cg = repo.changegroupsubset(o, revs, 'bundle')
    else:
        cg = repo.changegroup(o, 'bundle')
623 624 625 626 627 628 629 630

    bundletype = opts.get('type', 'bzip2').lower()
    btypes = {'none': 'HG10UN', 'bzip2': 'HG10BZ', 'gzip': 'HG10GZ'}
    bundletype = btypes.get(bundletype)
    if bundletype not in changegroup.bundletypes:
        raise util.Abort(_('unknown bundle type specified with --type'))

    changegroup.writebundle(cg, fname, bundletype)
631

632
def cat(ui, repo, file1, *pats, **opts):
633
    """output the current or given revision of files
634

635 636 637
    Print the specified files as they were at the given revision. If
    no revision is given, the parent of the working directory is used,
    or tip if no revision is checked out.
638

639 640
    Output may be to a file, in which case the name of the file is
    given using a format string. The formatting rules are the same as
641
    for the export command, with the following additions:
642

643 644 645
    :``%s``: basename of file being printed
    :``%d``: dirname of file being printed, or '.' if in repository root
    :``%p``: root-relative path name of file being printed
646 647

    Returns 0 on success.
648
    """
649
    ctx = repo[opts.get('rev')]
Matt Mackall's avatar
Matt Mackall committed
650
    err = 1
651
    m = cmdutil.match(repo, (file1,) + pats, opts)
Matt Mackall's avatar
Matt Mackall committed
652
    for abs in ctx.walk(m):
653
        fp = cmdutil.make_file(repo, opts.get('output'), ctx.node(), pathname=abs)
Matt Mackall's avatar
Matt Mackall committed
654
        data = ctx[abs].data()
655
        if opts.get('decode'):
656 657
            data = repo.wwritedata(abs, data)
        fp.write(data)
Matt Mackall's avatar
Matt Mackall committed
658 659
        err = 0
    return err
mpm@selenic.com's avatar
mpm@selenic.com committed
660

661
def clone(ui, source, dest=None, **opts):
662 663 664 665
    """make a copy of an existing repository

    Create a copy of an existing repository in a new directory.

666 667
    If no destination directory name is specified, it defaults to the
    basename of the source.
668

669 670
    The location of the source is added to the new repository's
    .hg/hgrc file, as the default to be used for future pulls.
671

Martin Geisler's avatar
Martin Geisler committed
672
    See :hg:`help urls` for valid source format details.
673

674
    It is possible to specify an ``ssh://`` URL as the destination, but no
675
    .hg/hgrc and working directory will be created on the remote side.
Martin Geisler's avatar
Martin Geisler committed
676
    Please see :hg:`help urls` for important details about ``ssh://`` URLs.
677

678 679 680 681
    A set of changesets (tags, or branch names) to pull may be specified
    by listing each changeset (tag, or branch name) with -r/--rev.
    If -r/--rev is used, the cloned repository will contain only a subset
    of the changesets of the source repository. Only the set of changesets
Wagner Bruna's avatar
Wagner Bruna committed
682 683
    defined by all -r/--rev options (including all their ancestors)
    will be pulled into the destination repository.
684 685 686 687 688 689
    No subsequent changesets (including subsequent tags) will be present
    in the destination.

    Using -r/--rev (or 'clone src#rev dest') implies --pull, even for
    local source repositories.

690 691
    For efficiency, hardlinks are used for cloning whenever the source
    and destination are on the same filesystem (note this applies only
692
    to the repository data, not to the working directory). Some
693 694 695
    filesystems, such as AFS, implement hardlinking incorrectly, but
    do not report errors. In these cases, use the --pull option to
    avoid hardlinking.
696

697
    In some cases, you can clone repositories and the working directory
698
    using full hardlinks with ::
699 700 701

      $ cp -al REPO REPOCLONE

702 703 704 705 706 707
    This is the fastest way to clone, but it is not always safe. The
    operation is not atomic (making sure REPO is not modified during
    the operation is up to you) and you have to make sure your editor
    breaks hardlinks (Emacs and most Linux Kernel tools do so). Also,
    this is not compatible with certain extensions that place their
    metadata under the .hg directory, such as mq.
708 709 710 711

    Mercurial will update the working directory to the first applicable
    revision from this list:

712 713 714 715 716 717 718 719 720 721
    a) null if -U or the source repository has no changesets
    b) if -u . and the source repository is local, the first parent of
       the source repository's working directory
    c) the changeset specified with -u (if a branch name, this means the
       latest head of that branch)
    d) the changeset specified with -r
    e) the tipmost head specified with -b
    f) the tipmost head specified with the url#branch source syntax
    g) the tipmost head of the default branch
    h) tip
722 723

    Returns 0 on success.
724
    """
725 726 727
    if opts.get('noupdate') and opts.get('updaterev'):
        raise util.Abort(_("cannot specify both --noupdate and --updaterev"))

728
    r = hg.clone(hg.remoteui(ui, opts), source, dest,
729 730 731 732 733 734 735
                 pull=opts.get('pull'),
                 stream=opts.get('uncompressed'),
                 rev=opts.get('rev'),
                 update=opts.get('updaterev') or not opts.get('noupdate'),
                 branch=opts.get('branch'))

    return r is None
mpm@selenic.com's avatar
mpm@selenic.com committed
736

737
def commit(ui, repo, *pats, **opts):
738 739
    """commit the specified files or all outstanding changes

740
    Commit changes to the given files into the repository. Unlike a
741 742
    centralized RCS, this operation is a local operation. See
    :hg:`push` for a way to actively distribute your changes.
743

Martin Geisler's avatar
Martin Geisler committed
744
    If a list of files is omitted, all changes reported by :hg:`status`
745
    will be committed.
746

747 748
    If you are committing the result of a merge, do not provide any
    filenames or -I/-X filters.
749

750 751 752 753
    If no commit message is specified, Mercurial starts your
    configured editor where you can enter a message. In case your
    commit fails, you will find a backup of your message in
    ``.hg/last-message.txt``.