~bzr-pqm/bzr/bzr.dev : revision 5177.1.1

239

# opens the branch?)

240

241

class cmd_status(Command):

242

"""Display status summary.

242

__doc__ = """Display status summary.

243

244

This reports on versioned and unknown files, reporting them

245

grouped by state. Possible states are:

332

333

334

class cmd_cat_revision(Command):

335

"""Write out metadata for a revision.

335

__doc__ = """Write out metadata for a revision.

336

337

The revision to print can either be specified by a specific

338

revision identifier, or you can use --revision.

390

391

392

class cmd_dump_btree(Command):

393

"""Dump the contents of a btree index file to stdout.

393

__doc__ = """Dump the contents of a btree index file to stdout.

394

395

PATH is a btree index file, it can be any URL. This includes things like

396

.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix

471

472

473

class cmd_remove_tree(Command):

474

"""Remove the working tree from a given branch/checkout.

474

__doc__ = """Remove the working tree from a given branch/checkout.

475

476

Since a lightweight checkout is little more than a working tree

477

this will refuse to run against one.

514

515

516

class cmd_revno(Command):

517

"""Show current revision number.

517

__doc__ = """Show current revision number.

518

519

This is equal to the number of revisions on this branch.

520

"""

550

551

552

class cmd_revision_info(Command):

553

"""Show revision number and revision id for a given revision identifier.

553

__doc__ = """Show revision number and revision id for a given revision identifier.

554

"""

555

hidden = True

556

takes_args = ['revision_info*']

612

613

614

class cmd_add(Command):

615

"""Add specified files or directories.

615

__doc__ = """Add specified files or directories.

616

617

In non-recursive mode, all the named items are added, regardless

618

of whether they were previously ignored. A warning is given if

698

699

700

class cmd_mkdir(Command):

701

"""Create a new versioned directory.

701

__doc__ = """Create a new versioned directory.

702

703

This is equivalent to creating the directory and then adding it.

704

"""

720

721

722

class cmd_relpath(Command):

723

"""Show path of a file relative to root"""

723

__doc__ = """Show path of a file relative to root"""

724

725

takes_args = ['filename']

726

hidden = True

735

736

737

class cmd_inventory(Command):

738

"""Show inventory of the current working copy or a revision.

738

__doc__ = """Show inventory of the current working copy or a revision.

739

740

It is possible to limit the output to a particular entry

741

type using the --kind option. For example: --kind file.

796

797

798

class cmd_mv(Command):

799

"""Move or rename a file.

799

__doc__ = """Move or rename a file.

800

801

:Usage:

802

bzr mv OLDNAME NEWNAME

933

934

935

class cmd_pull(Command):

936

"""Turn this branch into a mirror of another branch.

936

__doc__ = """Turn this branch into a mirror of another branch.

937

938

By default, this command only works on branches that have not diverged.

939

Branches are considered diverged if the destination branch's most recent

1060

1061

1062

class cmd_push(Command):

1063

"""Update a mirror of this branch.

1063

__doc__ = """Update a mirror of this branch.

1064

1065

The target branch will not have its working tree populated because this

1066

is both expensive, and is not supported on remote file systems.

1173

1174

1175

class cmd_branch(Command):

1176

"""Create a new branch that is a copy of an existing branch.

1176

__doc__ = """Create a new branch that is a copy of an existing branch.

1177

1178

If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will

1179

be used. In other words, "branch ../foo/bar" will attempt to create ./bar.

1286

1287

1288

class cmd_checkout(Command):

1289

"""Create a new checkout of an existing branch.

1289

__doc__ = """Create a new checkout of an existing branch.

1290

1291

If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for

1292

the branch found in '.'. This is useful if you have removed the working tree

1355

1356

1357

class cmd_renames(Command):

1358

"""Show list of renamed files.

1358

__doc__ = """Show list of renamed files.

1359

"""

1360

# TODO: Option to show renames between two historical versions.

1361

1387

1388

1389

class cmd_update(Command):

1390

"""Update a tree to have the latest code committed to its branch.

1390

__doc__ = """Update a tree to have the latest code committed to its branch.

1391

1392

This will perform a merge into the working tree, and may generate

1393

conflicts. If you have any local changes, you will still

1473

1474

1475

class cmd_info(Command):

1476

"""Show information about a working tree, branch or repository.

1476

__doc__ = """Show information about a working tree, branch or repository.

1477

1478

This command will show all known locations and formats associated to the

1479

tree, branch or repository.

1517

1518

1519

class cmd_remove(Command):

1520

"""Remove files or directories.

1520

__doc__ = """Remove files or directories.

1521

1522

This makes bzr stop tracking changes to the specified files. bzr will delete

1523

them if they can easily be recovered using revert. If no options or

1571

1572

1573

class cmd_file_id(Command):

1574

"""Print file_id of a particular file or directory.

1574

__doc__ = """Print file_id of a particular file or directory.

1575

1576

The file_id is assigned when the file is first added and remains the

1577

same through all revisions where the file exists, even when it is

1593

1594

1595

class cmd_file_path(Command):

1596

"""Print path of file_ids to a file or directory.

1596

__doc__ = """Print path of file_ids to a file or directory.

1597

1598

This prints one line for each directory down to the target,

1599

starting at the branch root.

1615

1616

1617

class cmd_reconcile(Command):

1618

"""Reconcile bzr metadata in a branch.

1618

__doc__ = """Reconcile bzr metadata in a branch.

1619

1620

This can correct data mismatches that may have been caused by

1621

previous ghost operations or bzr upgrades. You should only

1643

1644

1645

class cmd_revision_history(Command):

1646

"""Display the list of revision ids on a branch."""

1646

__doc__ = """Display the list of revision ids on a branch."""

1647

1648

_see_also = ['log']

1649

takes_args = ['location?']

1659

1660

1661

class cmd_ancestry(Command):

1662

"""List all revisions merged into this branch."""

1662

__doc__ = """List all revisions merged into this branch."""

1663

1664

_see_also = ['log', 'revision-history']

1665

takes_args = ['location?']

1684

1685

1686

class cmd_init(Command):

1687

"""Make a directory into a versioned branch.

1687

__doc__ = """Make a directory into a versioned branch.

1688

1689

Use this to create an empty branch, or before importing an

1690

existing project.

1793

1794

1795

class cmd_init_repository(Command):

1796

"""Create a shared repository for branches to share storage space.

1796

__doc__ = """Create a shared repository for branches to share storage space.

1797

1798

New branches created under the repository directory will store their

1799

revisions in the repository, not in the branch directory. For branches

1853

1854

1855

class cmd_diff(Command):

1856

"""Show differences in the working tree, between revisions or branches.

1856

__doc__ = """Show differences in the working tree, between revisions or branches.

1857

1858

If no arguments are given, all changes for the current tree are listed.

1859

If files are given, only the changes in those files are listed.

1994

1995

1996

class cmd_deleted(Command):

1997

"""List files deleted in the working tree.

1997

__doc__ = """List files deleted in the working tree.

1998

"""

1999

# TODO: Show files deleted since a previous revision, or

2000

# between two revisions.

2023

2024

2025

class cmd_modified(Command):

2026

"""List files modified in working tree.

2026

__doc__ = """List files modified in working tree.

2027

"""

2028

2029

hidden = True

2046

2047

2048

class cmd_added(Command):

2049

"""List files added in working tree.

2049

__doc__ = """List files added in working tree.

2050

"""

2051

2052

hidden = True

2082

2083

2084

class cmd_root(Command):

2085

"""Show the tree root directory.

2085

__doc__ = """Show the tree root directory.

2086

2087

The root is the nearest enclosing directory with a .bzr control

2088

directory."""

2112

2113

2114

class cmd_log(Command):

2115

"""Show historical log for a branch or subset of a branch.

2115

__doc__ = """Show historical log for a branch or subset of a branch.

2116

2117

log is bzr's default tool for exploring the history of a branch.

2118

The branch to use is taken from the first parameter. If no parameters

2483

2484

2485

class cmd_touching_revisions(Command):

2486

"""Return revision-ids which affected a particular file.

2486

__doc__ = """Return revision-ids which affected a particular file.

2487

2488

A more user-friendly interface is "bzr log FILE".

2489

"""

2504

2505

2506

class cmd_ls(Command):

2507

"""List files in a tree.

2507

__doc__ = """List files in a tree.

2508

"""

2509

2510

_see_also = ['status', 'cat']

2621

2622

2623

class cmd_unknowns(Command):

2624

"""List unknown files.

2624

__doc__ = """List unknown files.

2625

"""

2626

2627

hidden = True

2634

2635

2636

class cmd_ignore(Command):

2637

"""Ignore specified files or patterns.

2637

__doc__ = """Ignore specified files or patterns.

2638

2639

See ``bzr help patterns`` for details on the syntax of patterns.

2640

2736

2737

2738

class cmd_ignored(Command):

2739

"""List ignored files and the patterns that matched them.

2739

__doc__ = """List ignored files and the patterns that matched them.

2740

2741

List all the ignored files and the ignore pattern that caused the file to

2742

be ignored.

2763

2764

2765

class cmd_lookup_revision(Command):

2766

"""Lookup the revision-id from a revision-number

2766

__doc__ = """Lookup the revision-id from a revision-number

2767

2768

:Examples:

2769

bzr lookup-revision 33

2783

2784

2785

class cmd_export(Command):

2786

"""Export current or past revision to a destination directory or archive.

2786

__doc__ = """Export current or past revision to a destination directory or archive.

2787

2788

If no revision is specified this exports the last committed revision.

2789

2846

2847

2848

class cmd_cat(Command):

2849

"""Write the contents of a file as of a given revision to standard output.

2849

__doc__ = """Write the contents of a file as of a given revision to standard output.

2850

2851

If no revision is nominated, the last revision is used.

2852

2932

2933

2934

class cmd_local_time_offset(Command):

2935

"""Show the offset in seconds from GMT to local time."""

2935

__doc__ = """Show the offset in seconds from GMT to local time."""

2936

hidden = True

2937

@display_command

2938

def run(self):

2941

2942

2943

class cmd_commit(Command):

2944

"""Commit changes into a new revision.

2944

__doc__ = """Commit changes into a new revision.

2945

2946

An explanatory message needs to be given for each commit. This is

2947

often done by using the --message option (getting the message from the

3207

3208

3209

class cmd_check(Command):

3210

"""Validate working tree structure, branch consistency and repository history.

3210

__doc__ = """Validate working tree structure, branch consistency and repository history.

3211

3212

This command checks various invariants about branch and repository storage

3213

to detect data corruption or bzr bugs.

3277

3278

3279

class cmd_upgrade(Command):

3280

"""Upgrade branch storage to current format.

3280

__doc__ = """Upgrade branch storage to current format.

3281

3282

The check command or bzr developers may sometimes advise you to run

3283

this command. When the default format has changed you may also be warned

3301

3302

3303

class cmd_whoami(Command):

3304

"""Show or set bzr user id.

3304

__doc__ = """Show or set bzr user id.

3305

3306

:Examples:

3307

Show the email of the current user::

3351

3352

3353

class cmd_nick(Command):

3354

"""Print or set the branch nickname.

3354

__doc__ = """Print or set the branch nickname.

3355

3356

If unset, the tree root directory name is used as the nickname.

3357

To print the current nickname, execute with no argument.

3375

3376

3377

class cmd_alias(Command):

3378

"""Set/unset and display aliases.

3378

__doc__ = """Set/unset and display aliases.

3379

3380

:Examples:

3381

Show the current aliases::

3445

3446

3447

class cmd_selftest(Command):

3448

"""Run internal test suite.

3448

__doc__ = """Run internal test suite.

3449

3450

If arguments are given, they are regular expressions that say which tests

3451

should run. Tests matching any expression are run, and other tests are

3633

3634

3635

class cmd_version(Command):

3636

"""Show version of bzr."""

3636

__doc__ = """Show version of bzr."""

3637

3638

encoding_type = 'replace'

3639

takes_options = [

3650

3651

3652

class cmd_rocks(Command):

3653

"""Statement of optimism."""

3653

__doc__ = """Statement of optimism."""

3654

3655

hidden = True

3656

3660

3661

3662

class cmd_find_merge_base(Command):

3663

"""Find and print a base revision for merging two branches."""

3663

__doc__ = """Find and print a base revision for merging two branches."""

3664

# TODO: Options to specify revisions on either side, as if

3665

# merging only part of the history.

3666

takes_args = ['branch', 'other']

3686

3687

3688

class cmd_merge(Command):

3689

"""Perform a three-way merge.

3689

__doc__ = """Perform a three-way merge.

3690

3691

The source of the merge can be specified either in the form of a branch,

3692

or in the form of a path to a file containing a merge directive generated

4047

4048

4049

class cmd_remerge(Command):

4050

"""Redo a merge.

4050

__doc__ = """Redo a merge.

4051

4052

Use this if you want to try a different merge technique while resolving

4053

conflicts. Some merge techniques are better than others, and remerge

4142

4143

4144

class cmd_revert(Command):

4145

"""Revert files to a previous revision.

4145

__doc__ = """Revert files to a previous revision.

4146

4147

Giving a list of files will revert only those files. Otherwise, all files

4148

will be reverted. If the revision is not specified with '--revision', the

4214

4215

4216

class cmd_assert_fail(Command):

4217

"""Test reporting of assertion failures"""

4217

__doc__ = """Test reporting of assertion failures"""

4218

# intended just for use in testing

4219

4220

hidden = True

4224

4225

4226

class cmd_help(Command):

4227

"""Show help on a command or other topic.

4227

__doc__ = """Show help on a command or other topic.

4228

"""

4229

4230

_see_also = ['topics']

4243

4244

4245

class cmd_shell_complete(Command):

4246

"""Show appropriate completions for context.

4246

__doc__ = """Show appropriate completions for context.

4247

4248

For a list of all available commands, say 'bzr shell-complete'.

4249

"""

4258

4259

4260

class cmd_missing(Command):

4261

"""Show unmerged/unpulled revisions between two branches.

4261

__doc__ = """Show unmerged/unpulled revisions between two branches.

4262

4263

OTHER_BRANCH may be local or remote.

4264

4431

4432

4433

class cmd_pack(Command):

4434

"""Compress the data within a repository.

4434

__doc__ = """Compress the data within a repository.

4435

4436

This operation compresses the data within a bazaar repository. As

4437

bazaar supports automatic packing of repository, this operation is

4466

4467

4468

class cmd_plugins(Command):

4469

"""List the installed plugins.

4469

__doc__ = """List the installed plugins.

4470

4471

This command displays the list of installed plugins including

4472

version of plugin and a short description of each.

4511

4512

4513

class cmd_testament(Command):

4514

"""Show testament (signing-form) of a revision."""

4514

__doc__ = """Show testament (signing-form) of a revision."""

4515

takes_options = [

4516

'revision',

4517

Option('long', help='Produce long-format testament.'),

4543

4544

4545

class cmd_annotate(Command):

4546

"""Show the origin of each line in a file.

4546

__doc__ = """Show the origin of each line in a file.

4547

4548

This prints out the given file with an annotation on the left side

4549

indicating which revision, author and date introduced the change.

4596

4597

4598

class cmd_re_sign(Command):

4599

"""Create a digital signature for an existing revision."""

4599

__doc__ = """Create a digital signature for an existing revision."""

4600

# TODO be able to replace existing ones.

4601

4602

hidden = True # is this right ?

4662

4663

4664

class cmd_bind(Command):

4665

"""Convert the current branch into a checkout of the supplied branch.

4665

__doc__ = """Convert the current branch into a checkout of the supplied branch.

4666

4667

Once converted into a checkout, commits must succeed on the master branch

4668

before they will be applied to the local branch.

4702

4703

4704

class cmd_unbind(Command):

4705

"""Convert the current checkout into a regular branch.

4705

__doc__ = """Convert the current checkout into a regular branch.

4706

4707

After unbinding, the local branch is considered independent and subsequent

4708

commits will be local only.

4719

4720

4721

class cmd_uncommit(Command):

4722

"""Remove the last committed revision.

4722

__doc__ = """Remove the last committed revision.

4723

4724

--verbose will print out what is being removed.

4725

--dry-run will go through all the motions, but not actually

4827

4828

4829

class cmd_break_lock(Command):

4830

"""Break a dead lock on a repository, branch or working directory.

4830

__doc__ = """Break a dead lock on a repository, branch or working directory.

4831

4832

CAUTION: Locks should only be broken when you are sure that the process

4833

holding the lock has been stopped.

4852

4853

4854

class cmd_wait_until_signalled(Command):

4855

"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.

4855

__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.

4856

4857

This just prints a line to signal when it is ready, then blocks on stdin.

4858

"""

4866

4867

4868

class cmd_serve(Command):

4869

"""Run the bzr server."""

4869

__doc__ = """Run the bzr server."""

4870

4871

aliases = ['server']

4872

4932

4933

4934

class cmd_join(Command):

4935

"""Combine a tree into its containing tree.

4935

__doc__ = """Combine a tree into its containing tree.

4936

4937

This command requires the target tree to be in a rich-root format.

4938

4978

4979

4980

class cmd_split(Command):

4981

"""Split a subdirectory of a tree into a separate tree.

4981

__doc__ = """Split a subdirectory of a tree into a separate tree.

4982

4983

This command will produce a target tree in a format that supports

4984

rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be

5004

5005

5006

class cmd_merge_directive(Command):

5007

"""Generate a merge directive for auto-merge tools.

5007

__doc__ = """Generate a merge directive for auto-merge tools.

5008

5009

A directive requests a merge to be performed, and also provides all the

5010

information necessary to do so. This means it must either include a

5103

5104

5105

class cmd_send(Command):

5106

"""Mail or create a merge-directive for submitting changes.

5106

__doc__ = """Mail or create a merge-directive for submitting changes.

5107

5108

A merge directive provides many things needed for requesting merges:

5109

5220

5221

5222

class cmd_bundle_revisions(cmd_send):

5223

"""Create a merge-directive for submitting changes.

5223

__doc__ = """Create a merge-directive for submitting changes.

5224

5225

A merge directive provides many things needed for requesting merges:

5226

5293

5294

5295

class cmd_tag(Command):

5296

"""Create, remove or modify a tag naming a revision.

5296

__doc__ = """Create, remove or modify a tag naming a revision.

5297

5298

Tags give human-meaningful names to revisions. Commands that take a -r

5299

(--revision) option can be given -rtag:X, where X is any previously

5366

5367

5368

class cmd_tags(Command):

5369

"""List tags.

5369

__doc__ = """List tags.

5370

5371

This command shows a table of tag names and the revisions they reference.

5372

"""

5440

5441

5442

class cmd_reconfigure(Command):

5443

"""Reconfigure the type of a bzr directory.

5443

__doc__ = """Reconfigure the type of a bzr directory.

5444

5445

A target configuration must be specified.

5446

5531

5532

5533

class cmd_switch(Command):

5534

"""Set the branch of a checkout and update.

5534

__doc__ = """Set the branch of a checkout and update.

5535

5536

For lightweight checkouts, this changes the branch being referenced.

5537

For heavyweight checkouts, this checks that there are no local commits

5627

5628

5629

class cmd_view(Command):

5630

"""Manage filtered views.

5630

__doc__ = """Manage filtered views.

5631

5632

Views provide a mask over the tree so that users can focus on

5633

a subset of a tree when doing their work. After creating a view,

5781

5782

5783

class cmd_hooks(Command):

5784

"""Show hooks."""

5784

__doc__ = """Show hooks."""

5785

5786

hidden = True

5787

5801

5802

5803

class cmd_remove_branch(Command):

5804

"""Remove a branch.

5804

__doc__ = """Remove a branch.

5805

5806

This will remove the branch from the specified location but

5807

will keep any working tree or repository in place.

5826

5827

5828

class cmd_shelve(Command):

5829

"""Temporarily set aside some changes from the current tree.

5829

__doc__ = """Temporarily set aside some changes from the current tree.

5830

5831

Shelve allows you to temporarily put changes you've made "on the shelf",

5832

ie. out of the way, until a later time when you can bring them back from

5901

5902

5903

class cmd_unshelve(Command):

5904

"""Restore shelved changes.

5904

__doc__ = """Restore shelved changes.

5905

5906

By default, the most recently shelved changes are restored. However if you

5907

specify a shelf by id those changes will be restored instead. This works

5933

5934

5935

class cmd_clean_tree(Command):

5936

"""Remove unwanted files from working tree.

5936

__doc__ = """Remove unwanted files from working tree.

5937

5938

By default, only unknown files, not ignored files, are deleted. Versioned

5939

files are never deleted.

5967

5968

5969

class cmd_reference(Command):

5970

"""list, view and set branch locations for nested trees.

5970

__doc__ = """list, view and set branch locations for nested trees.

5971

5972

If no arguments are provided, lists the branch locations for nested trees.

5973

If one argument is provided, display the branch location for that tree.