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 branches in a format understandable by SVK.
  57
  58 .. _SVK: http://svk.elixus.org/
  59
  60 - Generates consistent file ids and revision ids. Two branches made using
  61   this plugin of the same Subversion branch will result in *exactly* the same
  62   Bazaar branch.
  63
  64 - Handles complex operations in Subversion: committing to two branches at
  65   once, upgrading directories to branches, copies from early revisions, ...
  66
  67 - Tested on Linux, Windows and Mac OS X.
  68
  69 Documentation
  70 -------------
  71
  72 bzr-svn can be used through the regular Bazaar user interface, see the
  73 `Bazaar Documentation Overview`_ for documentation on that.
  74
  75 .. _Bazaar Documentation Overview: Documentation
  76
  77 Some bzr-svn specific issues are answered by the FAQ_.
  78
  79 .. _FAQ: http://samba.org/~jelmer/bzr-svn/FAQ.html
  80
  81 The way Bazaar metadata is stored in Subversion and the other way around is specified in the `mapping specification`_.
  82
  83 .. _mapping specification: BzrForeignBranches/Subversion/mapping
  84
  85 Support
  86 -------
  87 Ask bzr-svn related questions on the `Bazaar mailing list`_ or in the
  88 #bzr IRC channel on Freenode_.
  89
  90 .. _Bazaar mailing list: http://lists.canonical.com/listinfo/bazaar/
  91 .. _Freenode: http://www.freenode.net/
  92
  93 Limitations
  94 -----------
  95
  96 Unsupported Subversion File Properties
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 Some Subversion properties can currently not be represented in Bazaar and are
 100 therefore ignored for the time being:
 101
 102 - 'svn:ignore'. There should be a `Repository.get_ignores(revid)` call in
 103   Bazaar rather than a magic '.bzrignore' file.
 104   Spec at https://launchpad.net/products/bzr/+spec/new-ignore-rules
 105
 106 - 'svn:mime-type'
 107
 108 - 'svn:eol-style'. Requires eol support in Bazaar.
 109
 110 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion. `#81463 <https://bugs.launchpad.net/bzr-svn/+bug/81463>`_
 111
 112 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference'
 113   nested branches and the other way around. This can't be implemented
 114   this until Bazaars nested branch support lands. AaronBentley's work
 115   in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
 116
 117
 118 Future Enhancements
 119 -------------------
 120
 121 In the future, I also hope to support:
 122
 123 - Renames. Initial work has been done to support this,
 124   but the number of corner cases is wide, so support for this
 125   has not been enabled by default yet.
 126
 127 - Override implementation of get_revision_delta(). Will speed up 'bzr log -v'
 128
 129 - use svn_ra_replay() when using servers that have Subversion 1.4. Saves a
 130   couple of roundtrips when fetching history.
 131
 132 - Shallow branches. Most of the existing Subversion repositories
 133   are quite large and it would therefore be nice to be able to limit
 134   the amount of history that needs to be retrieved during checkouts.
 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. Python 2.5 and higher have sqlite support built in.
 167
 168 Subversion development files
 169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 170
 171 You need the Subversion libraries, including the development files. This should
 172 be readily packaged for most platforms. The package name for Debian
 173 and Debian-based distributions is ``libsvn-dev``.
 174
 175 bzr-rebase
 176 ~~~~~~~~~~
 177
 178 In order to be able to use the ``svn-upgrade`` command (for those
 179 who used versions of bzr-svn older than 0.4.0), you will need the `bzr-rebase`_
 180 plugin.
 181
 182 .. _bzr-rebase: http://bazaar-vcs.org/Rebase
 183
 184 Bugs
 185 ----
 186
 187 Please file bug reports in launchpad. The product URL for bzr-svn is
 188 https://launchpad.net/bzr-svn/.
 189
 190 The wiki for this plugin is at http://bazaar-vcs.org/BzrForeignBranches/Subversion.
 191
 192 Installation
 193 ------------
 194
 195 Simply place this directory in ~/.bazaar/plugins and you should be able
 196 to check out branches from Subversion using bzr. Make sure the directory
 197 name is 'svn'. The plugin has to be built as well by running ``make``.
 198
 199 Development
 200 -----------
 201
 202 Unit testing
 203 ~~~~~~~~~~~~
 204 To run the bzr-svn testsuite, simply run 'bzr selftest svn'
 205
 206 Credits
 207 -------
 208 bzr-svn was written by JelmerVernooij_ with the help from various other people. See the AUTHORS file for a full list of contributors.
 209
 210 .. _JelmerVernooij: http://samba.org/~jelmer/
 211
 212 ..
 213         vim: ft=rest