commands.py 146 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
14
import archival, changegroup, cmdutil, sshserver, hbisect, hgweb, hgweb.server
15
import merge as mergemod
16
import minirst
17

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

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

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

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

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

    .. container:: verbose

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

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

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

    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))
58
    if not opts.get('dry_run'):
59 60
        bad += [f for f in repo.add(names) if f in m.files()]
    return bad and 1 or 0
61

62
def addremove(ui, repo, *pats, **opts):
63
    """add all new files, delete all missing files
64

65 66
    Add all new files and remove all missing files from the
    repository.
67

68 69 70
    New files are ignored if they match any of the patterns in
    .hgignore. As with add, these changes take effect at the next
    commit.
71

72 73 74 75 76 77
    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
    can be expensive.
78 79

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

89
def annotate(ui, repo, *pats, **opts):
90
    """show changeset information by line for each file
91

92 93
    List changes in files, showing the revision id responsible for
    each line
94

95 96
    This command is useful for discovering when a change was made and
    by whom.
97

98 99 100 101
    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.
102 103

    Returns 0 on success.
104
    """
105 106 107 108 109
    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

110 111
    datefunc = ui.quiet and util.shortdate or util.datestr
    getdate = util.cachefunc(lambda x: datefunc(x[0].date()))
112

113
    if not pats:
114
        raise util.Abort(_('at least one filename or pattern is required'))
115

116 117 118 119
    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),
120
             ('file', lambda x: x[0].path()),
121 122
            ]

123
    if (not opts.get('user') and not opts.get('changeset')
124
        and not opts.get('date') and not opts.get('file')):
125
        opts['number'] = 1
126

127
    linenumber = opts.get('line_number') is not None
128
    if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
129 130 131 132 133 134 135
        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])

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

145
        lines = fctx.annotate(follow=follow, linenumber=linenumber)
146 147
        pieces = []

148 149 150
        for f in funcmap:
            l = [f(n) for n, dummy in lines]
            if l:
151 152
                ml = max(map(len, l))
                pieces.append(["%*s" % (ml, x) for x in l])
153

mpm@selenic.com's avatar
mpm@selenic.com committed
154 155 156
        if pieces:
            for p, l in zip(zip(*pieces), lines):
                ui.write("%s: %s" % (" ".join(p), l[1]))
157

158
def archive(ui, repo, dest, **opts):
159
    '''create an unversioned archive of a repository revision
160

161 162
    By default, the revision used is the parent of the working
    directory; use -r/--rev to specify a different revision.
163

164 165 166 167
    The archive type is automatically detected based on file
    extension (or override using -t/--type).

    Valid types are:
168

169 170 171 172 173 174
    :``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
175

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

179 180 181 182
    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.
183 184

    Returns 0 on success.
185 186
    '''

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

    def guess_type():
        exttypes = {
            'tar': ['.tar'],
            'tbz2': ['.tbz2', '.tar.bz2'],
            'tgz': ['.tgz', '.tar.gz'],
            'zip': ['.zip'],
        }

        for type, extensions in exttypes.items():
204
            if util.any(dest.endswith(ext) for ext in extensions):
205 206 207 208
                return type
        return None

    kind = opts.get('type') or guess_type() or 'files'
209
    prefix = opts.get('prefix')
210

211 212 213 214
    if dest == '-':
        if kind == 'files':
            raise util.Abort(_('cannot archive plain files to stdout'))
        dest = sys.stdout
215 216
        if not prefix:
            prefix = os.path.basename(repo.root) + '-%h'
217

Vadim Gelfer's avatar
Vadim Gelfer committed
218
    prefix = cmdutil.make_filename(repo, prefix, node)
219
    matchfn = cmdutil.match(repo, [], opts)
220
    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
221
                     matchfn, prefix)
222

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

226 227
    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
228

229 230 231
    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
232

233 234 235 236
    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.
237

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

    Returns 0 on success.
241
    '''
Daniel Holth's avatar
Daniel Holth committed
242 243 244 245 246
    if rev and node:
        raise util.Abort(_("please specify just one revision"))

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

248 249 250
    if not rev:
        raise util.Abort(_("please specify a revision to backout"))

251 252 253 254
    date = opts.get('date')
    if date:
        opts['date'] = util.parsedate(date)

255
    cmdutil.bail_if_changed(repo)
Vadim Gelfer's avatar
Vadim Gelfer committed
256
    node = repo.lookup(rev)
257

258
    op1, op2 = repo.dirstate.parents()
259 260
    a = repo.changelog.ancestor(op1, node)
    if a != node:
261
        raise util.Abort(_('cannot backout change on a different branch'))
262

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

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

313
def bisect(ui, repo, rev=None, extra=None, command=None,
314 315 316
               reset=None, good=None, bad=None, skip=None, noupdate=None):
    """subdivision search of changesets

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

    Returns 0 on success.
336
    """
337 338 339 340
    def print_result(nodes, good):
        displayer = cmdutil.show_changeset(ui, repo, {})
        if len(nodes) == 1:
            # narrowed it down to a single revision
341 342 343 344
            if good:
                ui.write(_("The first good revision is:\n"))
            else:
                ui.write(_("The first bad revision is:\n"))
345
            displayer.show(repo[nodes[0]])
346 347
        else:
            # multiple possible revisions
348 349 350 351 352 353
            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"))
354
            for n in nodes:
355
                displayer.show(repo[n])
356
        displayer.close()
357 358 359 360 361 362 363 364 365 366 367

    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

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

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

387 388 389 390
    state = hbisect.load_state(repo)

    if command:
        changesets = 1
391 392 393
        try:
            while changesets:
                # update state
394
                status = util.system(command)
395 396 397 398 399 400 401 402 403 404 405
                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"
406 407 408
                ctx = repo[rev or '.']
                state[transition].append(ctx.node())
                ui.status(_('Changeset %d:%s: %s\n') % (ctx, ctx, transition))
409 410 411 412 413 414 415 416
                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)
417 418
        print_result(nodes, good)
        return
419 420 421

    # update state
    node = repo.lookup(rev or '.')
422 423 424 425 426 427 428 429
    if good or bad or skip:
        if good:
            state['good'].append(node)
        elif bad:
            state['bad'].append(node)
        elif skip:
            state['skip'].append(node)
        hbisect.save_state(repo, state)
430

431 432
    if not check_state(state):
        return
433 434

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

453
def branch(ui, repo, label=None, **opts):
454 455
    """set or show the current branch name

456 457 458 459 460
    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.
461

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

465 466 467
    Use -C/--clean to reset the working directory branch to that of
    the parent of the working directory, negating a previous branch
    change.
468

Martin Geisler's avatar
Martin Geisler committed
469 470
    Use the command :hg:`update` to switch to an existing branch. Use
    :hg:`commit --close-branch` to mark this branch as closed.
471 472

    Returns 0 on success.
473 474
    """

475 476 477 478 479
    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:
480 481
        utflabel = encoding.fromlocal(label)
        if not opts.get('force') and utflabel in repo.branchtags():
482
            if label not in [p.branch() for p in repo.parents()]:
483
                raise util.Abort(_('a branch of the same name already exists'
484
                                   " (use 'hg update' to switch to it)"))
485
        repo.dirstate.setbranch(utflabel)
486
        ui.status(_('marked working directory as branch %s\n') % label)
487
    else:
488
        ui.write("%s\n" % encoding.tolocal(repo.dirstate.branch()))
489

490
def branches(ui, repo, active=False, closed=False):
491 492
    """list repository named branches

493 494 495
    List the repository's named branches, indicating which ones are
    inactive. If -c/--closed is specified, also list branches which have
    been marked closed (see hg commit --close-branch).
496

497 498
    If -a/--active is specified, only show active branches. A branch
    is considered active if it contains repository heads.
499

Martin Geisler's avatar
Martin Geisler committed
500
    Use the command :hg:`update` to switch to an existing branch.
501 502

    Returns 0.
503
    """
504

505
    hexfunc = ui.debugflag and hex or short
506
    activebranches = [repo[n].branch() for n in repo.heads()]
507 508 509 510 511
    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)
512 513
                          for tag, node in repo.branchtags().items()],
                      reverse=True)
514 515 516

    for isactive, node, tag in branches:
        if (not active) or isactive:
517
            encodedtag = encoding.tolocal(tag)
518
            if ui.quiet:
519
                ui.write("%s\n" % encodedtag)
520
            else:
521 522 523 524
                hn = repo.lookup(node)
                if isactive:
                    notice = ''
                elif hn not in repo.branchheads(tag, closed=False):
525 526
                    if not closed:
                        continue
527
                    notice = _(' (closed)')
528
                else:
529
                    notice = _(' (inactive)')
530 531
                rev = str(node).rjust(31 - encoding.colwidth(encodedtag))
                data = encodedtag, rev, hexfunc(hn), notice
532
                ui.write("%s %s:%s%s\n" % data)
533

534
def bundle(ui, repo, fname, dest=None, **opts):
535 536
    """create a changegroup file

537 538
    Generate a compressed changegroup file collecting changesets not
    known to be in another repository.
539

timeless's avatar
timeless committed
540 541
    If you omit the destination repository, then hg assumes the
    destination will have all the nodes you specify with --base
542 543
    parameters. To create a bundle containing all changesets, use
    -a/--all (or --base null).
544

545 546 547
    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).
548

549 550 551 552
    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.
553

554 555
    Applying bundles preserves all changeset contents including
    permissions, copy/rename information, and revision history.
556 557

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

601 602
    if not o:
        ui.status(_("no changes found\n"))
603
        return 1
604

605 606 607 608
    if revs:
        cg = repo.changegroupsubset(o, revs, 'bundle')
    else:
        cg = repo.changegroup(o, 'bundle')
609 610 611 612 613 614 615 616

    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)
617

618
def cat(ui, repo, file1, *pats, **opts):
619
    """output the current or given revision of files
620

621 622 623
    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.
624

625 626
    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
627
    for the export command, with the following additions:
628

629 630 631
    :``%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
632 633

    Returns 0 on success.
634
    """
635
    ctx = repo[opts.get('rev')]
Matt Mackall's avatar
Matt Mackall committed
636
    err = 1
637
    m = cmdutil.match(repo, (file1,) + pats, opts)
Matt Mackall's avatar
Matt Mackall committed
638
    for abs in ctx.walk(m):
639
        fp = cmdutil.make_file(repo, opts.get('output'), ctx.node(), pathname=abs)
Matt Mackall's avatar
Matt Mackall committed
640
        data = ctx[abs].data()
641
        if opts.get('decode'):
642 643
            data = repo.wwritedata(abs, data)
        fp.write(data)
Matt Mackall's avatar
Matt Mackall committed
644 645
        err = 0
    return err
mpm@selenic.com's avatar
mpm@selenic.com committed
646

647
def clone(ui, source, dest=None, **opts):
648 649 650 651
    """make a copy of an existing repository

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

652 653
    If no destination directory name is specified, it defaults to the
    basename of the source.
654

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

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

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

664 665 666 667
    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
668 669
    defined by all -r/--rev options (including all their ancestors)
    will be pulled into the destination repository.
670 671 672 673 674 675
    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.

676 677
    For efficiency, hardlinks are used for cloning whenever the source
    and destination are on the same filesystem (note this applies only
678
    to the repository data, not to the working directory). Some
679 680 681
    filesystems, such as AFS, implement hardlinking incorrectly, but
    do not report errors. In these cases, use the --pull option to
    avoid hardlinking.
682

683
    In some cases, you can clone repositories and the working directory
684
    using full hardlinks with ::
685 686 687

      $ cp -al REPO REPOCLONE

688 689 690 691 692 693
    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.
694 695 696 697

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

698 699 700 701 702 703 704 705 706 707
    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
708 709

    Returns 0 on success.
710
    """
711 712 713
    if opts.get('noupdate') and opts.get('updaterev'):
        raise util.Abort(_("cannot specify both --noupdate and --updaterev"))

714 715 716 717 718 719 720 721
    r = hg.clone(cmdutil.remoteui(ui, opts), source, dest,
                 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
722

723
def commit(ui, repo, *pats, **opts):
724 725
    """commit the specified files or all outstanding changes

726
    Commit changes to the given files into the repository. Unlike a
727 728
    centralized RCS, this operation is a local operation. See hg push
    for a way to actively distribute your changes.
729

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

733 734
    If you are committing the result of a merge, do not provide any
    filenames or -I/-X filters.
735

736 737
    If no commit message is specified, the configured editor is
    started to prompt you for a message.
738

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

    Returns 0 on success, 1 if nothing changed.
742
    """
743 744
    extra = {}
    if opts.get('close_branch'):
745 746 747 748
        if repo['.'].node() not in repo.branchheads():
            # The topo heads set is included in the branch heads set of the
            # current branch, so it's sufficient to test branchheads
            raise util.Abort(_('can only close branch heads'))
749
        extra['close'] = 1
750 751 752 753
    e = cmdutil.commiteditor
    if opts.get('force_editor'):
        e = cmdutil.commitforceeditor

754
    def commitfunc(ui, repo, message, match, opts):
755 756
        return repo.commit(message, opts.get('user'), opts.get('date'), match,
                           editor=e, extra=extra)
757

758 759 760
    branch = repo[None].branch()
    bheads = repo.branchheads(branch)

761 762
    node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
    if not node:
763
        ui.status(_("nothing changed\n"))
764
        return 1
765 766 767 768

    ctx = repo[node]
    parents = ctx.parents()

769 770
    if bheads and [x for x in parents
                   if x.node() not in bheads and x.branch() == branch]:
771
        ui.status(_('created new head\n'))