Rev 67: Merge the updated bzr-colo docs from nmb in http://bazaar.launchpad.net/%2Bbranch/bzr-alldocs
John Arbash Meinel
john at arbash-meinel.com
Thu May 12 07:29:33 UTC 2011
At http://bazaar.launchpad.net/%2Bbranch/bzr-alldocs
------------------------------------------------------------
revno: 67 [merge]
revision-id: john at arbash-meinel.com-20110512072914-e9avqvxawy58a5k7
parent: v.ladeuil+lp at free.fr-20110311085007-uhd6jht96tnykvfu
parent: nmb at wartburg.edu-20110501035259-5qtnc45aia8udukj
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: bzr-alldocs
timestamp: Thu 2011-05-12 09:29:14 +0200
message:
Merge the updated bzr-colo docs from nmb
modified:
plugins-registry.ini pluginsregistry.ini-20091210123635-v9bnb2h129ckb0ie-1
plugins/en/colo-plugin.txt coloplugin.txt-20100111020552-h32nzq8nijghzth2-1
-------------- next part --------------
=== modified file 'plugins-registry.ini'
--- a/plugins-registry.ini 2011-03-11 08:44:01 +0000
+++ b/plugins-registry.ini 2011-05-01 03:52:59 +0000
@@ -146,6 +146,8 @@
purpose = Work with colocated branches using current technology
link.branch = lp:bzr-colo
owner = nmb
+platform.windows = True
+platform.gnulinux = True
platform.mac-osx = True
[plugin colocated]
=== modified file 'plugins/en/colo-plugin.txt'
--- a/plugins/en/colo-plugin.txt 2010-01-11 02:42:12 +0000
+++ b/plugins/en/colo-plugin.txt 2011-05-01 03:52:59 +0000
@@ -2,12 +2,12 @@
================================================================
================ ============================================================
-Version 0.0.1
+Version 0.2.1
Branch `lp:bzr-colo <https://code.launchpad.net/bzr-colo>`_
Home page `<https://launchpad.net/bzr-colo>`_
Owner `nmb <https://launchpad.net/~nmb>`_
-GNU/Linux Maybe (please test)
-Windows Maybe (please test)
+GNU/Linux Yes
+Windows Yes
Mac OS X Yes
================ ============================================================
@@ -27,11 +27,18 @@
* colo-init
* colo-branch
* colo-branches
+ * qbranches (if the qbzr plugin is installed)
* colo-fetch
- * colo-clone
+ * colo-pull
+ * colo-checkout
* colo-prune
+ * qprune (if the qbzr plugin is installed)
+ * colo-mv
* colo-clean
* colo-ify
+ * colo-fixup
+ * colo-sync-from
+ * colo-sync-to
For more information on working with this plugin, see ``bzr help
colo-tutorial`` and the help for the individual commands.
@@ -39,14 +46,16 @@
Referring to Colocated Branches
-------------------------------
-This plugin adds a directory service of "colo:" that can be used to
-refer to branches inside of the ``.bzr/branches`` directory. So, for example
-we could ``bzr switch colo:fix-eol-bug`` to do work in the colocated
-``fix-eol-bug`` branch. Note that in some cases, the "colo:" prefix is
-unnecessary because Bazaar automatically looks for branches in the directory
-where the current branch is located. So the previous command would also work
-with ``bzr switch fix-eol-bug`` because switch searches sibling directories
-automatically.
+This plugin adds a directory service of "colo:" that can be used to refer to
+branches inside of the ``.bzr/branches`` directory. So, for example we could
+``bzr switch colo:fix-eol-bug`` to do work in the colocated ``fix-eol-bug``
+branch. Note that in some cases, the "colo:" prefix is unnecessary because
+Bazaar automatically looks for branches in the directory where the current
+branch is located. So the previous command would also work with ``bzr switch
+fix-eol-bug`` because switch searches sibling directories automatically. (If
+hierarchical branch names such as ``bugs/1024`` are used, then simply doing
+``bzr switch trunk`` may fail, while ``bzr switch colo:trunk`` will always
+work.)
From within a colocated workspace, the specifier ``colo:branch_name`` refers
to the branch with that name in the current colocated workspace. It is
@@ -115,6 +124,39 @@
If the current directory is a working tree pointing to one of the branches,
that branch is marked with a "*".
+colo-checkout
+-------------
+
+**Purpose**
+
+Create a checkout of this branch in a new directory.
+
+**Usage**
+
+bzr colo-checkout TO_DIRECTORY
+
+**Options**
+
+
+-v, --verbose Display more information.
+-b, --create Also create a new colocated branch by this name
+-q, --quiet Only display errors and warnings.
+--from-branch=ARG name of the branch to branch from
+--usage Show usage message and options.
+-h, --help Show help message.
+
+
+**Description**
+
+By default this command makes a new checkout of the current branch in
+the specified directory. Using the ``--create`` option, a new branch
+named after the last component of the new directory is created, and
+the new checkout is switched to that new branch.
+
+**Aliases**
+
+colo-co
+
colo-clean
----------
@@ -142,34 +184,6 @@
``colo-prune`` command to remove revisions that were only present in
the branch that was pruned.
-colo-clone
-----------
-
-**Purpose**
-
-Create a checkout of this branch in a new directory.
-
-**Usage**
-
-bzr colo-clone TO_DIRECTORY
-
-**Options**
-
-
---usage Show usage message and options.
---create Also create a new colocated branch by this name
--v, --verbose Display more information.
--q, --quiet Only display errors and warnings.
--h, --help Show help message.
-
-
-**Description**
-
-By default this command makes a new checkout of the current branch in
-the specified directory. Using the ``--create`` option, a new branch
-named after the last component of the new directory is created, and
-the new checkout is switched to that new branch.
-
colo-fetch
----------
@@ -184,7 +198,8 @@
**Options**
---trunk-name=ARG Name of the branch to create; default is "trunk"
+--trunk-name=ARG Name of the branch to create; default is
+ "origin/trunk"
-v, --verbose Display more information.
--create-prefix Create the path leading up to the location if it does
not already exist.
@@ -198,68 +213,58 @@
--1.14 A working-tree format that supports content filtering.
--1.14-rich-root A variant of 1.14 that supports rich-root data (needed
for bzr-svn and bzr-git).
- --1.6 A format that allows a branch to indicate that there
- is another (stacked) repository that should be used to
- access data that is not present locally.
- --1.6.1-rich-root A variant of 1.6 that supports rich-root data (needed
- for bzr-svn and bzr-git).
- --1.9 A repository format using B+tree indexes. These
- indexes are smaller in size, have smarter caching and
- provide faster performance for most operations.
- --1.9-rich-root A variant of 1.9 that supports rich-root data (needed
- for bzr-svn and bzr-git).
--2a First format for bzr 2.0 series. Uses group-compress
storage. Provides rich roots which are a one-way
transition.
--default First format for bzr 2.0 series. Uses group-compress
storage. Provides rich roots which are a one-way
transition.
- --default-rich-root
- Same as 2a.
- --development-rich-root
- Current development format. Supports rich roots. Can
- convert data to and from rich-root-pack (and anything
- compatible with rich-root-pack) format repositories.
- Repositories and branches in this format can only be
- read by bzr.dev. Please read http://doc.bazaar-
- vcs.org/latest/developers/development-repo.html before
- use.
- --development-subtree
- Current development format, subtree variant. Can
- convert data to and from pack-0.92-subtree (and
- anything compatible with pack-0.92-subtree) format
- repositories. Repositories and branches in this format
- can only be read by bzr.dev. Please read http://doc
- .bazaar-vcs.org/latest/developers/development-
- repo.html before use.
- --dirstate New in 0.15: Fast local operations. Compatible with
- bzr 0.8 and above when accessed over the network.
- --dirstate-tags New in 0.15: Fast local operations and improved
- scaling for network operations. Additionally adds
- support for tags. Incompatible with bzr < 0.15.
- --knit Format using knits. Recommended for interoperation
- with bzr <= 0.14.
- --metaweave Transitional format in 0.8. Slower than knit.
+ --git GIT repository.
+ --git-bare Bare GIT repository (no working tree).
+ --hg Mercurial repository.
--pack-0.92 New in 0.92: Pack-based format with data compatible
with dirstate-tags format repositories. Interoperates
with bzr repositories before 0.92 but cannot be read
- by bzr < 0.92. Previously called knitpack-
- experimental. For more information, see http://doc
- .bazaar-vcs.org/latest/developers/packrepo.html.
- --rich-root New in 1.0. Better handling of tree roots.
- Incompatible with bzr < 1.0.
- --rich-root-pack New in 1.0: A variant of pack-0.92 that supports rich-
- root data (needed for bzr-svn and bzr-git).
- --weave Pre-0.8 format. Slower than knit and does not support
- checkouts or shared repositories.
-
-
-**Description**
-
-This creates a colocated workspace at the specified location (the default
-is the current directory) with a single branch named "trunk" that has
-the contents of the external project. If you would like to specify a
-different name for the new branch, use the ``--trunk-name`` option.
+ by bzr < 0.92.
+
+
+**Description**
+
+This creates a colocated workspace at the specified location with a single
+branch named "origin/trunk" that has the contents of the external project.
+If you would like to specify a different name for the new branch, use the
+``--trunk-name`` option. If you don't specify a TO_LOCATION, then one
+will be derived from the final component of the FROM_LOCATION (similar
+to ``bzr branch``.
+
+colo-fixup
+----------
+
+**Purpose**
+
+Fix the checkout reference after moving a colocated workspace.
+
+**Usage**
+
+bzr colo-fixup
+
+**Options**
+
+
+--usage Show usage message and options.
+-v, --verbose Display more information.
+-q, --quiet Only display errors and warnings.
+-h, --help Show help message.
+
+
+**Description**
+
+Because Bazaar uses absolute pathnames in storing references to branches,
+when a colocated workspace is moved on disk, the link from the
+checkout to the current branch gets broken. This command uses a simple
+heuristic to try to fix that reference. If it doesn't work, then the
+command ``bzr switch --force .bzr/branches/<current branch name>`` will
+always work.
colo-ify
--------
@@ -308,11 +313,13 @@
**Options**
+--trunk-name=ARG Name for the trunk branch
-v, --verbose Display more information.
--create-prefix Create the path leading up to the location if it does
not already exist.
-q, --quiet Only display errors and warnings.
--usage Show usage message and options.
+--no-tree Create a workspace without a working tree
-h, --help Show help message.
Storage Format:
@@ -321,60 +328,19 @@
--1.14 A working-tree format that supports content filtering.
--1.14-rich-root A variant of 1.14 that supports rich-root data (needed
for bzr-svn and bzr-git).
- --1.6 A format that allows a branch to indicate that there
- is another (stacked) repository that should be used to
- access data that is not present locally.
- --1.6.1-rich-root A variant of 1.6 that supports rich-root data (needed
- for bzr-svn and bzr-git).
- --1.9 A repository format using B+tree indexes. These
- indexes are smaller in size, have smarter caching and
- provide faster performance for most operations.
- --1.9-rich-root A variant of 1.9 that supports rich-root data (needed
- for bzr-svn and bzr-git).
--2a First format for bzr 2.0 series. Uses group-compress
storage. Provides rich roots which are a one-way
transition.
--default First format for bzr 2.0 series. Uses group-compress
storage. Provides rich roots which are a one-way
transition.
- --default-rich-root
- Same as 2a.
- --development-rich-root
- Current development format. Supports rich roots. Can
- convert data to and from rich-root-pack (and anything
- compatible with rich-root-pack) format repositories.
- Repositories and branches in this format can only be
- read by bzr.dev. Please read http://doc.bazaar-
- vcs.org/latest/developers/development-repo.html before
- use.
- --development-subtree
- Current development format, subtree variant. Can
- convert data to and from pack-0.92-subtree (and
- anything compatible with pack-0.92-subtree) format
- repositories. Repositories and branches in this format
- can only be read by bzr.dev. Please read http://doc
- .bazaar-vcs.org/latest/developers/development-
- repo.html before use.
- --dirstate New in 0.15: Fast local operations. Compatible with
- bzr 0.8 and above when accessed over the network.
- --dirstate-tags New in 0.15: Fast local operations and improved
- scaling for network operations. Additionally adds
- support for tags. Incompatible with bzr < 0.15.
- --knit Format using knits. Recommended for interoperation
- with bzr <= 0.14.
- --metaweave Transitional format in 0.8. Slower than knit.
+ --git GIT repository.
+ --git-bare Bare GIT repository (no working tree).
+ --hg Mercurial repository.
--pack-0.92 New in 0.92: Pack-based format with data compatible
with dirstate-tags format repositories. Interoperates
with bzr repositories before 0.92 but cannot be read
- by bzr < 0.92. Previously called knitpack-
- experimental. For more information, see http://doc
- .bazaar-vcs.org/latest/developers/packrepo.html.
- --rich-root New in 1.0. Better handling of tree roots.
- Incompatible with bzr < 1.0.
- --rich-root-pack New in 1.0: A variant of pack-0.92 that supports rich-
- root data (needed for bzr-svn and bzr-git).
- --weave Pre-0.8 format. Slower than knit and does not support
- checkouts or shared repositories.
+ by bzr < 0.92.
**Description**
@@ -384,6 +350,35 @@
.bzr/branches subdirectory. They may be easily referred to using the
colo: specifier.
+By default, the initial branch is called "trunk". A different name can
+be specified with the --trunk-name option. For creating colocated
+workspaces remotely, a --no-tree options is available for situations
+where it isn't possible or desired to create a working tree.
+
+colo-mv
+-------
+
+**Purpose**
+
+Rename a colocated branch.
+
+**Usage**
+
+bzr colo-mv OLDNAME NEWNAME
+
+**Options**
+
+
+--usage Show usage message and options.
+-v, --verbose Display more information.
+-q, --quiet Only display errors and warnings.
+-h, --help Show help message.
+
+
+**Aliases**
+
+colo-move, colo-rename
+
colo-prune
----------
@@ -413,7 +408,158 @@
revisions that are only present in the removed branches, then the
``--clean`` option may be given.
+**Aliases**
+
+colo-delete
+
**See also**
colo-clean
+colo-pull
+---------
+
+**Purpose**
+
+Update all remote branches.
+
+**Usage**
+
+bzr colo-pull
+
+**Options**
+
+
+--usage Show usage message and options.
+-d ARG, --directory=ARG
+ colocated workspace to use
+-v, --verbose Display more information.
+-q, --quiet Only display errors and warnings.
+-h, --help Show help message.
+
+
+**Description**
+
+A remote branch is one whose name starts with "origin/". This command
+updates all such branches by doing a pull from their default pull
+location. To set this location, do ``bzr switch colo:origin/branch_name``
+and ``bzr pull --remember URL``.
+
+colo-sync-from
+--------------
+
+**Purpose**
+
+Synchronize this colocated workspace from the state of another one.
+
+**Usage**
+
+bzr colo-sync-from [LOCATION]
+
+**Options**
+
+
+--remember Remember the specified location as a default.
+-h, --help Show help message.
+-q, --quiet Only display errors and warnings.
+--usage Show usage message and options.
+--overwrite Ignore differences between branches and overwrite
+ unconditionally
+-v, --verbose Display more information.
+
+
+**Description**
+
+LOCATION should be a path or URL to a colocated workspace such that the
+branches it holds are accessible as colo:LOCATION:branch_name. For every
+branch in that remote workspace, if there is a local branch with the same
+name, the remote branch is pulled into the corresponding local branch.
+If there is not a local branch with a name, then a new branch is created
+in the local colocated workspace.
+
+The first time colo-sync-from is used, it records a default location so
+that future synchronizations can just use "bzr colo-sync-from". To change
+the saved synchronization location, use the "--remember" option.
+
+colo-sync-to
+------------
+
+**Purpose**
+
+Synchronize this colocated workspace to another one.
+
+**Usage**
+
+bzr colo-sync-to [LOCATION]
+
+**Options**
+
+
+--remember Remember the specified location as a default.
+-h, --help Show help message.
+-q, --quiet Only display errors and warnings.
+--usage Show usage message and options.
+--overwrite Ignore differences between branches and overwrite
+ unconditionally.
+-v, --verbose Display more information.
+
+
+**Description**
+
+LOCATION should be a path or URL for a colocated workspace. The branches
+in the current workspace are pushed to the specified remote workspace.
+If that path does not already contain matching branches, they will be
+created.
+
+The first time colo-sync-to is used, it records a default location so
+that future synchronizations can just use "bzr colo-sync-to". To change
+the saved synchronization location, use the "--remember" option.
+
+qbranches
+---------
+
+**Purpose**
+
+List colocated branches.
+
+**Usage**
+
+bzr qbranches
+
+**Options**
+
+
+--usage Show usage message and options.
+-d ARG, --directory=ARG
+ location of colocated workspace
+-v, --verbose Display more information.
+-q, --quiet Only display errors and warnings.
+-h, --help Show help message.
+
+
+**Description**
+
+The current branch is marked in bold.
+
+qprune
+------
+
+**Purpose**
+
+Remove colocated branches.
+
+**Usage**
+
+bzr qprune
+
+**Options**
+
+
+--usage Show usage message and options.
+-d ARG, --directory=ARG
+ location of colocated workspace
+-v, --verbose Display more information.
+-q, --quiet Only display errors and warnings.
+-h, --help Show help message.
+
+
More information about the bazaar-commits
mailing list