1
=== modified file '__init__.py'
2
--- __init__.py	2009-11-18 04:32:40 +0000
3
+++ __init__.py	2009-11-20 06:45:22 +0000
4
@@ -17,24 +17,36 @@
5
17
17
6
18
"""Manage a series of branches as a pipeline.
18
"""Manage a series of branches as a pipeline.
7
19
19
26
20
Provides the following commands:
20
Here is a summary of the commands added.
27
21
- reconfigure-pipeline
21
28
22
- add-pipe
22
====================    =======================================================
29
23
- remove-pipe
23
Command                 Description
30
24
- switch-pipe
24
====================    =======================================================
31
25
- show-pipeline
25
reconfigure-pipeline    Reconfigure a tree with branch into a lightweight
32
26
- pump
26
                        checkout
33
27
- sync-pipeline
27
add-pipe                Add a pipe to the pipeline
34
28
28
remove-pipe             Remove a pipe from the pipeline
35
29
It also extends "merge --uncommitted" to work with pipes.
29
switch-pipe             Switch from one pipe to another
36
30
30
show-pipeline           Show the current pipeline
37
31
To get started, create a branch and lightweight checkout:
31
pump                    From this pipe onward, merge all pipes into their next
38
32
bzr init pipe1
32
                        pipe and commit
39
33
bzr checkout --lightweight pipe1 tree
33
sync-pipeline           Synchronise the contents of this pipeline with another
40
34
cd tree
34
                        copy
41
35
commit -m "first commit"
35
pipe-patches            Export the pipeline as a collection of patches,
42
36
bzr add-pipe pipe2
36
                        one per pipe
43
37
bzr show-pipeline
37
lp-submit               Submit the specified pipe to Launchpad
44
38
====================    =======================================================
45
39
46
40
It also extends `merge --uncommitted` to work with pipes.
47
41
48
42
To get started, create a branch and lightweight checkout::
49
43
50
44
  bzr init pipe1
51
45
  bzr checkout --lightweight pipe1 tree
52
46
  cd tree
53
47
  commit -m "first commit"
54
48
  bzr add-pipe pipe2
55
49
  bzr show-pipeline
56
38
50
57
39
If you have an existing tree that you wish to start using as a pipeline,
51
If you have an existing tree that you wish to start using as a pipeline,
58
40
use `reconfigure-pipeline` to convert it.
52
use `reconfigure-pipeline` to convert it.
59
@@ -45,43 +57,46 @@
60
45
several related tasks without committing.
57
several related tasks without committing.
61
46
58
62
47
The pump command merges and commits changes along the pipeline, starting
59
The pump command merges and commits changes along the pipeline, starting
72
48
with the current pipe.  For example:
60
with the current pipe.  For example::
73
49
61
74
50
bzr add-pipe next
62
  bzr add-pipe next
75
51
echo "hello" > new
63
  echo "hello" > new
76
52
bzr add
64
  bzr add
77
53
bzr commit -m "Added file new"
65
  bzr commit -m "Added file new"
78
54
bzr pump
66
  bzr pump
79
55
67
80
56
This will commit a revision to the pipe named "next" that adds the file "new"
68
This will commit a revision to the pipe named "next" that adds the file "new".
81
57
69
82
58
Each pipe is identified by its branch nick.  The location of each pipe is
70
Each pipe is identified by its branch nick.  The location of each pipe is
83
59
provided as a location alias, which consists of ":pipe:" followed by its nick.
71
provided as a location alias, which consists of ":pipe:" followed by its nick.
85
60
So, to switch to pipe named "my-new" using the standard switch command:
72
So, to switch to pipe named "my-new" using the standard switch command::
86
61
73
88
62
bzr switch :pipe:my-new
74
  bzr switch :pipe:my-new
89
63
75
90
64
The aliases :prev: and :next: refer to the pipe before and after the current
76
The aliases :prev: and :next: refer to the pipe before and after the current
92
65
pipe, respectively.  So to see the changes added in this pipe:
77
pipe, respectively.  So to see the changes added in this pipe::
93
66
78
95
67
bzr diff -rancestor::prev
79
  bzr diff -rancestor::prev
96
68
80
97
69
These aliases work virtually everywhere you can specify a branch.  Since pipes
81
These aliases work virtually everywhere you can specify a branch.  Since pipes
98
70
are branches, you can do anything with them that you could do with a branch.
82
are branches, you can do anything with them that you could do with a branch.
99
71
83
113
72
You might find the following command aliases useful:
84
You might find the following command aliases useful::
114
73
85
115
74
# Show diff of changes originated in this pipe
86
  # Show diff of changes originated in this pipe
116
75
pdiff = bzr diff -r ancestor::prev
87
  pdiff = bzr diff -r ancestor::prev
117
76
88
118
77
# Show status for changes originated in this pipe
89
  # Show status for changes originated in this pipe
119
78
pstatus = status --short -r branch::prev
90
  pstatus = status --short -r branch::prev
120
79
91
121
80
# Submit the changes originated in this pipe for merging
92
  # Submit the changes originated in this pipe for merging
122
81
psend = send -r ancestor::prev..
93
  psend = send -r ancestor::prev..
123
82
94
124
83
# Show commits which have not been pumped into the next pipe yet.
95
  # Show commits which have not been pumped into the next pipe yet.
125
84
unpumped = missing --mine :next
96
  unpumped = missing --mine :next
126
97
127
98
For more information on bzr-pipeline, see the home page:
128
99
http://bazaar-vcs.org/BzrPipeline.
129
85
"""
100
"""
130
86
101
131
87
102
132
88
103
133
=== modified file 'commands.py'
134
--- commands.py	2009-11-17 22:08:33 +0000
135
+++ commands.py	2009-11-20 06:45:22 +0000
136
@@ -231,10 +231,10 @@
137
231
    """Show the current pipeline.
231
    """Show the current pipeline.
138
232
232
139
233
    All pipes are listed with the beginning of the pipeline at the top and the
233
    All pipes are listed with the beginning of the pipeline at the top and the
141
234
    end of the pipeline at the bottom.
234
    end of the pipeline at the bottom. These indicators are used::
142
235
235
145
236
    * - The current pipe.
236
      * - The current pipe.
146
237
    U - A pipe holding uncommitted changes.
237
      U - A pipe holding uncommitted changes.
147
238
238
148
239
    Uncommitted changes are automatically restored by the 'switch-pipe'
239
    Uncommitted changes are automatically restored by the 'switch-pipe'
149
240
    command.
240
    command.
150
@@ -364,8 +364,9 @@
151
364
    takes_options = [Option('staging',
364
    takes_options = [Option('staging',
152
365
                            help='Propose the merge on staging.'),
365
                            help='Propose the merge on staging.'),
153
366
                     Option('message', short_name='m', type=unicode,
366
                     Option('message', short_name='m', type=unicode,
156
367
                            help='Commit message'),
367
                            help='Commit message.'),
157
368
                     ListOption('review', short_name='R', type=unicode)]
368
                     ListOption('review', short_name='R', type=unicode,
158
369
                            help='Requested reviewer and optional type.')]
159
369
370
160
370
    takes_args = ['submit_branch?']
371
    takes_args = ['submit_branch?']
161
371
372
Status:	Merged
Approved by:	Aaron Bentley on 2009-11-20
Approved revision:	139
Merged at revision:	not available
Proposed branch:	lp://staging/~ian-clatworthy/bzr-pipeline/better-help-for-plugins-guide
Merge into:	lp://staging/bzr-pipeline
Diff against target:	160 lines (+65/-49) 2 files modified __init__.py (+59/-44) commands.py (+6/-5)
To merge this branch:	bzr merge lp://staging/~ian-clatworthy/bzr-pipeline/better-help-for-plugins-guide
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Aaron Bentley		2009-11-20	Approve on 2009-11-20
Review via email: mp+15077@code.staging.launchpad.net
1	=== modified file '__init__.py'
2	--- __init__.py 2009-11-18 04:32:40 +0000
3	+++ __init__.py 2009-11-20 06:45:22 +0000
4	@@ -17,24 +17,36 @@
5	17		17
6	18	"""Manage a series of branches as a pipeline.	18	"""Manage a series of branches as a pipeline.
7	19		19
26	20	Provides the following commands:	20	Here is a summary of the commands added.
27	21	- reconfigure-pipeline	21
28	22	- add-pipe	22	==================== =======================================================
29	23	- remove-pipe	23	Command Description
30	24	- switch-pipe	24	==================== =======================================================
31	25	- show-pipeline	25	reconfigure-pipeline Reconfigure a tree with branch into a lightweight
32	26	- pump	26	checkout
33	27	- sync-pipeline	27	add-pipe Add a pipe to the pipeline
34	28		28	remove-pipe Remove a pipe from the pipeline
35	29	It also extends "merge --uncommitted" to work with pipes.	29	switch-pipe Switch from one pipe to another
36	30		30	show-pipeline Show the current pipeline
37	31	To get started, create a branch and lightweight checkout:	31	pump From this pipe onward, merge all pipes into their next
38	32	bzr init pipe1	32	pipe and commit
39	33	bzr checkout --lightweight pipe1 tree	33	sync-pipeline Synchronise the contents of this pipeline with another
40	34	cd tree	34	copy
41	35	commit -m "first commit"	35	pipe-patches Export the pipeline as a collection of patches,
42	36	bzr add-pipe pipe2	36	one per pipe
43	37	bzr show-pipeline	37	lp-submit Submit the specified pipe to Launchpad
44			38	==================== =======================================================
45			39
46			40	It also extends `merge --uncommitted` to work with pipes.
47			41
48			42	To get started, create a branch and lightweight checkout::
49			43
50			44	bzr init pipe1
51			45	bzr checkout --lightweight pipe1 tree
52			46	cd tree
53			47	commit -m "first commit"
54			48	bzr add-pipe pipe2
55			49	bzr show-pipeline
56	38		50
57	39	If you have an existing tree that you wish to start using as a pipeline,	51	If you have an existing tree that you wish to start using as a pipeline,
58	40	use `reconfigure-pipeline` to convert it.	52	use `reconfigure-pipeline` to convert it.
59	@@ -45,43 +57,46 @@
60	45	several related tasks without committing.	57	several related tasks without committing.
61	46		58
62	47	The pump command merges and commits changes along the pipeline, starting	59	The pump command merges and commits changes along the pipeline, starting
72	48	with the current pipe. For example:	60	with the current pipe. For example::
73	49		61
74	50	bzr add-pipe next	62	bzr add-pipe next
75	51	echo "hello" > new	63	echo "hello" > new
76	52	bzr add	64	bzr add
77	53	bzr commit -m "Added file new"	65	bzr commit -m "Added file new"
78	54	bzr pump	66	bzr pump
79	55		67
80	56	This will commit a revision to the pipe named "next" that adds the file "new"	68	This will commit a revision to the pipe named "next" that adds the file "new".
81	57		69
82	58	Each pipe is identified by its branch nick. The location of each pipe is	70	Each pipe is identified by its branch nick. The location of each pipe is
83	59	provided as a location alias, which consists of ":pipe:" followed by its nick.	71	provided as a location alias, which consists of ":pipe:" followed by its nick.
85	60	So, to switch to pipe named "my-new" using the standard switch command:	72	So, to switch to pipe named "my-new" using the standard switch command::
86	61		73
88	62	bzr switch :pipe:my-new	74	bzr switch :pipe:my-new
89	63		75
90	64	The aliases :prev: and :next: refer to the pipe before and after the current	76	The aliases :prev: and :next: refer to the pipe before and after the current
92	65	pipe, respectively. So to see the changes added in this pipe:	77	pipe, respectively. So to see the changes added in this pipe::
93	66		78
95	67	bzr diff -rancestor::prev	79	bzr diff -rancestor::prev
96	68		80
97	69	These aliases work virtually everywhere you can specify a branch. Since pipes	81	These aliases work virtually everywhere you can specify a branch. Since pipes
98	70	are branches, you can do anything with them that you could do with a branch.	82	are branches, you can do anything with them that you could do with a branch.
99	71		83
113	72	You might find the following command aliases useful:	84	You might find the following command aliases useful::
114	73		85
115	74	# Show diff of changes originated in this pipe	86	# Show diff of changes originated in this pipe
116	75	pdiff = bzr diff -r ancestor::prev	87	pdiff = bzr diff -r ancestor::prev
117	76		88
118	77	# Show status for changes originated in this pipe	89	# Show status for changes originated in this pipe
119	78	pstatus = status --short -r branch::prev	90	pstatus = status --short -r branch::prev
120	79		91
121	80	# Submit the changes originated in this pipe for merging	92	# Submit the changes originated in this pipe for merging
122	81	psend = send -r ancestor::prev..	93	psend = send -r ancestor::prev..
123	82		94
124	83	# Show commits which have not been pumped into the next pipe yet.	95	# Show commits which have not been pumped into the next pipe yet.
125	84	unpumped = missing --mine :next	96	unpumped = missing --mine :next
126			97
127			98	For more information on bzr-pipeline, see the home page:
128			99	http://bazaar-vcs.org/BzrPipeline.
129	85	"""	100	"""
130	86		101
131	87		102
132	88		103
133	=== modified file 'commands.py'
134	--- commands.py 2009-11-17 22:08:33 +0000
135	+++ commands.py 2009-11-20 06:45:22 +0000
136	@@ -231,10 +231,10 @@
137	231	"""Show the current pipeline.	231	"""Show the current pipeline.
138	232		232
139	233	All pipes are listed with the beginning of the pipeline at the top and the	233	All pipes are listed with the beginning of the pipeline at the top and the
141	234	end of the pipeline at the bottom.	234	end of the pipeline at the bottom. These indicators are used::
142	235		235
145	236	* - The current pipe.	236	* - The current pipe.
146	237	U - A pipe holding uncommitted changes.	237	U - A pipe holding uncommitted changes.
147	238		238
148	239	Uncommitted changes are automatically restored by the 'switch-pipe'	239	Uncommitted changes are automatically restored by the 'switch-pipe'
149	240	command.	240	command.
150	@@ -364,8 +364,9 @@
151	364	takes_options = [Option('staging',	364	takes_options = [Option('staging',
152	365	help='Propose the merge on staging.'),	365	help='Propose the merge on staging.'),
153	366	Option('message', short_name='m', type=unicode,	366	Option('message', short_name='m', type=unicode,
156	367	help='Commit message'),	367	help='Commit message.'),
157	368	ListOption('review', short_name='R', type=unicode)]	368	ListOption('review', short_name='R', type=unicode,
158			369	help='Requested reviewer and optional type.')]
159	369		370
160	370	takes_args = ['submit_branch?']	371	takes_args = ['submit_branch?']
161	371		372