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