bzr-svn requires bazaar 0.13.
[jelmer/subvertpy.git] / README
1 == Introduction ==
2
3 This directory contains a simple plugin that adds 
4 Subversion (http://subversion.tigris.org/) branch support to 
5 Bazaar (http://www.bazaar-vcs.org/)
6
7 == Dependencies == 
8
9 You will need at least version 0.13 of Bazaar-NG (currently unreleased).
10
11 You also need a fairly recent version of the Python bindings to the 
12 Subversion libraries. At the moment, the svn plugin only works with 
13 Subversion 1.5 (trunk). The python-subversion package in Ubuntu Edgy and 
14 Debian Sid also contains the required changes.
15
16 == Features ==
17
18 The following features are currently present:
19
20  * Connecting to remote Subversion repositories over all 
21    protocols supported by Subversion itself (at present: 
22         svn://, svn+ssh://, http:// (webdav), file://) 
23    as well as dump files. 
24
25    Checkouts, lightweight checkouts and branching works.
26
27  * Track Bazaar merges in Subversion. Merged revisions show up 
28    as ghosts.
29
30  * Subversion working copies. Can be modified, queried 
31    (`bzr status' on a vanilla working copied created with 
32         `svn co' works) and committed from.
33
34  * Committing to Subversion from Bazaar.
35
36  * Push Bazaar revisions to Subversion. These revisions will 
37    show up in Subversion as a commit with the pushed revision 
38    as one of the parents.
39
40  * Follow branch copies. Revision history is not 
41    truncated when a branch was copied in Subversion.
42
43  * Efficiently uses network bandwidth. 
44
45  * Recognizes file metadata (executable bits, symlinks).
46  
47  * 'import-svn' command with functionality similar to svn2bzr.
48
49  * Ability to track merges done with SVK (http://svk.elixus.org/) 
50    and write merges.
51
52  * Generates consistent file ids and revision ids. Two branches made using 
53    this plugin of the same Subversion branch will result in *exactly* the same 
54    Bazaar branch.
55
56  * Handles complex operations in Subversion: committing to two branches at 
57    once, upgrading directories to branches, copies from early revisions, ...
58
59 == Future Enhancements ==
60
61 In the future, I also hope to support:
62
63  * Renames. Initial work has been done to support this, 
64    but the number of corner cases is wide, so support for this 
65    has not been enabled by default yet.
66
67    Those brave enough can test the current support out by 
68    registering SvnRenamingRepository instead of 
69    SvnRepository in __init__.py.
70
71  * "True" push. This requires storing the Bazaar 
72    inventory and revision in Subversion revision properties.
73
74    Ideally, revision id aliases would have to be used so the 
75    revision id that is being 'overriden' can still exist.
76
77    Once this is implemented, it would also be possible and 
78    make sense to store GPG signatures for commits in 
79    Subversion branches.
80
81    This might require also storing 'bzr:inventory' and 'bzr:revision' 
82    properties in order to make sure the sha1's for a revision keep matching.
83
84  * Proper read locking, which has basically been ignored for now. 
85
86  * Performance. Network-wise (both bandwidth and roundtrips), the plugin is in
87    good shape. However, it is currently quite CPU-intensive for no good reason 
88    and I hope to make a couple of improvements in that area.
89
90          * Override implementation of get_revision_delta(). Will speed up 'bzr log -v'
91         
92          * use svn_ra_replay() on systems that have Subversion 1.4. Saves a couple of roundtrips when fetching history.
93
94          * implement svn_ra_get_dir_revs() in Subversion to fetch the properties set on a specific directory all at once.
95
96  * Creating native Subversion working copies. This 
97    would mostly be supported for completeness' sake, there are not 
98    a lot of advantages in supporting it.
99
100 Some Subversion properties can currently not be represented in Bazaar 
101 and are therefore ignored for the time being:
102
103  * `svn:ignore' is not imported. There should be a 
104    `Repository.get_ignores(revid)' call in Bazaar rather than a magic 
105    '.bzrignore' file. 
106    
107  * `svn:externals'. Externals should be mapped to Bazaar 'by-reference' 
108    nested branches and the other way around. This can't be implemented 
109    this until Bazaars nested branch support lands. AaronBentley's work 
110    in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
111    This has been delayed until after 0.9 because of required repository
112    format changes.
113
114  * `svn:mime-type'
115
116  * `svn:eol-style'
117
118  * `svn:keywords'. Requires keywords support in Bazaar. Spec at 
119    https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion
120
121 Other features currently held back by Bazaars feature set:
122
123  * Horizon revision history. Most of the existing Subversion repositories 
124    are quite large and it would therefore be nice to be able to limit 
125    the amount of history that needs to be retrieved during checkouts.
126
127  * Tracking copies. 
128  
129    Spec at https://launchpad.net/products/bzr/+spec/filecopies
130
131 Features held back by Subversion:
132
133  * Showing SVN merges as merges in Bazaar. This requires full merge tracking 
134    information in Subversion, something which the Subversion folks are working 
135    on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
136
137    Might require cherry-picking support in Bazaar (or at least the ability 
138    to know about cherry picks). 
139    
140    Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
141
142 == Bugs ==
143  
144 Please file bug reports in launchpad. The product URL for bzr-svn is
145 https://launchpad.net/products/bzr-svn/. The wiki for this 
146 plugin is at http://bazaar-vcs.org/BzrSvn.
147
148 == Installation ==
149
150 Simply place this directory in ~/.bazaar/plugins and you should be able 
151 to check out branches from Subversion using bzr.
152
153 == License ==
154
155 GNU General Public License, v2 or later.
156
157 == Unit testing ==
158
159 Simply run 'bzr selftest svn'
160
161 == Author ==
162
163 Jelmer Vernooij <jelmer@samba.org>