Fix formatting in README, add note about stacked branches.
[jelmer/subvertpy.git] / README
1 Bazaar support for Subversion branches, working trees and repositories
2 ======================================================================
3
4 .. contents::
5
6 Introduction
7 ------------
8
9 bzr-svn is a plugin that allows Bazaar_ direct access to Subversion_ 
10 repositories. It allows most bzr commands to work directly against Subversion 
11 repositories, as if you were using bzr with a native bzr repository.
12
13 .. _Bazaar: http://bazaar-vcs.org/
14 .. _Subversion: http://subversion.tigris.org/
15
16 The plugin can at the moment be used to commit to, pull from, merge from, push 
17 to and view logs of Subversion branches from Bazaar.
18
19
20 Features
21 --------
22
23 The following features are currently present:
24
25 - Connecting to remote Subversion repositories over all 
26   protocols supported by Subversion itself (at present: 
27   svn://, svn+ssh://, http:// (webdav), file://) 
28   as well as dump files. 
29
30   Checkouts, lightweight checkouts and branching works.
31
32 - Integrates well with Bazaar.
33
34 - Track Bazaar merges in Subversion. Merged revisions show up 
35   as ghosts.
36
37 - Subversion working copies. Can be modified, queried 
38   (``bzr status`` on a svn- native working copy created with 
39   ``svn co`` works) and committed from.
40
41 - Committing to Subversion from Bazaar.
42
43 - Push Bazaar revisions to Subversion. 
44
45 - Follow branch copies. Revision history is not 
46   truncated when a branch was copied in Subversion.
47
48 - Efficiently uses network bandwidth.
49
50 - Recognizes file metadata (executable bits, symbolic links).
51
52 - 'svn-import' command with functionality similar to svn2bzr_.
53
54 .. _svn2bzr: http://bazaar-vcs.org/svn2bzr
55
56 - Ability to track merges done with SVK_ and write merges from SVK/Subversion 
57   branches in a format understandable by SVK.
58
59 .. _SVK: http://svk.elixus.org/
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 - Tested on Linux, Windows and Mac OS X. 
69
70 Documentation
71 -------------
72
73 bzr-svn can be used through the regular Bazaar user interface, see the 
74 `Bazaar Documentation Overview`_ for documentation on that.
75
76 .. _Bazaar Documentation Overview: Documentation
77
78 Some bzr-svn specific issues are answered by the FAQ_.
79
80 .. _FAQ: http://samba.org/~jelmer/bzr-svn/FAQ.html
81
82 The way Bazaar metadata is stored in Subversion and the other way around is 
83 specified in the `mapping specification`_.
84
85 .. _mapping specification: BzrForeignBranches/Subversion/mapping
86
87 Support
88 -------
89 Ask bzr-svn related questions on the `Bazaar mailing list`_ or in the 
90 #bzr IRC channel on Freenode_.
91
92 .. _Bazaar mailing list: http://lists.canonical.com/listinfo/bazaar/
93 .. _Freenode: http://www.freenode.net/
94
95 Limitations
96 -----------
97
98 Unsupported Subversion File Properties
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100
101 Some Subversion properties can currently not be represented in Bazaar and are 
102 therefore ignored for the time being:
103
104 - 'svn:ignore'. There should be a `Repository.get_ignores(revid)` call in 
105   Bazaar rather than a magic '.bzrignore' file. 
106   Spec at https://launchpad.net/products/bzr/+spec/new-ignore-rules
107
108 - 'svn:mime-type'
109
110 - 'svn:eol-style'. Requires eol support in Bazaar.
111
112 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at 
113   https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion. 
114   `#81463 <https://bugs.launchpad.net/bzr-svn/+bug/81463>`_
115
116 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference' 
117   nested branches and the other way around. This can't be implemented 
118   this until Bazaars nested branch support lands. AaronBentley's work 
119   in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
120
121
122 Future Enhancements
123 -------------------
124
125 In the future, I also hope to support:
126
127 - Renames. Initial work has been done to support this, 
128   but the number of corner cases is wide, so support for this 
129   has not been enabled by default yet.
130
131 - Override implementation of get_revision_delta(). Will speed up 'bzr log -v'
132         
133 - use svn_ra_replay() when using servers that have Subversion 1.4. Saves a 
134   couple of roundtrips when fetching history.
135
136 Some Subversion properties can currently not be represented in Bazaar 
137 and are therefore ignored for the time being:
138
139 Other features currently held back by Bazaars feature set:
140
141 - Tracking copies. 
142  
143   Spec at https://launchpad.net/products/bzr/+spec/filecopies
144
145 - Showing SVN merges as merges in Bazaar. This requires full merge tracking 
146   information in Subversion, something which the Subversion folks are working 
147   on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
148
149   Requires tracking cherry-picking support in Bazaar:
150    
151   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
152
153 Requirements
154 ------------
155
156 Bazaar
157 ~~~~~~
158
159 You will need a recent version of Bazaar, usually the release of Bazaar 
160 released in the same month as the release of bzr-svn you are using. bzr-svn 
161 will warn if the Bazaar release used is too old or too new.
162
163 SQLite
164 ~~~~~~
165
166 If you are using Python 2.4, you will need to have the pysqlite module installed. 
167 Python 2.5 and higher have sqlite support built in. 
168
169 Subversion development files
170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171
172 You need the Subversion libraries, including the development files. This should
173 be readily packaged for most platforms. The package name for Debian 
174 and Debian-based distributions such as Ubuntu is ``libsvn-dev``. 
175  
176 bzr-rebase
177 ~~~~~~~~~~
178
179 In order to be able to use the ``svn-upgrade`` command (for those 
180 who used versions of bzr-svn older than 0.4.0), you will need the `bzr-rebase`_ 
181 plugin.
182
183 .. _bzr-rebase: http://bazaar-vcs.org/Rebase
184
185 Bugs
186 ----
187
188 Please file bug reports in launchpad. The product URL for bzr-svn is
189 https://launchpad.net/bzr-svn/. 
190
191 The wiki for this plugin is at http://bazaar-vcs.org/BzrForeignBranches/Subversion.
192
193 Installation
194 ------------
195
196 Simply place this directory in ~/.bazaar/plugins and you should be able 
197 to check out branches from Subversion using bzr. Make sure the directory 
198 name is 'svn'. The plugin has to be built as well by running ``make``.
199
200 Development
201 -----------
202
203 Unit testing
204 ~~~~~~~~~~~~
205 To run the bzr-svn testsuite, simply run 'bzr selftest svn'
206
207 Credits
208 -------
209 bzr-svn was written by JelmerVernooij_ with the help from various other people. See 
210 the AUTHORS file for a full list of contributors.
211
212 .. _JelmerVernooij: http://samba.org/~jelmer/
213
214 ..
215         vim: ft=rest