← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/svn_plugin.txt

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/svn_plugin.txt
 
1
bzr-svn
 
2
=======
 
3
 
 
4
Overview
 
5
--------
 
6
 
 
7
bzr-svn lets developers use Bazaar as their VCS client on projects
 
8
still using a central Subversion repository. Access to Subversion
 
9
repositories is largely transparent, i.e. you can use most ``bzr``
 
10
commands directly on Subversion repositories exactly the same
 
11
as if you were using ``bzr`` on native Bazaar branches.
 
12
 
 
13
Many bzr-svn users create a local mirror of the central Subversion
 
14
trunk, work in local feature branches, and submit their
 
15
overall change back to Subversion when it is ready
 
16
to go. This lets them gain many of the advantages of distributed
 
17
VCS tools without interrupting existing team-wide processes and
 
18
tool integration hooks currently built on top of Subversion. Indeed,
 
19
this is a common interim step for teams looking to adopt Bazaar but
 
20
who are unable to do so yet for timing or non-technical reasons.
 
21
 
 
22
For installation instructions, see the bzr-svn home page:
 
23
http://bazaar-vcs.org/BzrForeignBranches/Subversion.
 
24
 
 
25
 
 
26
A simple example
 
27
----------------
 
28
 
 
29
Here's a simple example of how you can use bzr-svn to hack on a
 
30
GNOME project like **beagle**. Firstly, setup a local shared repository
 
31
for storing your branches in and checkout the trunk::
 
32
 
 
33
  bzr init-repo --rich-root-pack beagle-repo
 
34
  cd beagle-repo
 
35
  bzr checkout svn+ssh://svn.gnome.org/svn/beagle/trunk beagle-trunk
 
36
 
 
37
Note that using the ``rich-root-pack`` option to ``init-repo`` is
 
38
important as bzr-svn requires some extra metadata not yet supported in Bazaar's
 
39
default repository format. Next, create a feature branch and hack away::
 
40
 
 
41
  bzr branch beagle-trunk beagle-feature1
 
42
  cd beagle-feature1
 
43
  (hack, hack, hack)
 
44
  bzr commit -m "blah blah blah"
 
45
  (hack, hack, hack)
 
46
  bzr commit -m "blah blah blah"
 
47
 
 
48
When the feature is cooked, refresh your trunk mirror and merge
 
49
your change::
 
50
 
 
51
  cd ../beagle-trunk
 
52
  bzr update
 
53
  bzr merge ../beagle-feature1
 
54
  bzr commit -m "Complete comment for SVN commit"
 
55
 
 
56
As your trunk mirror is a checkout, committing to it implicitly
 
57
commits to the real Subversion trunk. That's it!
 
58
 
 
59
 
 
60
Using a central repository mirror
 
61
---------------------------------
 
62
 
 
63
For large projects, it often makes sense to tweak the recipe given above.
 
64
In particular, the initial checkout can get quite slow so you may wish
 
65
to import the Subversion repository into a Bazaar one once and for all
 
66
for your project, and then branch from that native Bazaar repository
 
67
instead. bzr-svn provides the ``svn-import`` command for doing this
 
68
repository-to-repository conversion. Here's an example of how to use it::
 
69
 
 
70
  bzr svn-import svn+ssh://svn.gnome.org/svn/beagle
 
71
 
 
72
Here's the recipe from above updated to use a central Bazaar mirror::
 
73
 
 
74
  bzr init-repo --rich-root-pack beagle-repo
 
75
  cd beagle-repo
 
76
  bzr branch bzr+ssh://bzr.gnome.org/beagle.bzr/trunk beagle-trunk
 
77
  bzr branch beagle-trunk beagle-feature1
 
78
  cd beagle-feature1
 
79
  (hack, hack, hack)
 
80
  bzr commit -m "blah blah blah"
 
81
  (hack, hack, hack)
 
82
  bzr commit -m "blah blah blah"
 
83
  cd ../beagle-trunk
 
84
  bzr pull
 
85
  bzr merge ../beagle-feature1
 
86
  bzr commit -m "Complete comment for SVN commit"
 
87
  bzr push
 
88
 
 
89
In this case, committing to the trunk only commits the merge locally.
 
90
To commit back to the master Subversion trunk, an additional command
 
91
(``bzr push``) is required.
 
92
 
 
93
Note: You'll need to give ``pull`` and ``push`` the relevant URLs
 
94
the first time you use those commands in the trunk branch. After that,
 
95
bzr remembers them.
 
96
 
 
97
The final piece of the puzzle in this setup is to put scripts in
 
98
place to keep the central Bazaar mirror synchronized with the Subversion
 
99
one. This can be done by adding a cron job, using a Subversion hook,
 
100
or whatever makes sense in your environment.
 
101
 
 
102
 
 
103
Limitations of bzr-svn
 
104
----------------------
 
105
 
 
106
Bazaar and Subversion are different tools with different capabilities
 
107
so there will always be some limited interoperability issues.
 
108
Here are some examples current as of bzr-svn 0.4.10:
 
109
 
 
110
 * Bazaar doesn't support versioned properties
 
111
 
 
112
 * Bazaar doesn't support tracking of file copies.
 
113
 
 
114
 * ``bzr push`` to an existing Subversion branch works but 
 
115
   ``bzr push`` to a new Subversion branch doesn't. Until
 
116
   the relevant bug is fixed (#121875), you need to use
 
117
   ``bzr svn-push`` in the latter case.
 
118
 
 
119
See the bzr-svn web page,
 
120
http://bazaar-vcs.org/BzrForeignBranches/Subversion,
 
121
for the current list of constraints.