1
=== modified file 'doc/en/user-guide/stacked.txt'
2
--- doc/en/user-guide/stacked.txt	2009-12-02 20:34:07 +0000
3
+++ doc/en/user-guide/stacked.txt	2010-03-18 23:18:20 +0000
4
@@ -1,15 +1,28 @@
5
1
Using stacked branches
1
Using stacked branches
6
2
======================
2
======================
7
3
3
8
4
Motivation
9
5
----------
10
6
11
7
If you are working on a project, and you have read access to whose
12
8
public repository but do not have write access to it, using stacked
13
9
branches to backup/publish your work onto the same host of the public
14
10
repository might be an option for you.
15
11
16
12
Other scenarios for stacked branch usage include experimental branches
17
13
and code hosting sites. For these scenarios, stacked branches are
18
14
ideal because of the benefits it provides.
19
15
20
16
21
4
What is a stacked branch?
17
What is a stacked branch?
22
5
-------------------------
18
-------------------------
23
6
19
30
7
A stacked branch is a branch that knows how to find revisions
20
A stacked branch is a branch that knows how to find revisions in
31
8
in another branch. Stacked branches store just the
21
another branch (the stacked-on branch). Stacked branches store just
32
9
unique revisions, making them faster to create and more
22
the unique revisions that are not in the stacked-on branch, making
33
10
storage efficient. In these respects, stacked branches are
23
them faster to create and more storage efficient. In these respects,
34
11
similar to shared repositories. However, stacked branches have
24
stacked branches are similar to shared repositories. However, stacked
35
12
additional benefits:
25
branches have additional benefits:
36
13
26
37
14
* The new branch can be in a completely different location to the
27
* The new branch can be in a completely different location to the
38
15
  branch being stacked on.
28
  branch being stacked on.
39
@@ -21,9 +34,6 @@
40
21
  repository can be physically readonly to developers committing to stacked
34
  repository can be physically readonly to developers committing to stacked
41
22
  branches.
35
  branches.
42
23
36
43
24
These benefits make stacked branches ideal for various scenarios
44
25
including experimental branches and code hosting sites.
45
26
46
27
37
47
28
Creating a stacked branch
38
Creating a stacked branch
48
29
-------------------------
39
-------------------------
49
@@ -63,7 +73,14 @@
50
63
73
51
64
This creates a new branch at ``my-url`` that is stacked on ``reference-url``
74
This creates a new branch at ``my-url`` that is stacked on ``reference-url``
52
65
and only contains the revisions in the current branch that are not already
75
and only contains the revisions in the current branch that are not already
54
66
in the branch at ``reference-url``.
76
in the branch at ``reference-url``. In particular, ``my-url`` and
55
77
``reference-url`` can be on the same host, and the ``--stacked`` option
56
78
can be used additionally to inform ``push`` to reference the
57
79
revisions in ``reference-url``. For example::
58
80
59
81
  bzr push --stacked-on sftp://host/project --stacked sftp://host/user/stacked-branch
60
82
61
83
This usage fits the scenario described in the Motivation section.
62
67
84
63
68
If the local branch was created as a stacked branch, then you can
85
If the local branch was created as a stacked branch, then you can
64
69
use the ``--stacked`` option to ``push`` and the *stacked-on* location
86
use the ``--stacked`` option to ``push`` and the *stacked-on* location
Status:	Merged
Approved by:	Martin Pool on 2010-03-22
Approved revision:	no longer in the source branch.
Merged at revision:	not available
Proposed branch:	lp:~mbp/bzr/doc-stacking
Merge into:	lp:bzr
Diff against target:	64 lines (+27/-10) 1 file modified doc/en/user-guide/stacked.txt (+27/-10)
To merge this branch:	bzr merge lp:~mbp/bzr/doc-stacking
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Andrew Bennetts			Approve on 2010-03-19
Martin Pool			Approve on 2010-03-19
Review via email: mp+21694@code.launchpad.net