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