~bzr-pqm/bzr/bzr.dev : revision 5131.2.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

1059

1060

1061

class cmd_push(Command):

1062

"""Update a mirror of this branch.

1062

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

1063

1064

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

1065

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

1183

1184

1185

class cmd_branch(Command):

1186

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

1186

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

1187

1188

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

1189

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

1296

1297

1298

class cmd_checkout(Command):

1299

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

1299

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

1300

1301

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

1302

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

1365

1366

1367

class cmd_renames(Command):

1368

"""Show list of renamed files.

1368

__doc__ = """Show list of renamed files.

1369

"""

1370

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

1371

1397

1398

1399

class cmd_update(Command):

1400

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

1400

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

1401

1402

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

1403

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

1482

1483

1484

class cmd_info(Command):

1485

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

1485

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

1486

1487

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

1488

tree, branch or repository.

1526

1527

1528

class cmd_remove(Command):

1529

"""Remove files or directories.

1529

__doc__ = """Remove files or directories.

1530

1531

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

1532

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

1580

1581

1582

class cmd_file_id(Command):

1583

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

1583

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

1584

1585

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

1586

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

1602

1603

1604

class cmd_file_path(Command):

1605

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

1605

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

1606

1607

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

1608

starting at the branch root.

1624

1625

1626

class cmd_reconcile(Command):

1627

"""Reconcile bzr metadata in a branch.

1627

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

1628

1629

This can correct data mismatches that may have been caused by

1630

previous ghost operations or bzr upgrades. You should only

1652

1653

1654

class cmd_revision_history(Command):

1655

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

1655

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

1656

1657

_see_also = ['log']

1658

takes_args = ['location?']

1668

1669

1670

class cmd_ancestry(Command):

1671

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

1671

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

1672

1673

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

1674

takes_args = ['location?']

1693

1694

1695

class cmd_init(Command):

1696

"""Make a directory into a versioned branch.

1696

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

1697

1698

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

1699

existing project.

1802

1803

1804

class cmd_init_repository(Command):

1805

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

1805

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

1806

1807

New branches created under the repository directory will store their

1808

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

1862

1863

1864

class cmd_diff(Command):

1865

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

1865

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

1866

1867

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

1868

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

1993

1994

1995

class cmd_deleted(Command):

1996

"""List files deleted in the working tree.

1996

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

1997

"""

1998

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

1999

# between two revisions.

2022

2023

2024

class cmd_modified(Command):

2025

"""List files modified in working tree.

2025

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

2026

"""

2027

2028

hidden = True

2045

2046

2047

class cmd_added(Command):

2048

"""List files added in working tree.

2048

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

2049

"""

2050

2051

hidden = True

2081

2082

2083

class cmd_root(Command):

2084

"""Show the tree root directory.

2084

__doc__ = """Show the tree root directory.

2085

2086

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

2087

directory."""

2111

2112

2113

class cmd_log(Command):

2114

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

2114

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

2115

2116

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

2117

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

2482

2483

2484

class cmd_touching_revisions(Command):

2485

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

2485

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

2486

2487

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

2488

"""

2503

2504

2505

class cmd_ls(Command):

2506

"""List files in a tree.

2506

__doc__ = """List files in a tree.

2507

"""

2508

2509

_see_also = ['status', 'cat']

2620

2621

2622

class cmd_unknowns(Command):

2623

"""List unknown files.

2623

__doc__ = """List unknown files.

2624

"""

2625

2626

hidden = True

2633

2634

2635

class cmd_ignore(Command):

2636

"""Ignore specified files or patterns.

2636

__doc__ = """Ignore specified files or patterns.

2637

2638

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

2639

2735

2736

2737

class cmd_ignored(Command):

2738

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

2738

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

2739

2740

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

2741

be ignored.

2762

2763

2764

class cmd_lookup_revision(Command):

2765

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

2765

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

2766

2767

:Examples:

2768

bzr lookup-revision 33

2782

2783

2784

class cmd_export(Command):

2785

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

2785

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

2786

2787

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

2788

2845

2846

2847

class cmd_cat(Command):

2848

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

2848

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

2849

2850

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

2851

2931

2932

2933

class cmd_local_time_offset(Command):

2934

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

2934

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

2935

hidden = True

2936

@display_command

2937

def run(self):

2940

2941

2942

class cmd_commit(Command):

2943

"""Commit changes into a new revision.

2943

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

2944

2945

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

2946

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

3200

3201

3202

class cmd_check(Command):

3203

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

3203

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

3204

3205

This command checks various invariants about branch and repository storage

3206

to detect data corruption or bzr bugs.

3270

3271

3272

class cmd_upgrade(Command):

3273

"""Upgrade branch storage to current format.

3273

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

3274

3275

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

3276

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

3294

3295

3296

class cmd_whoami(Command):

3297

"""Show or set bzr user id.

3297

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

3298

3299

:Examples:

3300

Show the email of the current user::

3344

3345

3346

class cmd_nick(Command):

3347

"""Print or set the branch nickname.

3347

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

3348

3349

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

3350

To print the current nickname, execute with no argument.

3368

3369

3370

class cmd_alias(Command):

3371

"""Set/unset and display aliases.

3371

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

3372

3373

:Examples:

3374

Show the current aliases::

3438

3439

3440

class cmd_selftest(Command):

3441

"""Run internal test suite.

3441

__doc__ = """Run internal test suite.

3442

3443

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

3444

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

3621

3622

3623

class cmd_version(Command):

3624

"""Show version of bzr."""

3624

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

3625

3626

encoding_type = 'replace'

3627

takes_options = [

3638

3639

3640

class cmd_rocks(Command):

3641

"""Statement of optimism."""

3641

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

3642

3643

hidden = True

3644

3648

3649

3650

class cmd_find_merge_base(Command):

3651

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

3651

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

3652

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

3653

# merging only part of the history.

3654

takes_args = ['branch', 'other']

3674

3675

3676

class cmd_merge(Command):

3677

"""Perform a three-way merge.

3677

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

3678

3679

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

3680

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

4035

4036

4037

class cmd_remerge(Command):

4038

"""Redo a merge.

4038

__doc__ = """Redo a merge.

4039

4040

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

4041

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

4130

4131

4132

class cmd_revert(Command):

4133

"""Revert files to a previous revision.

4133

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

4134

4135

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

4136

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

4202

4203

4204

class cmd_assert_fail(Command):

4205

"""Test reporting of assertion failures"""

4205

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

4206

# intended just for use in testing

4207

4208

hidden = True

4212

4213

4214

class cmd_help(Command):

4215

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

4215

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

4216

"""

4217

4218

_see_also = ['topics']

4231

4232

4233

class cmd_shell_complete(Command):

4234

"""Show appropriate completions for context.

4234

__doc__ = """Show appropriate completions for context.

4235

4236

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

4237

"""

4246

4247

4248

class cmd_missing(Command):

4249

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

4249

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

4250

4251

OTHER_BRANCH may be local or remote.

4252

4417

4418

4419

class cmd_pack(Command):

4420

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

4420

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

4421

4422

_see_also = ['repositories']

4423

takes_args = ['branch_or_repo?']

4433

4434

4435

class cmd_plugins(Command):

4436

"""List the installed plugins.

4436

__doc__ = """List the installed plugins.

4437

4438

This command displays the list of installed plugins including

4439

version of plugin and a short description of each.

4478

4479

4480

class cmd_testament(Command):

4481

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

4481

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

4482

takes_options = [

4483

'revision',

4484

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

4510

4511

4512

class cmd_annotate(Command):

4513

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

4513

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

4514

4515

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

4516

indicating which revision, author and date introduced the change.

4563

4564

4565

class cmd_re_sign(Command):

4566

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

4566

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

4567

# TODO be able to replace existing ones.

4568

4569

hidden = True # is this right ?

4629

4630

4631

class cmd_bind(Command):

4632

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

4632

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

4633

4634

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

4635

before they will be applied to the local branch.

4669

4670

4671

class cmd_unbind(Command):

4672

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

4672

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

4673

4674

After unbinding, the local branch is considered independent and subsequent

4675

commits will be local only.

4686

4687

4688

class cmd_uncommit(Command):

4689

"""Remove the last committed revision.

4689

__doc__ = """Remove the last committed revision.

4690

4691

--verbose will print out what is being removed.

4692

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

4794

4795

4796

class cmd_break_lock(Command):

4797

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

4797

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

4798

4799

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

4800

holding the lock has been stopped.

4819

4820

4821

class cmd_wait_until_signalled(Command):

4822

"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.

4822

__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.

4823

4824

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

4825

"""

4833

4834

4835

class cmd_serve(Command):

4836

"""Run the bzr server."""

4836

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

4837

4838

aliases = ['server']

4839

4899

4900

4901

class cmd_join(Command):

4902

"""Combine a tree into its containing tree.

4902

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

4903

4904

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

4905

4945

4946

4947

class cmd_split(Command):

4948

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

4948

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

4949

4950

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

4951

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

4971

4972

4973

class cmd_merge_directive(Command):

4974

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

4974

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

4975

4976

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

4977

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

5070

5071

5072

class cmd_send(Command):

5073

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

5073

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

5074

5075

A merge directive provides many things needed for requesting merges:

5076

5187

5188

5189

class cmd_bundle_revisions(cmd_send):

5190

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

5190

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

5191

5192

A merge directive provides many things needed for requesting merges:

5193

5260

5261

5262

class cmd_tag(Command):

5263

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

5263

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

5264

5265

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

5266

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

5333

5334

5335

class cmd_tags(Command):

5336

"""List tags.

5336

__doc__ = """List tags.

5337

5338

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

5339

"""

5407

5408

5409

class cmd_reconfigure(Command):

5410

"""Reconfigure the type of a bzr directory.

5410

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

5411

5412

A target configuration must be specified.

5413

5498

5499

5500

class cmd_switch(Command):

5501

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

5501

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

5502

5503

For lightweight checkouts, this changes the branch being referenced.

5504

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

5594

5595

5596

class cmd_view(Command):

5597

"""Manage filtered views.

5597

__doc__ = """Manage filtered views.

5598

5599

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

5600

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

5748

5749

5750

class cmd_hooks(Command):

5751

"""Show hooks."""

5751

__doc__ = """Show hooks."""

5752

5753

hidden = True

5754

5768

5769

5770

class cmd_remove_branch(Command):

5771

"""Remove a branch.

5771

__doc__ = """Remove a branch.

5772

5773

This will remove the branch from the specified location but

5774

will keep any working tree or repository in place.

5793

5794

5795

class cmd_shelve(Command):

5796

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

5796

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

5797

5798

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

5799

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

5868

5869

5870

class cmd_unshelve(Command):

5871

"""Restore shelved changes.

5871

__doc__ = """Restore shelved changes.

5872

5873

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

5874

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

5900

5901

5902

class cmd_clean_tree(Command):

5903

"""Remove unwanted files from working tree.

5903

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

5904

5905

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

5906

files are never deleted.

5934

5935

5936

class cmd_reference(Command):

5937

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

5937

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

5938

5939

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

5940

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