README

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