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