Merge lp:~lifeless/bzr/docs into lp:bzr

Proposed by Robert Collins
Status: Merged
Merged at revision: not available
Proposed branch: lp:~lifeless/bzr/docs
Merge into: lp:bzr
Diff against target: None lines
To merge this branch: bzr merge lp:~lifeless/bzr/docs
Reviewer Review Type Date Requested Status
Martin Pool Approve
Review via email: mp+11284@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Robert Collins (lifeless) wrote :

Update docs for milestones to be a little tighter on language, and remove the inconsistency between 'starting a cycle' and 'doing a release'. Also document the right location for trunk in demo code and rm guidelines.

Revision history for this message
Martin Pool (mbp) wrote :

'targeted' has two 't's, not three.

+ updating this if you don't immediately know : its not critical that it be

no space before colons in English.

137 + public_branch = http://bazaar.example.com/prepare-x.y

Maybe we should suggest putting it on Launchpad, because then we can also show the use of append_path etc.

review: Approve
Revision history for this message
Vincent Ladeuil (vila) wrote :

>>>>> "robert" == Robert Collins <email address hidden> writes:

<snip/>

    robert> -#. Go to the series web page at <https://launchpad.net/bzr/2.0>
    robert> +#. Go to the series web page at <https://launchpad.net/bzr/x.y>

I didn't modify that because I wanted them to be working URLs for
the RM. I searched a bit how to use a variable to have a single
place to modify and have them all updated, but ReST is limited in
that regard.

But at least having them pointing at the previous release means
the RM only have to edit the URL while looking at existing
pages...

None of these links do anything harmful without a confirmation (I
checked).

  Vincent

Revision history for this message
Robert Collins (lifeless) wrote :

> >>>>> "robert" == Robert Collins <email address hidden> writes:
>
> <snip/>
>
> robert> -#. Go to the series web page at <https://launchpad.net/bzr/2.0>
> robert> +#. Go to the series web page at <https://launchpad.net/bzr/x.y>
>
> I didn't modify that because I wanted them to be working URLs for
> the RM. I searched a bit how to use a variable to have a single
> place to modify and have them all updated, but ReST is limited in
> that regard.

They will have to be updated a lot; surely its easier to just accurately describe how the system works. Otherwise, its unclear /which/ urls should be edited by the RM, and which should be used verbatim.

Remember that we have N concurrent series running now.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'doc/developers/bug-handling.txt'
--- doc/developers/bug-handling.txt 2009-08-24 20:16:15 +0000
+++ doc/developers/bug-handling.txt 2009-09-07 03:08:30 +0000
@@ -157,10 +157,17 @@
157 A fix for this bug exists in a branch somewhere. Ideally the bug will157 A fix for this bug exists in a branch somewhere. Ideally the bug will
158 be linked to the branch.158 be linked to the branch.
159Fix Released159Fix Released
160 The fix for this bug is now in the bzr trunk. It's not necessarily160 The fix for this bug is now in the bzr branch that this task is for.
161 true that it's released yet, but it will be in the next release. The161 The branch for the default task on a bug is bzr.dev. We use this value
162 bug target milestone should be set to the release it went into, but162 even though the fix may not have been been included in a release yet
163 don't spend too much time updating this if you don't immediately know.163 because all the developer activity around it is complete and we want to
164 both avoid bug spam when releases happen, and keep the list of bugs that
165 developers see when they look at the bug tracker trimmed to those that
166 require action. When setting a bug task to fix released, the bug target
167 milestone should be set to the release the fix will be included in (or
168 was included in, if you are updating an old bug). Don't spend too much time
169 updating this if you don't immediately know : its not critical that it be
170 set.
164171
165172
166Bug Importance173Bug Importance
@@ -204,16 +211,14 @@
204***************211***************
205212
206It's possible to target a bug to a milestone, eg213It's possible to target a bug to a milestone, eg
207<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>. We use this mostly214<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>. We use this to help the
208to help the release manager know what **must** be merged to make the215release manager know what **must** be merged to make the release.
209release.
210216
211Therefore, we don't target bugs that we'd like to have fixed or that could217Therefore, we don't target bugs that we'd like to have fixed or that could
212be fixed in a particular release, we only target bugs that must be fixed218be fixed in a particular release, we only target bugs that must be fixed
213and that will or might cause us to decide to slip the release if they're219and that will cause us to slip the release if they're not fixed. At any time,
214not fixed. At any time, very few if any of the bugs targetted to a220very few if any of the bugs targetted to a release should be still open. By
215release should be still open. By definition, these bugs should normally221definition, these bugs should normally be Critical priority.
216be Critical priority.
217222
218223
219Backports224Backports
@@ -224,8 +229,10 @@
224represent this, create a new bug task (ie link in the status table on the229represent this, create a new bug task (ie link in the status table on the
225bug page) by clicking the `poorly-named230bug page) by clicking the `poorly-named
226<https://bugs.launchpad.net/bugs/132733>`_ "Target to Release" link.231<https://bugs.launchpad.net/bugs/132733>`_ "Target to Release" link.
227Target it to the appropriate series (ie 1.15) and then to the milestone232Target it to the appropriate series (ie 1.15). If the bug should also
228within that release. 233prevent any point releases of that series then you should also target the
234new task to the appropriate milestone within that release. (See Targeting Bugs
235above)
229236
230This bug task then has a separate status and importance to indicate the237This bug task then has a separate status and importance to indicate the
231separate work to get it into that release.238separate work to get it into that release.
232239
=== modified file 'doc/developers/integration.txt'
--- doc/developers/integration.txt 2008-04-08 10:55:41 +0000
+++ doc/developers/integration.txt 2009-09-07 03:16:28 +0000
@@ -197,7 +197,7 @@
197197
198 from bzrlib import branch198 from bzrlib import branch
199199
200 b = branch.Branch.open('http://bazaar-vcs.org/bzr/bzr.dev')200 b = branch.Branch.open('http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev')
201 nb = b.bzrdir.sprout('/tmp/newBzrBranch').open_branch()201 nb = b.bzrdir.sprout('/tmp/newBzrBranch').open_branch()
202202
203203
@@ -213,7 +213,7 @@
213 from bzrlib import branch213 from bzrlib import branch
214214
215 b1 = branch.Branch.open('file:///home/user/mybranch')215 b1 = branch.Branch.open('file:///home/user/mybranch')
216 b2 = branch.Branch.open('http://bazaar-vcs.org/bzr/bzr.dev')216 b2 = branch.Branch.open('http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev')
217 b1.push(b2)217 b1.push(b2)
218218
219219
220220
=== modified file 'doc/developers/releasing.txt'
--- doc/developers/releasing.txt 2009-08-30 21:34:42 +0000
+++ doc/developers/releasing.txt 2009-09-07 03:16:28 +0000
@@ -26,10 +26,10 @@
26#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one26#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
27 series for every *x.y* release.27 series for every *x.y* release.
2828
29#. Go to the series web page at <https://launchpad.net/bzr/2.0>29#. Go to the series web page at <https://launchpad.net/bzr/x.y>
3030
31#. Create a new release at31#. Create a new release at
32 <https://launchpad.net/bzr/2.0/+addrelease> and add32 <https://launchpad.net/bzr/x.y/+addrelease> and add
33 information about this release. We will not use it yet, but it33 information about this release. We will not use it yet, but it
34 will be available for targeting or nominating bugs.34 will be available for targeting or nominating bugs.
3535
@@ -39,7 +39,7 @@
39 general development continues on the trunk, and only39 general development continues on the trunk, and only
40 specifically-targeted fixes go into the release branch.40 specifically-targeted fixes go into the release branch.
4141
42#. Add milestones at <https://edge.launchpad.net/bzr/2.0/+addmilestone> to42#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
43 that series for the beta release, release candidate and the final release,43 that series for the beta release, release candidate and the final release,
44 and their expected dates.44 and their expected dates.
4545
@@ -58,10 +58,8 @@
5858
59When it's time to make the first beta release or release candidate:59When it's time to make the first beta release or release candidate:
6060
61#. Create a new milestone at <https://launchpad.net/bzr/2.0/+addmilestone>61#. Make a beta release or release candidate. The milestone for this
62 for the beta release or release candidate.62 candidate will already exist (see Starting a cycle above).
63
64#. Make a beta release or release candidate.
6563
66Preparing the tree for release64Preparing the tree for release
67------------------------------65------------------------------
@@ -71,13 +69,14 @@
7169
72 bzr branch trunk prepare-1.1470 bzr branch trunk prepare-1.14
7371
74#. Configure pqm-submit for this branch, with a section like this in72#. Configure pqm-submit for this branch, with a section like this (where
73 x.y is the version to release).
75 ``~/.bazaar/locations.conf``::74 ``~/.bazaar/locations.conf``::
7675
77 [/home/mbp/bzr/prepare-1.14]76 [/home/mbp/bzr/prepare-x.y]
78 pqm_email = Canonical PQM <pqm@bazaar-vcs.org>77 pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
79 submit_branch = lp:bzr/2.078 submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
80 public_branch = http://bazaar.example.com/prepare-2.079 public_branch = http://bazaar.example.com/prepare-x.y
81 submit_to = bazaar@lists.canonical.com80 submit_to = bazaar@lists.canonical.com
82 smtp_server = mail.example.com:2581 smtp_server = mail.example.com:25
8382