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