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