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
1=== modified file 'doc/developers/bug-handling.txt'
2--- doc/developers/bug-handling.txt 2009-08-24 20:16:15 +0000
3+++ doc/developers/bug-handling.txt 2009-09-07 03:08:30 +0000
4@@ -157,10 +157,17 @@
5 A fix for this bug exists in a branch somewhere. Ideally the bug will
6 be linked to the branch.
7 Fix Released
8- The fix for this bug is now in the bzr trunk. It's not necessarily
9- true that it's released yet, but it will be in the next release. The
10- bug target milestone should be set to the release it went into, but
11- don't spend too much time updating this if you don't immediately know.
12+ The fix for this bug is now in the bzr branch that this task is for.
13+ The branch for the default task on a bug is bzr.dev. We use this value
14+ even though the fix may not have been been included in a release yet
15+ because all the developer activity around it is complete and we want to
16+ both avoid bug spam when releases happen, and keep the list of bugs that
17+ developers see when they look at the bug tracker trimmed to those that
18+ require action. When setting a bug task to fix released, the bug target
19+ milestone should be set to the release the fix will be included in (or
20+ was included in, if you are updating an old bug). Don't spend too much time
21+ updating this if you don't immediately know : its not critical that it be
22+ set.
23
24
25 Bug Importance
26@@ -204,16 +211,14 @@
27 ***************
28
29 It's possible to target a bug to a milestone, eg
30-<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>. We use this mostly
31-to help the release manager know what **must** be merged to make the
32-release.
33+<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>. We use this to help the
34+release manager know what **must** be merged to make the release.
35
36 Therefore, we don't target bugs that we'd like to have fixed or that could
37 be fixed in a particular release, we only target bugs that must be fixed
38-and that will or might cause us to decide to slip the release if they're
39-not fixed. At any time, very few if any of the bugs targetted to a
40-release should be still open. By definition, these bugs should normally
41-be Critical priority.
42+and that will cause us to slip the release if they're not fixed. At any time,
43+very few if any of the bugs targetted to a release should be still open. By
44+definition, these bugs should normally be Critical priority.
45
46
47 Backports
48@@ -224,8 +229,10 @@
49 represent this, create a new bug task (ie link in the status table on the
50 bug page) by clicking the `poorly-named
51 <https://bugs.launchpad.net/bugs/132733>`_ "Target to Release" link.
52-Target it to the appropriate series (ie 1.15) and then to the milestone
53-within that release.
54+Target it to the appropriate series (ie 1.15). If the bug should also
55+prevent any point releases of that series then you should also target the
56+new task to the appropriate milestone within that release. (See Targeting Bugs
57+above)
58
59 This bug task then has a separate status and importance to indicate the
60 separate work to get it into that release.
61
62=== modified file 'doc/developers/integration.txt'
63--- doc/developers/integration.txt 2008-04-08 10:55:41 +0000
64+++ doc/developers/integration.txt 2009-09-07 03:16:28 +0000
65@@ -197,7 +197,7 @@
66
67 from bzrlib import branch
68
69- b = branch.Branch.open('http://bazaar-vcs.org/bzr/bzr.dev')
70+ b = branch.Branch.open('http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev')
71 nb = b.bzrdir.sprout('/tmp/newBzrBranch').open_branch()
72
73
74@@ -213,7 +213,7 @@
75 from bzrlib import branch
76
77 b1 = branch.Branch.open('file:///home/user/mybranch')
78- b2 = branch.Branch.open('http://bazaar-vcs.org/bzr/bzr.dev')
79+ b2 = branch.Branch.open('http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev')
80 b1.push(b2)
81
82
83
84=== modified file 'doc/developers/releasing.txt'
85--- doc/developers/releasing.txt 2009-08-30 21:34:42 +0000
86+++ doc/developers/releasing.txt 2009-09-07 03:16:28 +0000
87@@ -26,10 +26,10 @@
88 #. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
89 series for every *x.y* release.
90
91-#. Go to the series web page at <https://launchpad.net/bzr/2.0>
92+#. Go to the series web page at <https://launchpad.net/bzr/x.y>
93
94 #. Create a new release at
95- <https://launchpad.net/bzr/2.0/+addrelease> and add
96+ <https://launchpad.net/bzr/x.y/+addrelease> and add
97 information about this release. We will not use it yet, but it
98 will be available for targeting or nominating bugs.
99
100@@ -39,7 +39,7 @@
101 general development continues on the trunk, and only
102 specifically-targeted fixes go into the release branch.
103
104-#. Add milestones at <https://edge.launchpad.net/bzr/2.0/+addmilestone> to
105+#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
106 that series for the beta release, release candidate and the final release,
107 and their expected dates.
108
109@@ -58,10 +58,8 @@
110
111 When it's time to make the first beta release or release candidate:
112
113-#. Create a new milestone at <https://launchpad.net/bzr/2.0/+addmilestone>
114- for the beta release or release candidate.
115-
116-#. Make a beta release or release candidate.
117+#. Make a beta release or release candidate. The milestone for this
118+ candidate will already exist (see Starting a cycle above).
119
120 Preparing the tree for release
121 ------------------------------
122@@ -71,13 +69,14 @@
123
124 bzr branch trunk prepare-1.14
125
126-#. Configure pqm-submit for this branch, with a section like this in
127+#. Configure pqm-submit for this branch, with a section like this (where
128+ x.y is the version to release).
129 ``~/.bazaar/locations.conf``::
130
131- [/home/mbp/bzr/prepare-1.14]
132+ [/home/mbp/bzr/prepare-x.y]
133 pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
134- submit_branch = lp:bzr/2.0
135- public_branch = http://bazaar.example.com/prepare-2.0
136+ submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
137+ public_branch = http://bazaar.example.com/prepare-x.y
138 submit_to = bazaar@lists.canonical.com
139 smtp_server = mail.example.com:25
140