← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to doc/en/user-guide/stacked.txt

  • Committer: Martin Pool
  • Date: 2010-07-02 07:29:40 UTC
  • mfrom: (129.1.7 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100702072940-hpzq5elg8wjve8rh
http://bugs.debian.org/452024
http://bugs.debian.org/464688
http://bugs.debian.org/523595
http://bugs.debian.org/526233
http://bugs.debian.org/537708
http://bugs.debian.org/555336
http://bugs.debian.org/555343
https://launchpad.net/bugs/249452
https://launchpad.net/bugs/385074
* PPA rebuild.
* PPA rebuild for Karmic.
* PPA rebuild for Jaunty.
* PPA rebuild for Hardy.
* From postinst, actually remove the example bash completion scripts.
  (LP: #249452)
* New upstream release.
* New upstream release.
* New upstream release.
* Revert change to Build-depends: Dapper does not have python-central.
  Should be python-support..
* Target ppa..
* Target ppa..
* Target ppa..
* Target ppa..
* New upstream release.
* Switch to dpkg-source 3.0 (quilt) format.
* Bump standards version to 3.8.4.
* Remove embedded copy of python-configobj. Closes: #555336
* Remove embedded copy of python-elementtree. Closes: #555343
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* debian/control: Fix obsolete-relation-form-in-source
  lintian warning. 
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split out docs into bzr-doc package.
* New upstream release.
* Added John Francesco Ferlito to Uploaders.
* Fix install path to quick-reference guide
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again, again.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to path changes.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Bump standards version to 3.8.3.
* Remove unused patch system.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix copy and paste tab error in .install file
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
 + Fixes compatibility with Python 2.4. Closes: #537708
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream version.
* Bump standards version to 3.8.2.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add python-pyrex to build-deps to ensure C extensions are always build.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix API compatibility version. (Closes: #526233)
* New upstream release.
  + Fixes default format for upgrade command. (Closes: #464688)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add missing dependency on zlib development library. (Closes:
  #523595)
* Add zlib build-depends.
* Add zlib build-depends.
* Add zlib build-depends.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Move to section vcs.
* Bump standards version to 3.8.1.
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Recommend ca-certificates. (Closes: #452024)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Update watch file. bazaar now uses launchpad to host its sources.
* Remove patch for inventory root revision copy, applied upstream.
* New upstream release.
* New upstream release.
* New upstream release
* Force removal of files installed in error to /etc/bash_completion.d/
  (LP: #249452)
* New upstream release.
* New upstream release
* New upstream release.
* Bump standards version.
* Include patch for inventory root revision copy, required for bzr-svn.
* New upstream release.
* Remove unused lintian overrides.
* Correct the package version not to be native.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Final 1.5 release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add myself as a co-maintainer.
* Add a Dm-Upload-Allowed: yes header.
* New upstream bugfix release.
* New upstream release.
* Final 1.3 release.
* New upstream release.
* First release candidate of the upcoming 1.3 release.
* Rebuild to fix the problem caused by a build with a broken python-central.
* New upstream release.
* Rebuild for dapper PPA.
* Apply Lamont's patches to fix build-dependencies on dapper.
  (See: https://bugs.launchpad.net/bzr/+bug/189915)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/stacked.txt
 
1
Using stacked branches
 
2
======================
 
3
 
 
4
What is a stacked branch?
 
5
-------------------------
 
6
 
 
7
A stacked branch is a branch that knows how to find revisions
 
8
in another branch. Stacked branches store just the
 
9
unique revisions, making them faster to create and more
 
10
storage efficient. In these respects, stacked branches are
 
11
similar to shared repositories. However, stacked branches have
 
12
additional benefits:
 
13
 
 
14
* The new branch can be in a completely different location to the
 
15
  branch being stacked on.
 
16
 
 
17
* Deleting the stacked branch really deletes the revisions (rather
 
18
  than leaving them in a shared repository).
 
19
 
 
20
* Security is improved over shared repositories, because the stacked-on
 
21
  repository can be physically readonly to developers committing to stacked
 
22
  branches.
 
23
 
 
24
These benefits make stacked branches ideal for various scenarios
 
25
including experimental branches and code hosting sites.
 
26
 
 
27
 
 
28
Creating a stacked branch
 
29
-------------------------
 
30
 
 
31
To create a stacked branch, use the ``stacked`` option of the branch command.
 
32
For example::
 
33
 
 
34
  bzr branch --stacked source-url my-dir
 
35
 
 
36
This will create ``my-dir`` as a stacked branch with no local revisions.
 
37
If it is defined, the public branch associated with ``source-url`` will be
 
38
used as the *stacked-on* location. Otherwise, ``source-url`` will be the
 
39
*stacked-on* location.
 
40
 
 
41
 
 
42
Creating a stacked checkout
 
43
---------------------------
 
44
 
 
45
Direct creation of a stacked checkout is expected to be supported soon.
 
46
In the meantime, a two step process is required:
 
47
 
 
48
1. Create a stacked branch as shown above.
 
49
 
 
50
2. Convert the branch into a checkout using either the ``reconfigure``
 
51
   or ``bind`` command.
 
52
 
 
53
 
 
54
Pushing a stacked branch
 
55
------------------------
 
56
 
 
57
Most changes on most projects build on an existing branch such as the
 
58
*development trunk* or *current stable* branch. Creating a new
 
59
branch stacked on one of these is easy to do using the ``push``
 
60
command like this::
 
61
 
 
62
  bzr push --stacked-on reference-url my-url
 
63
 
 
64
This creates a new branch at ``my-url`` that is stacked on ``reference-url``
 
65
and only contains the revisions in the current branch that are not already
 
66
in the branch at ``reference-url``.
 
67
 
 
68
 
 
69
.. The following text is hidden because bug 375013 breaks the example.
 
70
   When bug 375013 is fixed, we should unhide this text.
 
71
      - Andrew Bennetts, 10 March 2010
 
72
 
 
73
.. If the local branch was created as a stacked branch, then you can
 
74
.. use the ``--stacked`` option to ``push`` and the *stacked-on* location
 
75
.. will be implicit. For example::
 
76
.. 
 
77
..   bzr branch --stacked source-url my-dir
 
78
..   cd my-dir
 
79
..   (hack, hack, hack)
 
80
..   bzr commit -m "fix bug"
 
81
..   bzr push --stacked
 
82
 
 
83
 
 
84
Limitations of stacked branches
 
85
-------------------------------
 
86
 
 
87
Currently, you cannot commit to a stacked branch, due to `bug 375013`_.
 
88
 
 
89
.. _bug 375013: https://bugs.launchpad.net/bzr/+bug/375013
 
90
 
 
91
The important thing to remember about a stacked branch is that the
 
92
stacked-on branch needs to be available for almost all operations. This is
 
93
not an issue when both branches are local or both branches are on the
 
94
same server.
 
95
 
 
96
Similarly, because most of the history is stored in the stacked-on repository,
 
97
operations like ``bzr log`` can be slower when the stacked-on repository is
 
98
accessed via a network.
 
99
 
 
100
 
 
101
Changing branch stacking
 
102
------------------------
 
103
 
 
104
Stacking of existing branches can be changed using the ``bzr reconfigure``
 
105
command to either stack on an existing branch, or to turn off stacking.
 
106
Be aware that when ``bzr reconfigure --unstacked`` is used, bzr will
 
107
copy all the referenced data from the stacked-on repository into the
 
108
previously stacked repository.  For large repositories this may take
 
109
considerable time and may substantially increase the size of the
 
110
repository.