README

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