Bzr - Revision history

Psmay: /* Branching */

2014-10-03T13:27:53Z

Branching

Psmay: /* Branching */

2014-08-26T13:28:47Z

Branching

Psmay: /* See */

2014-08-25T20:32:11Z

See

Psmay: /* Branching */

2014-08-18T14:32:13Z

Branching

Psmay: /* Using bzr with github */

2014-08-18T14:21:42Z

Using bzr with github

Psmay: /* The URL */

2014-08-18T13:55:02Z

The URL

Psmay: /* Caveats */

2014-08-18T13:48:35Z

Caveats

Psmay: /* Install bzr-git */

2014-05-08T01:06:54Z

Install bzr-git

Psmay: /* Install bzr-git */

2014-05-07T18:40:12Z

Install bzr-git

Psmay: /* Cheatsheet */

2014-05-07T18:19:19Z

Cheatsheet

New page

{{unix}}
'''Bazaar''' (invoked using the shell command '''bzr''') is a distributed version control system "sponsored by Canonical Ltd., designed to make it easier for anyone to contribute to free and open source software projects."[http://en.wikipedia.org/wiki/Bazaar_(software)].

==Cheatsheet==

===Help!===

bzr help commandname

===Initialization===

====init====

To create a completely new, empty project dir "foo":

bzr init foo

If the directory "foo" contains a project already and just needs versioning added:

cd foo
bzr init
bzr add .

====checkout====

To check out a "checkout"/working tree (bzr terminology for a working copy) of an existing branch:

# co = checkout
bzr co fooFrom [fooTo]

If there is no fooTo, the last fragment of fooFrom is used.

====branch====

To start an entirely new branch copied from an existing branch:

# branch = get = clone
bzr branch fooFrom [fooTo]

The arguments are basically identical to those for checkout.

Unlike checkout, this is intended to create an extended history that forks from the original.

===Examination===

====status====

Version status of files:

bzr status

====log====

Revision log:

bzr log [files...]

====diff====

Compare current to last committed:

bzr diff [files...]

Compare a file between revisions 1 and 3:

bzr diff -r1..3 [files...]

====info====

Branch information:

bzr info

====cat====

Get the contents of a file (optionally from revision 3):

bzr cat [-r3] file > foo-file.out

===Version ops===

====add====

Add files to set of versioned files:

bzr add [--dry-run] [--no-recurse] [files...]

Any directories are traversed unless --no-recurse. --dry-run will list what would be added without doing the adding. If no files are given, . (current dir) is assumed.

====rm====

Remove files from set of versioned files:

# rm = remove = del
bzr rm [--keep | --force] [files...]

By default bzr will delete the files iff they can be recovered trivially with revert. --keep removes the file from versioning but leaves the working copy. --force removes the file from versioning and the working copy even if it is nontrivial to recover.

====ci====

Check a revision of files into the repository:

# ci = commit = checkin
bzr ci [files...] [-m message]

If files is omitted, the entire tree is used. If -m is omitted, your default editor is used to record the revision message.

====uncommit====

If the last commit was a mistake (and optionally the last non-mistake was revision 3):

bzr uncommit [location] [-r3]

====revert====

To revert files to the last committed revision (or optionally to revision 3):

bzr revert [files...] [-r3]

Files edited manually are backed up with a tail first.

===Merging===

====merge====

Merging works by attempting to apply changes that were made to another branch to the current working tree.

bzr merge ../foo.dev.branch

====pull====

To copy changes from another (non-divergent) branch, making this a mirror of that:

bzr pull fooFrom

====up====

To merge back the most recently committed code to this working copy:

# up = update
bzr up

====resolve====

Merges, updates, and so forth result in marked conflicts. After conflicts are resolved manually:

bzr resolve [files...]

If no files are given, bzr will try to automatically figure out what has been resolved. It may or may not succeed.

===Publishing===

====push====

To copy changes from this working tree to another (non-divergent) branch:

bzr push fooTo

====send====

To e-mail (or optionally just create) a merge directive (an archive that contains a series of revision changes):

bzr send [-o ../foo-updates.patch]

====export====

Exporting produces a snapshot of the
To export the current revision (or optionally revision 3) to another file or directory:

bzr export [-r3] ../fooOut [branch|subdir]

If fooOut has an extension like .tar, .tar.bz2, or .zip, the destination will be an archive file of the suggested type. Otherwise, the destination will be a directory. (Use the --format option to override.)

==Install a plugin==

[http://doc.bazaar.canonical.com/plugins/en/plugin-installation.html As described elsewhere], the general rule is to find the thing on Launchpad and branch it into your local plugins, stripping the bzr- prefix and substituting _ for -.

===In general===

cd ~/.bazaar/plugins &&
bzr branch lp:bzr-example-plug example_plug

===Install bzr-git===

cd ~/.bazaar/plugins &&
bzr branch lp:bzr-git git

But note that dulwich must also be installed.

==Using bzr with github==

Feel like you're missing out on the whole forking social development thing? Like markdown a whole lot and frustrated that Launchpad doesn't use it? Here's how to share code with a zillion of your friends without converting them.

Before proceeding, ensure that you're up on your SSH keys/credentials for github.

===Caveats===

No submodules yet. You'll have to learn git for that.

===The URL===

Get the SSH version of the desired repo. It looks like this:

git@github.com:''someuser''/''somerepo''.git

You'll change these things to get the bzr-compatible URL:

* Change the <code>:</code> to a <code>/</code>
* Add the prefix <code>git+ssh://</code>
* Add the desired git branch by using the suffix <code>,branch=''master''</code>
** Replace ''master'' with the desired branch name.

The result is

git+ssh://git@github.com/''someuser''/''somerepo''.git,branch=''master''

===Exists on local, new on github===

If the bzr branch you want to use already exists locally, [https://github.com/new create the new repo on github] and be sure '''"Initialize this repository with a README" is unchecked.''' If it doesn't exist locally and you create the repo on github with a README, follow the [[#Exists_on_github]] advice instead.

From the root of the local bzr branch, do:

bzr dpush --remember ''URL''

using <code>master</code> as the branch name.

If this worked, your content has been pushed.

===Branch===

Do

bzr branch ''URL'' ''somerepo''

If the ''somerepo'' parameter is omitted, the name of the destination is the name of the git branch.

===Pushing===

Use <code>dpush</code> where you'd normally use <code>push</code>. This indicates that the push targets a non-bzr repo.

===Creating new github branches===

If the branch doesn't exist on github yet, and you'd like to create it, theoretically <code>dpush</code> should work, but on my system it just hangs.

Here's how to do it with <code>git</code> itself.

First, get a light local git repo and set the origin. The URL is the same except the <code>,branch=...</code> part is omitted.

mkdir somerepo
cd somerepo
git init
git remote add origin ''URL-without-branch''

Then, simply pull the branch of origin and push it back up with a new name.

OLDBRANCH=''oldbranch'' && git pull origin "$OLDBRANCH" && git checkout "$OLDBRANCH"
NEWBRANCH=''newbranch'' && git checkout -b "$NEWBRANCH" && git push -u origin "$NEWBRANCH"

It might be worth making a script out of that.

If the same needs to be done more than once, only the part starting with the pull needs to be repeated.

==See==

* [http://doc.bazaar.canonical.com/en/ Bazaar docs]
* [http://bazaar.canonical.com/en/ Bazaar project]

@@ Line 280: / Line 280: @@
 export TEMP=$HOME/tmp
 export PARENT=$HOME/prj
 export BRANCH=master
 export GHUSER=someuser
@@ Line 301: / Line 302: @@
 # Use <code>bzr branch</code> to create a branch ($LOCALBZR) of the temporary local git repo.
 # Use <code>bzr pull --remember</code> to update the bzr branch's configured parent (<code>$GHURL,branch=$BRANCH</code>). (This also does a no-op pull. It's less complicated and error-prone than doing some sort of stream edit on branch.conf.)
 ==Weird database version conflict problem==

@@ Line 277: / Line 277: @@
 This has historically worked for me without hanging, but today I'm having difficulties. Here's how to work around it with git.
-Go to a temporary directory and clone the git repository. Make sure to include the <code>--branch</code> parameter to get the correct branch.
+<syntaxhighlight lang=bash>
- cd $TEMP
+export GHURL="git@github.com:$GHUSER/$GHREPO.git"
- git clone --branch ''branch-name'' git@github.com:''someuser''/''somerepo''.git
+export LOCALGIT="$TEMP/$GHREPO"
- # The clone is at $TEMP/''somerepo''
+export LOCALBZR="$PARENT/$GHREPO"
-Then, go to where you want the project directory to appear and branch from the clone with bzr.
+git clone --branch "$BRANCH" "$GHURL" "$LOCALGIT" &&
- cd $PROJECTS
+This script does a sequence of three things:
-Finally, go to the bzr branch and do <code>bzr pull --remember</code> to overwrite the parent URL. This doesn't hang (probably because there are no updates to pull).
+# Use <code>git clone</code> to clone a branch ($BRANCH) of a Github repo ($GHURL) to a temporary local git repo ($LOCALGIT).
+# Use <code>bzr branch</code> to create a branch ($LOCALBZR) of the temporary local git repo.
- cd ''branch-dir-name''
+# Use <code>bzr pull --remember</code> to update the bzr branch's configured parent (<code>$GHURL,branch=$BRANCH</code>). (This also does a no-op pull. It's less complicated and error-prone than doing some sort of stream edit on branch.conf.)
 ==Weird database version conflict problem==

@@ Line 297: / Line 297: @@
   cd ''branch-dir-name''
   bzr pull --remember git@github.com:''someuser''/''somerepo''.git,branch=''branch-name''
 ==See==

@@ Line 293: / Line 293: @@
   # The bzr branch is now at $PROJECTS/''branch-dir-name''
-Finally, go to the bzr branch and do <code>bzr pull --remember</code> to overwrite the parent URL.
+Finally, go to the bzr branch and do <code>bzr pull --remember</code> to overwrite the parent URL. This doesn't hang (probably because there are no updates to pull).
   cd ''branch-dir-name''

@@ Line 212: / Line 212: @@
 ====Hangs====
-It seems as though Github works differently enough from normal git that some (or all) bzr-git commands do most of their job, then hang (for about 10 minutes, I estimate) before successfully completing.
+See [[#When Github gets sticky]].
 ====Submodules====
@@ Line 263: / Line 259: @@
 Use <code>dpush</code> where you'd normally use <code>push</code>. This indicates that the push targets a non-bzr repo.
-===Creating new github branches===
+===Pushing a new branch===
-If the branch doesn't exist on github yet, and you'd like to create it, theoretically <code>dpush</code> should work, but on my system it just hangs.
+====Branching====
-Here's how to do it with <code>git</code> itself.
+This has historically worked for me without hanging, but today I'm having difficulties. Here's how to work around it with git.
-First, get a light local git repo and set the origin. The URL is the same except the <code>,branch=...</code> part is omitted.
+Go to a temporary directory and clone the git repository. Make sure to include the <code>--branch</code> parameter to get the correct branch.
-  mkdir somerepo
+  cd $TEMP
-  cd somerepo
+  git clone --branch ''branch-name'' git@github.com:''someuser''/''somerepo''.git
- git init
+  # The clone is at $TEMP/''somerepo''
-Then, simply pull the branch of origin and push it back up with a new name.
+Then, go to where you want the project directory to appear and branch from the clone with bzr.
-  OLDBRANCH=''oldbranch'' && git pull origin "$OLDBRANCH" && git checkout "$OLDBRANCH"
+  cd $PROJECTS
-  NEWBRANCH=''newbranch'' && git checkout -b "$NEWBRANCH" && git push -u origin "$NEWBRANCH"
-It might be worth making a script out of that.
+Finally, go to the bzr branch and do <code>bzr pull --remember</code> to overwrite the parent URL.
-If the same needs to be done more than once, only the part starting with the pull needs to be repeated.
+ cd ''branch-dir-name''
 ==See==

@@ Line 224: / Line 224: @@
 ===The URL===
-Get the SSH version of the desired repo. It looks like this:
+Previously, a more detailed translation of the repo URL was needed, but the current version of bzr-git allows almost the same format as git itself.
   git@github.com:''someuser''/''somerepo''.git
-You'll change these things to get the bzr-compatible URL:
+You need to add a branch qualifier to the end (unlike in git, in bzr a working copy corresponds to exactly one branch). Suffix the URL with <code>,branch=''master''</code>, replacing ''master'' with the desired branch name.
-* Change the <code>:</code> to a <code>/</code>
+ git@github.com:''someuser''/''somerepo''.git,branch=''master''
-The result is
+Internally, this URL is normalized to bzr's own form, which resembles the following:
   git+ssh://git@github.com/''someuser''/''somerepo''.git,branch=''master''

← Older revision		Revision as of 13:48, 18 August 2014
Line 209:		Line 209:

	===Caveats===		===Caveats===
		+
		+	====Hangs====
		+
		+	It seems as though Github works differently enough from normal git that some (or all) bzr-git commands do most of their job, then hang (for about 10 minutes, I estimate) before successfully completing.
		+
		+	If it's a dpush, in my experience you can get away with getting it up to the hanging point and then terminating the process. Use the website to ensure that the changes were uploaded correctly.
		+
		+	For an initial pull or branch, you might just be stuck waiting. One workaround is to do the actual branching with git, use bzr to branch from the result of that, and then overwrite the parent location with the Github address. (See below.)
		+
		+	====Submodules====

	No submodules yet. You'll have to learn git for that.		No submodules yet. You'll have to learn git for that.

@@ Line 184: / Line 184: @@
 ===Install bzr-git===
- cd ~/.bazaar/plugins &&
+<syntaxhighlight lang=bash>
- bzr branch lp:bzr-git git
+cd ~/.bazaar/plugins &&
 But note that dulwich must also be installed.
- # If you don't have easy_install or pip yet, this installs easy_install to a user-local path
+<syntaxhighlight lang=bash>
- # In the case of my cygwin, it was ~/.local/bin/easy_install
+# If you don't have easy_install or pip yet, this installs easy_install to a user-local path
- #wget https://bootstrap.pypa.io/ez_setup.py -O - | python - --user
+# In the case of my cygwin, it was ~/.local/bin/easy_install
- easy_install dulwich==0.9.1
+<syntaxhighlight lang=bash>
- # or pip dulwich==0.9.1
+easy_install dulwich==0.9.1
 ==Using bzr with github==

← Older revision		Revision as of 18:40, 7 May 2014
Line 188:		Line 188:

	But note that dulwich must also be installed.		But note that dulwich must also be installed.
		+
		+	# If you don't have easy_install or pip yet, this installs easy_install to a user-local path
		+	# In the case of my cygwin, it was ~/.local/bin/easy_install
		+	#wget https://bootstrap.pypa.io/ez_setup.py -O - \| python - --user
		+
		+	easy_install dulwich==0.9.1
		+	# or pip dulwich==0.9.1

	==Using bzr with github==		==Using bzr with github==