Bazaar

Merge lp:~mbp/bzr/doc-old into lp:~bzr/bzr/trunk-old

  1. doc-old
  2. Merge into trunk-old
Proposed by Martin Pool
Status: Merged
Approved by: John A Meinel
Approved revision: no longer in the source branch.
Merged at revision: not available
Proposed branch: lp:~mbp/bzr/doc-old
Merge into: lp:~bzr/bzr/trunk-old
Diff against target: 182 lines
To merge this branch: bzr merge lp:~mbp/bzr/doc-old
Reviewer Review Type Date Requested Status
John A Meinel Needs Fixing
Vincent Ladeuil Needs Fixing
Review via email: mp+6199@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Martin Pool (mbp) wrote :

This updates the bzr developer guide to primarily recommend that people propose changes to bzr through Launchpad merge proposals.

This also fixes the historical artefact that the developer guide was stored in doc/developers/HACKING but built to doc/en/developer-guide/.

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

>>>>> martin wrote:

> === renamed file 'doc/developers/HACKING.txt' => 'doc/en/developer-guide/HACKING.txt'
> --- doc/developers/HACKING.txt 2009-03-28 10:10:14 +0000
> +++ doc/en/developer-guide/HACKING.txt 2009-05-05 07:17:43 +0000

> @@ -332,9 +303,102 @@
> * (your ideas here...)

> -Bundle Buggy and review outcomes
> -================================
> -
> +Reviews on Launchpad
> +====================
> +
> +From May 2009 on, we prefer people to propose code reviews through
> +Launchpad.
> +
> + * <https://launchpad.net/+tour/code-review>
> +
> + * <https://help.launchpad.net/Code/Review>
> +
> +Anyone can propose or comment on a merge propsal just by creating a
> +Launchpad account.

s/propsal/proposal/

BB:tweak ? (how do we do that by mail now ?)

review: Needs Fixing
Revision history for this message
John A Meinel (jameinel) wrote :

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

Vincent Ladeuil wrote:
> Review: Needs Fixing
>>>>>> martin wrote:
>
>> === renamed file 'doc/developers/HACKING.txt' => 'doc/en/developer-guide/HACKING.txt'
>> --- doc/developers/HACKING.txt 2009-03-28 10:10:14 +0000
>> +++ doc/en/developer-guide/HACKING.txt 2009-05-05 07:17:43 +0000
>
>> @@ -332,9 +303,102 @@
>> * (your ideas here...)
>
>
>> -Bundle Buggy and review outcomes
>> -================================
>> -
>> +Reviews on Launchpad
>> +====================
>> +
>> +From May 2009 on, we prefer people to propose code reviews through
>> +Launchpad.
>> +
>> + * <https://launchpad.net/+tour/code-review>
>> +
>> + * <https://help.launchpad.net/Code/Review>
>> +
>> +Anyone can propose or comment on a merge propsal just by creating a
>> +Launchpad account.
>
> s/propsal/proposal/
>
> BB:tweak ? (how do we do that by mail now ?)
>

https://help.launchpad.net/Code/Review

 review needs-fixing
 status approve

John
=:->

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

iEYEARECAAYFAkoAPPkACgkQJdeBCYSNAAMWcwCff8b2Qn8aAgZRV1xgw6hwI3q0
Z2EAoMPhlw3nx7utufPSZiVBhdg80JOK
=Y/ct
-----END PGP SIGNATURE-----

review: Needs Fixing

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'Makefile'
--- Makefile 2009-03-25 18:48:15 +0000
+++ Makefile 2009-05-08 23:35:31 +0000
@@ -84,12 +84,12 @@
84# translate txt docs to html84# translate txt docs to html
85derived_txt_files := \85derived_txt_files := \
86 doc/en/user-reference/bzr_man.txt \86 doc/en/user-reference/bzr_man.txt \
87 doc/en/developer-guide/HACKING.txt \
88 doc/en/release-notes/NEWS.txt87 doc/en/release-notes/NEWS.txt
89txt_files := $(wildcard doc/en/tutorials/*.txt) \88txt_files := $(wildcard doc/en/tutorials/*.txt) \
90 $(derived_txt_files) \89 $(derived_txt_files) \
91 doc/en/user-guide/index.txt \90 doc/en/user-guide/index.txt \
92 doc/en/mini-tutorial/index.txt \91 doc/en/mini-tutorial/index.txt \
92 doc/en/developer-guide/HACKING.txt \
93 $(wildcard doc/es/guia-usario/*.txt) \93 $(wildcard doc/es/guia-usario/*.txt) \
94 doc/es/mini-tutorial/index.txt \94 doc/es/mini-tutorial/index.txt \
95 doc/index.txt \95 doc/index.txt \
@@ -181,9 +181,6 @@
181doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)181doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
182 $(PYTHON) generate_docs.py -o $@ rstx182 $(PYTHON) generate_docs.py -o $@ rstx
183183
184doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
185 $(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
186
187doc/en/release-notes/NEWS.txt: NEWS184doc/en/release-notes/NEWS.txt: NEWS
188 $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"185 $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
189186
190187
=== renamed file 'doc/developers/HACKING.txt' => 'doc/en/developer-guide/HACKING.txt'
--- doc/developers/HACKING.txt 2009-03-28 10:10:14 +0000
+++ doc/en/developer-guide/HACKING.txt 2009-05-08 23:35:31 +0000
@@ -12,7 +12,7 @@
12document, send a merge request or new text to the mailing list.12document, send a merge request or new text to the mailing list.
1313
14The current version of this document is available in the file 14The current version of this document is available in the file
15``doc/developers/HACKING.txt`` in the source tree, or at15``doc/en/developer-guide/HACKING.txt`` in the source tree, or at
16http://doc.bazaar-vcs.org/bzr.dev/en/developer-guide/HACKING.html16http://doc.bazaar-vcs.org/bzr.dev/en/developer-guide/HACKING.html
1717
18See also:18See also:
@@ -209,35 +209,6 @@
209209
210210
211211
212Sending patches for review
213==========================
214
215If you'd like to propose a change, please post to the
216bazaar@lists.canonical.com list with a bundle, patch, or link to a
217branch. Put ``[PATCH]`` or ``[MERGE]`` in the subject so Bundle Buggy
218can pick it out, and explain the change in the email message text.
219Remember to update the NEWS file as part of your change if it makes any
220changes visible to users or plugin developers. Please include a diff
221against mainline if you're giving a link to a branch.
222
223You can generate a merge request like this::
224
225 bzr send -o bug-1234.patch
226
227A ``.patch`` extension is recommended instead of .bundle as many mail clients
228will send the latter as a binary file.
229
230``bzr send`` can also send mail directly if you prefer; see the help.
231
232Please do **NOT** put [PATCH] or [MERGE] in the subject line if you don't
233want it to be merged. If you want comments from developers rather than
234to be merged, you can put ``[RFC]`` in the subject line.
235
236If this change addresses a bug, please put the bug number in the subject
237line too, in the form ``[#1]`` so that Bundle Buggy can recognize it.
238
239If the change is intended for a particular release mark that in the
240subject too, e.g. ``[1.6]``.
241212
242213
243Review cover letters214Review cover letters
@@ -332,9 +303,102 @@
332* (your ideas here...)303* (your ideas here...)
333304
334305
335Bundle Buggy and review outcomes306Reviews on Launchpad
336================================307====================
337308
309From May 2009 on, we prefer people to propose code reviews through
310Launchpad.
311
312 * <https://launchpad.net/+tour/code-review>
313
314 * <https://help.launchpad.net/Code/Review>
315
316Anyone can propose or comment on a merge propsal just by creating a
317Launchpad account.
318
319There are two ways to create a new merge proposal: through the web
320interface or by email.
321
322
323Proposing a merge through the web
324---------------------------------
325
326To create the propsal through the web: push your branch to Launchpad, eg::
327
328 bzr push lp:~mbp/bzr/doc
329
330then go to the branch's web page, which in this case would be
331<https://code.launchpad.net/~mbp/bzr/doc>. You can automate that by just
332running ::
333
334 bzr lp-open
335
336You can then click "Propose for merging into another branch", and enter a
337cover letter into the web form. Typically you'll want to merge into
338``~bzr/bzr/trunk`` which will be the default; you might also want to
339nominate merging into a release branch for a bug fix. There is the option
340to specify a specific reviewer or type of review, and you shouldn't
341normally change those.
342
343Submitting the form takes you to the new page about the merge proposal
344containing the diff of the changes, comments by interested people, and
345controls to comment or vote on the change.
346
347Proposing a merge by mail
348-------------------------
349
350To propose a merge by mail, send a bundle to ``merge@code.launchpad.net``.
351
352You can generate a merge request like this::
353
354 bzr send -o bug-1234.diff
355
356``bzr send`` can also send mail directly if you prefer; see the help.
357
358Reviewing changes
359-----------------
360
361From <https://code.launchpad.net/bzr/+activereviews> you can see all
362currently active reviews, and choose one to comment on. This page also
363shows proposals that are now approved and should be merged by someone with
364PQM access.
365
366
367Reviews through Bundle Buggy
368============================
369
370The Bundle Buggy tool used up to May 2009 is still available as a review
371mechanism.
372
373Sending patches for review
374--------------------------
375
376If you'd like to propose a change, please post to the
377bazaar@lists.canonical.com list with a bundle, patch, or link to a
378branch. Put ``[PATCH]`` or ``[MERGE]`` in the subject so Bundle Buggy
379can pick it out, and explain the change in the email message text.
380Remember to update the NEWS file as part of your change if it makes any
381changes visible to users or plugin developers. Please include a diff
382against mainline if you're giving a link to a branch.
383
384You can generate a merge request like this::
385
386 bzr send -o bug-1234.patch
387
388A ``.patch`` extension is recommended instead of .bundle as many mail clients
389will send the latter as a binary file.
390
391``bzr send`` can also send mail directly if you prefer; see the help.
392
393Please do **NOT** put [PATCH] or [MERGE] in the subject line if you don't
394want it to be merged. If you want comments from developers rather than
395to be merged, you can put ``[RFC]`` in the subject line.
396
397If this change addresses a bug, please put the bug number in the subject
398line too, in the form ``[#1]`` so that Bundle Buggy can recognize it.
399
400If the change is intended for a particular release mark that in the
401subject too, e.g. ``[1.6]``.
338Anyone can "vote" on the mailing list by expressing an opinion. Core402Anyone can "vote" on the mailing list by expressing an opinion. Core
339developers can also vote using Bundle Buggy. Here are the voting codes and403developers can also vote using Bundle Buggy. Here are the voting codes and
340their explanations.404their explanations.