more README updates
[jelmer/subvertpy.git] / README
1 Bazaar support for Subversion branches, working trees and repositories
2 ======================================================================
3
4 .. contents::
5
6 Introduction
7 ------------
8
9 bzr-svn is a plugin that allows Bazaar_ direct access to Subversion_ 
10 repositories. It allows most bzr commands to work directly against Subversion 
11 repositories, as if you were using bzr with a native bzr repository.
12
13 .. _Bazaar: http://bazaar-vcs.org/
14 .. _Subversion: http://subversion.tigris.org/
15
16 The plugin can at the moment be used to commit to, pull from, merge from, push 
17 to and view logs of Subversion branches from Bazaar.
18
19 Dependencies
20 ------------
21
22 You will need a recent version of Bazaar, usually the release of Bazaar 
23 released in the same month as the release of bzr-svn you are using.
24
25 You also need a fairly recent version of the official Python bindings to the 
26 Subversion libraries. At the moment, the svn plugin only works with 
27 Subversion 1.5 (trunk). The python-subversion (not python-svn!) package 
28 in Ubuntu since Feisty and Debian since Etch also contain the 
29 required changes. 
30
31 If you are running an older version of Python (under 2.5), you will also 
32 need to have the pysqlite package installed.
33
34 In order to be able to use the ``svn-upgrade`` command (for those 
35 who used earlier versions of bzr-svn), you will need the `bzr-rebase`_ 
36 plugin.
37
38 .. _bzr-rebase: http://bazaar-vcs.org/Rebase
39
40 Features
41 --------
42
43 The following features are currently present:
44
45 - Connecting to remote Subversion repositories over all 
46   protocols supported by Subversion itself (at present: 
47   svn://, svn+ssh://, http:// (webdav), file://) 
48   as well as dump files. 
49
50   Checkouts, lightweight checkouts and branching works.
51
52 - Integrates well with Bazaar.
53
54 - Track Bazaar merges in Subversion. Merged revisions show up 
55   as ghosts.
56
57 - Subversion working copies. Can be modified, queried 
58   (``bzr status`` on a svn- native working copy created with 
59   ``svn co`` works) and committed from.
60
61 - Committing to Subversion from Bazaar.
62
63 - Push Bazaar revisions to Subversion. 
64
65 - Follow branch copies. Revision history is not 
66   truncated when a branch was copied in Subversion.
67
68 - Efficiently uses network bandwidth. 
69
70 - Recognizes file metadata (executable bits, symbolic links).
71
72 - 'svn-import' command with functionality similar to svn2bzr_.
73
74 - Ability to track merges done with SVK_ and write merges from SVK/Subversion branches in a format understandable by SVK.
75
76 .. _SVK: http://svk.elixus.org/
77
78 - Generates consistent file ids and revision ids. Two branches made using 
79   this plugin of the same Subversion branch will result in *exactly* the same 
80   Bazaar branch.
81
82 - Handles complex operations in Subversion: committing to two branches at 
83   once, upgrading directories to branches, copies from early revisions, ...
84
85 - Tested on Linux, Windows and Mac OS X. 
86
87 Documentation
88 -------------
89
90 bzr-svn can be used through the regular Bazaar user interface, see the 
91 `Bazaar Documentation Overview`_ for documentation on that.
92
93 .. _Bazaar Documentation Overview: Documentation
94
95 Some bzr-svn specific issues are answered by the FAQ_.
96
97 .. _FAQ: http://samba.org/~jelmer/bzr-svn/FAQ.html
98
99 The way Bazaar metadata is stored in Subversion and the other way around is specified in the `mapping specification`_.
100
101 .. _mapping specification: BzrForeignBranches/Subversion/mapping
102
103 Support
104 -------
105 Ask bzr-svn related questions on the `Bazaar mailing list`_ or in the 
106 #bzr IRC channel on Freenode_.
107
108 .. _Bazaar mailing list: http://lists.canonical.com/listinfo/bazaar/
109 .. _Freenode: http://www.freenode.net/
110
111
112
113 Future Enhancements
114 -------------------
115
116 In the future, I also hope to support:
117
118 - Renames. Initial work has been done to support this, 
119   but the number of corner cases is wide, so support for this 
120   has not been enabled by default yet.
121
122 - Override implementation of get_revision_delta(). Will speed up 'bzr log -v'
123         
124 - use svn_ra_replay() when using servers that have Subversion 1.4. Saves a 
125   couple of roundtrips when fetching history.
126
127 - Shallow branches. Most of the existing Subversion repositories 
128   are quite large and it would therefore be nice to be able to limit 
129   the amount of history that needs to be retrieved during checkouts.
130
131 Some Subversion properties can currently not be represented in Bazaar 
132 and are therefore ignored for the time being:
133
134 - 'svn:ignore' is not imported. There should be a 
135   'Repository.get_ignores(revid)' call in Bazaar rather than a magic 
136   '.bzrignore' file. 
137    
138 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference' 
139   nested branches and the other way around. This can't be implemented 
140   this until Bazaars nested branch support lands. AaronBentley's work 
141   in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
142   This has been delayed until after 0.9 because of required repository
143   format changes.
144
145 - 'svn:mime-type'
146
147 - 'svn:eol-style'
148
149 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at 
150   https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion
151
152 Other features currently held back by Bazaars feature set:
153
154 - Tracking copies. 
155  
156   Spec at https://launchpad.net/products/bzr/+spec/filecopies
157
158 - Showing SVN merges as merges in Bazaar. This requires full merge tracking 
159   information in Subversion, something which the Subversion folks are working 
160   on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
161
162   Requires tracking cherry-picking support in Bazaar:
163    
164   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
165
166 Bugs
167 ----
168
169 Please file bug reports in launchpad. The product URL for bzr-svn is
170 https://launchpad.net/bzr-svn/. The wiki for this 
171 plugin is at http://bazaar-vcs.org/BzrSvn.
172
173 Installation
174 ------------
175
176 Simply place this directory in ~/.bazaar/plugins and you should be able 
177 to check out branches from Subversion using bzr. Make sure the directory 
178 name is 'svn'.
179
180 Development
181 -----------
182
183 Unit testing
184 ~~~~~~~~~~~~
185 To run the bzr-svn testsuite, simply run 'bzr selftest svn'
186
187
188
189 ..
190         vim: ft=rest