bzr-pipeline

Merge lp://staging/~ian-clatworthy/bzr-pipeline/better-help-for-plugins-guide into lp://staging/bzr-pipeline

  1. better-help-for-plugins-guide
  2. Merge into trunk
Proposed by Ian Clatworthy
Status: Merged
Approved by: Aaron Bentley
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
Reviewer Review Type Date Requested Status
Aaron Bentley Approve
Review via email: mp+15077@code.staging.launchpad.net
To post a comment you must log in.
Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

This patches improves the formatting of the help generated for the Plugins Guide: http://doc.bazaar-vcs.org/plugins/en/pipeline-plugin.html.

Revision history for this message
Aaron Bentley (abentley) wrote :

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Ian Clatworthy wrote:

> This patches improves the formatting of the help generated for the Plugins Guide: http://doc.bazaar-vcs.org/plugins/en/pipeline-plugin.html.

 status approved

Thanks, taken. pipeline has a stable branch, lp:bzr-pipeline/stable,
and I'll apply these changes there also.

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAksGnKwACgkQ0F+nu1YWqI1hWgCePD8w2XTxwKyD1674W/kmb5+I
NsMAnjuvvhDgyJo6zp9aSTh5SCcslDcj
=vMTX
-----END PGP SIGNATURE-----

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
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
6 """Manage a series of branches as a pipeline.
7
8-Provides the following commands:
9-- reconfigure-pipeline
10-- add-pipe
11-- remove-pipe
12-- switch-pipe
13-- show-pipeline
14-- pump
15-- sync-pipeline
16-
17-It also extends "merge --uncommitted" to work with pipes.
18-
19-To get started, create a branch and lightweight checkout:
20-bzr init pipe1
21-bzr checkout --lightweight pipe1 tree
22-cd tree
23-commit -m "first commit"
24-bzr add-pipe pipe2
25-bzr show-pipeline
26+Here is a summary of the commands added.
27+
28+==================== =======================================================
29+Command Description
30+==================== =======================================================
31+reconfigure-pipeline Reconfigure a tree with branch into a lightweight
32+ checkout
33+add-pipe Add a pipe to the pipeline
34+remove-pipe Remove a pipe from the pipeline
35+switch-pipe Switch from one pipe to another
36+show-pipeline Show the current pipeline
37+pump From this pipe onward, merge all pipes into their next
38+ pipe and commit
39+sync-pipeline Synchronise the contents of this pipeline with another
40+ copy
41+pipe-patches Export the pipeline as a collection of patches,
42+ one per pipe
43+lp-submit Submit the specified pipe to Launchpad
44+==================== =======================================================
45+
46+It also extends `merge --uncommitted` to work with pipes.
47+
48+To get started, create a branch and lightweight checkout::
49+
50+ bzr init pipe1
51+ bzr checkout --lightweight pipe1 tree
52+ cd tree
53+ commit -m "first commit"
54+ bzr add-pipe pipe2
55+ bzr show-pipeline
56
57 If you have an existing tree that you wish to start using as a pipeline,
58 use `reconfigure-pipeline` to convert it.
59@@ -45,43 +57,46 @@
60 several related tasks without committing.
61
62 The pump command merges and commits changes along the pipeline, starting
63-with the current pipe. For example:
64-
65-bzr add-pipe next
66-echo "hello" > new
67-bzr add
68-bzr commit -m "Added file new"
69-bzr pump
70-
71-This will commit a revision to the pipe named "next" that adds the file "new"
72+with the current pipe. For example::
73+
74+ bzr add-pipe next
75+ echo "hello" > new
76+ bzr add
77+ bzr commit -m "Added file new"
78+ bzr pump
79+
80+This will commit a revision to the pipe named "next" that adds the file "new".
81
82 Each pipe is identified by its branch nick. The location of each pipe is
83 provided as a location alias, which consists of ":pipe:" followed by its nick.
84-So, to switch to pipe named "my-new" using the standard switch command:
85+So, to switch to pipe named "my-new" using the standard switch command::
86
87-bzr switch :pipe:my-new
88+ bzr switch :pipe:my-new
89
90 The aliases :prev: and :next: refer to the pipe before and after the current
91-pipe, respectively. So to see the changes added in this pipe:
92+pipe, respectively. So to see the changes added in this pipe::
93
94-bzr diff -rancestor::prev
95+ bzr diff -rancestor::prev
96
97 These aliases work virtually everywhere you can specify a branch. Since pipes
98 are branches, you can do anything with them that you could do with a branch.
99
100-You might find the following command aliases useful:
101-
102-# Show diff of changes originated in this pipe
103-pdiff = bzr diff -r ancestor::prev
104-
105-# Show status for changes originated in this pipe
106-pstatus = status --short -r branch::prev
107-
108-# Submit the changes originated in this pipe for merging
109-psend = send -r ancestor::prev..
110-
111-# Show commits which have not been pumped into the next pipe yet.
112-unpumped = missing --mine :next
113+You might find the following command aliases useful::
114+
115+ # Show diff of changes originated in this pipe
116+ pdiff = bzr diff -r ancestor::prev
117+
118+ # Show status for changes originated in this pipe
119+ pstatus = status --short -r branch::prev
120+
121+ # Submit the changes originated in this pipe for merging
122+ psend = send -r ancestor::prev..
123+
124+ # Show commits which have not been pumped into the next pipe yet.
125+ unpumped = missing --mine :next
126+
127+For more information on bzr-pipeline, see the home page:
128+http://bazaar-vcs.org/BzrPipeline.
129 """
130
131
132
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 """Show the current pipeline.
138
139 All pipes are listed with the beginning of the pipeline at the top and the
140- end of the pipeline at the bottom.
141+ end of the pipeline at the bottom. These indicators are used::
142
143- * - The current pipe.
144- U - A pipe holding uncommitted changes.
145+ * - The current pipe.
146+ U - A pipe holding uncommitted changes.
147
148 Uncommitted changes are automatically restored by the 'switch-pipe'
149 command.
150@@ -364,8 +364,9 @@
151 takes_options = [Option('staging',
152 help='Propose the merge on staging.'),
153 Option('message', short_name='m', type=unicode,
154- help='Commit message'),
155- ListOption('review', short_name='R', type=unicode)]
156+ help='Commit message.'),
157+ ListOption('review', short_name='R', type=unicode,
158+ help='Requested reviewer and optional type.')]
159
160 takes_args = ['submit_branch?']
161

Subscribers

People subscribed via source and target branches