Merge fix for 140001.
[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 Some Subversion properties can currently not be represented in Bazaar 
95 and are therefore ignored for the time being:
96
97 - 'svn:ignore' is not imported. There should be a 
98   'Repository.get_ignores(revid)' call in Bazaar rather than a magic 
99   '.bzrignore' file. 
100    
101 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference' 
102   nested branches and the other way around. This can't be implemented 
103   this until Bazaars nested branch support lands. AaronBentley's work 
104   in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
105   This has been delayed until after 0.9 because of required repository
106   format changes.
107
108 - 'svn:mime-type'
109
110 - 'svn:eol-style'
111
112 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at 
113   https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion
114
115 Other features currently held back by Bazaars feature set:
116
117 - Horizon revision history. Most of the existing Subversion repositories 
118   are quite large and it would therefore be nice to be able to limit 
119   the amount of history that needs to be retrieved during checkouts.
120
121   Spec at https://launchpad.net/products/bzr/+spec/shallow-checkouts
122
123 - Tracking copies. 
124  
125   Spec at https://launchpad.net/products/bzr/+spec/filecopies
126
127 Features held back by Subversion:
128
129 - Showing SVN merges as merges in Bazaar. This requires full merge tracking 
130   information in Subversion, something which the Subversion folks are working 
131   on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
132
133   Might require cherry-picking support in Bazaar (or at least the ability 
134   to know about cherry picks). 
135    
136   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
137
138 ====
139 Bugs
140 ====
141  
142 Please file bug reports in launchpad. The product URL for bzr-svn is
143 https://launchpad.net/products/bzr-svn/. The wiki for this 
144 plugin is at http://bazaar-vcs.org/BzrSvn.
145
146 ============
147 Installation
148 ============
149
150 Simply place this directory in ~/.bazaar/plugins and you should be able 
151 to check out branches from Subversion using bzr. Make sure the directory 
152 name is 'svn'.
153
154 ============
155 Memory Usage
156 ============
157 bzr-svn can use a lot of memory cloning big branches. The problem appears to be 
158 caused both by a memory leak in the python-subversion bindings or Subversion
159 (the svn_ra_get_log() function) and the memory overhead from Bazaar.
160
161 The easiest way to work around this problem is to Ctrl+C the branch operation 
162 and restart it.
163
164 More information can be found in the bug report at 
165 https://launchpad.net/bugs/54253