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

    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
        bad += [f for f in repo[None].add(names) if f in m.files()]
63
    return bad and 1 or 0
64

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

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

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

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
    can be expensive.
81 82

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

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

95 96
    List changes in files, showing the revision id responsible for
    each line
97

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

101 102 103 104
    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.
105 106

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

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

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

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

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

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

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

148
        lines = fctx.annotate(follow=follow, linenumber=linenumber)
149 150
        pieces = []

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

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

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

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

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

    Valid types are:
171

172 173 174 175 176 177
    :``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
178

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

182 183 184 185
    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.
186 187

    Returns 0 on success.
188 189
    '''

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

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

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

    kind = opts.get('type') or guess_type() or 'files'
212
    prefix = opts.get('prefix')
213

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

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

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

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

232 233 234
    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
235

236 237 238 239
    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.
240

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

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

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

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

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

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

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

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

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

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

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

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

    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

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

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

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

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

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

434 435
    if not check_state(state):
        return
436 437

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

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

459 460 461 462 463
    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.
464

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

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

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

    Returns 0 on success.
476 477
    """

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

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

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

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

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

    Returns 0.
506
    """
507

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

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

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

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

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

548 549 550
    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).
551

552 553 554 555
    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.
556

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

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

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

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

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

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

624 625 626
    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.
627

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

632 633 634
    :``%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
635 636

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

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

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

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

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

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

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

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

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

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

      $ cp -al REPO REPOCLONE

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

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

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

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

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

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

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

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

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

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

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

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

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

761 762 763
    branch = repo[None].branch()
    bheads = repo.branchheads(branch)

764 765
    node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
    if not node:
766
        ui.status(_("nothing changed\n"))
Matt Mackall's avatar