commands.py 159 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
    """

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

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

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

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

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

73 74 75 76 77 78
    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.
79 80

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Valid types are:
169

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

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

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

    Returns 0 on success.
186 187
    '''

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    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

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

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

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

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

    # update state
    node = repo.lookup(rev or '.')
423 424 425 426 427 428 429 430
    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)
431

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

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

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

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

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

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

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

    Returns 0 on success.
474 475
    """

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

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

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

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

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

    Returns 0.
504
    """
505

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      $ cp -al REPO REPOCLONE

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

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

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

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

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

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

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

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

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

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

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

    Returns 0 on success, 1 if nothing changed.
743
    """
744 745
    extra = {}
    if opts.get('close_branch'):
746 747 748 749
        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'))
750
        extra['close'] = 1
751 752 753 754
    e = cmdutil.commiteditor
    if opts.get('force_editor'):
        e = cmdutil.commitforceeditor

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

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

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