Merge foreign branch utility module.
[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 - Writes svn:mergeinfo property used by Subversion 1.5.
62
63 - Generates consistent file ids and revision ids. Two branches made using 
64   this plugin of the same Subversion branch will result in *exactly* the same 
65   Bazaar branch.
66
67 - Handles complex operations in Subversion: committing to two branches at 
68   once, upgrading directories to branches, copies from early revisions, ...
69
70 - Tested on Linux, Windows and Mac OS X. 
71
72 Documentation
73 -------------
74
75 bzr-svn can be used through the regular Bazaar user interface, see the 
76 `Bazaar Documentation Overview`_ for documentation on that.
77
78 .. _Bazaar Documentation Overview: Documentation
79
80 Some bzr-svn specific issues are answered by the FAQ_.
81
82 .. _FAQ: http://samba.org/~jelmer/bzr-svn/FAQ.html
83
84 The way Bazaar metadata is stored in Subversion and the other way around is 
85 specified in the `mapping specification`_.
86
87 .. _mapping specification: BzrForeignBranches/Subversion/mapping
88
89 Limitations
90 -----------
91
92 Unsupported Subversion File Properties
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
95 Some Subversion properties can currently not be represented in Bazaar and are 
96 therefore ignored for the time being:
97
98 - 'svn:ignore'. There should be a `Repository.get_ignores(revid)` call in 
99   Bazaar rather than a magic '.bzrignore' file. 
100   Spec at https://launchpad.net/products/bzr/+spec/new-ignore-rules
101
102 - 'svn:mime-type'
103
104 - 'svn:eol-style'. Requires eol support in Bazaar.
105
106 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at 
107   https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion. 
108   `#81463 <https://bugs.launchpad.net/bzr-svn/+bug/81463>`_
109
110 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference' 
111   nested branches and the other way around. This can't be implemented 
112   until Bazaars nested branch support lands.
113
114
115 Future Enhancements
116 -------------------
117
118 In the future, I also hope to support:
119
120 - Renames. Initial work has been done to support this, 
121   but the number of corner cases is wide, so support for this 
122   has not been enabled by default yet.
123
124 - Override implementation of get_revision_delta(). Will speed up 'bzr log -v'
125         
126 - use svn_ra_replay() when using servers that have Subversion 1.4. Saves a 
127   couple of roundtrips when fetching history.
128
129 Some Subversion properties can currently not be represented in Bazaar 
130 and are therefore ignored for the time being:
131
132 Other features currently held back by Bazaars feature set:
133
134 - Tracking copies. 
135  
136   Spec at https://launchpad.net/products/bzr/+spec/filecopies
137
138 - Showing SVN merges as merges in Bazaar. This requires full merge tracking 
139   information in Subversion, something which the Subversion folks are working 
140   on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
141
142   Requires tracking cherry-picking support in Bazaar:
143    
144   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
145
146 Support
147 -------
148 Ask bzr-svn related questions on the `Bazaar mailing list`_ or in the 
149 #bzr IRC channel on Freenode_.
150
151 .. _Bazaar mailing list: http://lists.canonical.com/listinfo/bazaar/
152 .. _Freenode: http://www.freenode.net/
153
154 Bugs
155 ----
156
157 Please file bug reports in launchpad. The product URL for bzr-svn is
158 https://launchpad.net/bzr-svn/. 
159
160 The wiki for this plugin is at http://bazaar-vcs.org/BzrForeignBranches/Subversion.
161
162 ..
163         vim: ft=rest