README

   1 Bazaar support for Subversion branches, working trees and repositories
   2 ======================================================================
   3
   4 .. contents::
   5
   6 Introduction
   7 ------------
   8
   9 This directory contains a simple plugin that adds
  10 Subversion (http://subversion.tigris.org/) branch support to
  11 Bazaar (http://www.bazaar-vcs.org/). This allows ``bzr branch``, ``bzr push``,
  12 ``bzr pull``, and ``bzr co`` to work directly against Subversion repositories.
  13
  14 The plugin can at the moment be used to commit to, pull from, merge from, push
  15 to and view logs of Subversion branches from Bazaar.
  16
  17 Dependencies
  18 ------------
  19
  20 You will need at least version 0.92 of Bazaar or higher.
  21
  22 You also need a fairly recent version of the official Python bindings to the
  23 Subversion libraries. At the moment, the svn plugin only works with
  24 Subversion 1.5 (trunk). The python-subversion (not python-svn!) package
  25 in Ubuntu Feisty and Gutsy and Debian Etch, Lenny and Sid also contain the
  26 required changes.
  27
  28 If you are running an older version of Python (under 2.5), you will also
  29 need to have the pysqlite package installed.
  30
  31 In order to be able to use the ``svn-upgrade`` command (for those
  32 who used earlier versions of bzr-svn), you will need the bzr-rebase
  33 plugin (http://bazaar-vcs.org/BzrSvn).
  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 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 - Shallow branches. Most of the existing Subversion repositories
  96   are quite large and it would therefore be nice to be able to limit
  97   the amount of history that needs to be retrieved during checkouts.
  98
  99 Some Subversion properties can currently not be represented in Bazaar
 100 and are therefore ignored for the time being:
 101
 102 - 'svn:ignore' is not imported. There should be a
 103   'Repository.get_ignores(revid)' call in Bazaar rather than a magic
 104   '.bzrignore' file.
 105
 106 - 'svn:externals'. Externals should be mapped to Bazaar 'by-reference'
 107   nested branches and the other way around. This can't be implemented
 108   this until Bazaars nested branch support lands. AaronBentley's work
 109   in progress is at http://code.aaronbentley.com/bzr/bzrrepo/nested-trees/.
 110   This has been delayed until after 0.9 because of required repository
 111   format changes.
 112
 113 - 'svn:mime-type'
 114
 115 - 'svn:eol-style'
 116
 117 - 'svn:keywords'. Requires keywords support in Bazaar. Spec at
 118   https://launchpad.net/products/bzr/+spec/bzr-keyword-expansion
 119
 120 Other features currently held back by Bazaars feature set:
 121
 122 - Tracking copies.
 123
 124   Spec at https://launchpad.net/products/bzr/+spec/filecopies
 125
 126 - Showing SVN merges as merges in Bazaar. This requires full merge tracking
 127   information in Subversion, something which the Subversion folks are working
 128   on at the moment (see https://svn.collab.net/repos/svn/branches/merge-tracking).
 129
 130   Requires tracking cherry-picking support in Bazaar:
 131
 132   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
 133
 134 Bugs
 135 ----
 136
 137 Please file bug reports in launchpad. The product URL for bzr-svn is
 138 https://launchpad.net/products/bzr-svn/. The wiki for this
 139 plugin is at http://bazaar-vcs.org/BzrSvn.
 140
 141 Installation
 142 ------------
 143
 144 Simply place this directory in ~/.bazaar/plugins and you should be able
 145 to check out branches from Subversion using bzr. Make sure the directory
 146 name is 'svn'.
 147
 148 ..
 149         vim: ft=rest