Merge upstream.
[jelmer/subvertpy.git] / README
1 ============
2 Introduction
3 ============
4
5 This directory contains a simple plugin that adds 
6 Subversion (http://subversion.tigris.org/) branch support to 
7 Bazaar (http://www.bazaar-vcs.org/). This allows ``bzr branch``, ``bzr push``, 
8 ``bzr pull``, and ``bzr co`` to work directly against Subversion repositories.
9
10 The plugin can at the moment be used to commit to, pull from, merge from, push 
11 to and view logs of Subversion branches from Bazaar.
12
13 ============
14 Dependencies
15 ============
16
17 You will need at least version 0.90 of Bazaar or higher.
18
19 You also need a fairly recent version of the Python bindings to the 
20 Subversion libraries. At the moment, the svn plugin only works with 
21 Subversion 1.5 (trunk). The python-subversion package in Ubuntu Feisty and 
22 Gutsy and Debian Etch, Lenny and Sid also contain the required changes. 
23
24 If you are running an older version of Python (under 2.5), you will also 
25 need to have the pysqlite package installed.
26
27 In order to be able to use the ``svn-upgrade`` command (for those 
28 who used earlier versions of bzr-svn), you will need the bzr-rebase 
29 plugin (http://bazaar-vcs.org/BzrSvn).
30
31 ========
32 Features
33 ========
34
35 The following features are currently present:
36
37 - Connecting to remote Subversion repositories over all 
38   protocols supported by Subversion itself (at present: 
39   svn://, svn+ssh://, http:// (webdav), file://) 
40   as well as dump files. 
41
42   Checkouts, lightweight checkouts and branching works.
43
44 - Track Bazaar merges in Subversion. Merged revisions show up 
45   as ghosts.
46
47 - Subversion working copies. Can be modified, queried 
48   ('bzr status' on a vanilla working copied created with 
49   'svn co' works) and committed from.
50
51 - Committing to Subversion from Bazaar.
52
53 - Push Bazaar revisions to Subversion. 
54
55 - Follow branch copies. Revision history is not 
56   truncated when a branch was copied in Subversion.
57
58 - Efficiently uses network bandwidth. 
59
60 - Recognizes file metadata (executable bits, symlinks).
61  
62 - 'svn-import' command with functionality similar to svn2bzr.
63
64 - Ability to track merges done with SVK (http://svk.elixus.org/) 
65   and write merges.
66
67 - Generates consistent file ids and revision ids. Two branches made using 
68   this plugin of the same Subversion branch will result in *exactly* the same 
69   Bazaar branch.
70
71 - Handles complex operations in Subversion: committing to two branches at 
72   once, upgrading directories to branches, copies from early revisions, ...
73
74 ===================
75 Future Enhancements
76 ===================
77
78 In the future, I also hope to support:
79
80 - Renames. Initial work has been done to support this, 
81   but the number of corner cases is wide, so support for this 
82   has not been enabled by default yet.
83
84 - Better performance. Network-wise (both bandwidth and roundtrips), the plugin 
85   is in good shape. However, it is currently quite CPU-intensive for no good 
86   reason and I hope to make a couple of improvements in that area.
87
88 - Override implementation of get_revision_delta(). Will speed up 'bzr log -v'
89         
90 - use svn_ra_replay() on systems that have Subversion 1.4. Saves a couple of 
91   roundtrips when fetching history.
92
93 - implement svn_ra_get_dir_revs() in Subversion to fetch the properties set on 
94   a specific directory all at once.
95
96 Some Subversion properties can currently not be represented in Bazaar 
97 and are therefore ignored for the time being:
98
99 - 'svn:ignore' is not imported. There should be a 
100   'Repository.get_ignores(revid)' call in Bazaar rather than a magic 
101   '.bzrignore' file. 
102    
103 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference' 
104   nested branches and the other way around. This can't be implemented 
105   this until Bazaars nested branch support lands. AaronBentley's work 
106   in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
107   This has been delayed until after 0.9 because of required repository
108   format changes.
109
110 - 'svn:mime-type'
111
112 - 'svn:eol-style'
113
114 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at 
115   https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion
116
117 Other features currently held back by Bazaars feature set:
118
119 - Horizon revision history. Most of the existing Subversion repositories 
120   are quite large and it would therefore be nice to be able to limit 
121   the amount of history that needs to be retrieved during checkouts.
122
123   Spec at https://launchpad.net/products/bzr/+spec/shallow-checkouts
124
125 - Tracking copies. 
126  
127   Spec at https://launchpad.net/products/bzr/+spec/filecopies
128
129 Features held back by Subversion:
130
131 - Showing SVN merges as merges in Bazaar. This requires full merge tracking 
132   information in Subversion, something which the Subversion folks are working 
133   on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
134
135   Might require cherry-picking support in Bazaar (or at least the ability 
136   to know about cherry picks). 
137    
138   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
139
140 ====
141 Bugs
142 ====
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 ============
149 Installation
150 ============
151
152 Simply place this directory in ~/.bazaar/plugins and you should be able 
153 to check out branches from Subversion using bzr. Make sure the directory 
154 name is 'svn'.
155
156 ============
157 Memory Usage
158 ============
159 bzr-svn can use a lot of memory cloning big branches. The problem appears to be 
160 caused both by a memory leak in the python-subversion bindings or Subversion
161 (the svn_ra_get_log() function) and the memory overhead from Bazaar.
162
163 The easiest way to work around this problem is to Ctrl+C the branch operation 
164 and restart it.
165
166 More information can be found in the bug report at 
167 https://launchpad.net/bugs/54253