/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Aaron Bentley
  • Date: 2009-05-11 19:11:14 UTC
  • mto: This revision was merged to the branch mainline in revision 4351.
  • Revision ID: aaron@aaronbentley.com-20090511191114-g0u190bdpfou9bbw
Gracefully handle mail clients that don't support bodies.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
Bazaar Developer Guide
3
3
======================
4
4
 
5
 
This document describes the Bazaar internals and the development process.
 
5
This document describes the Bazaar internals and the development process.  
6
6
It's meant for people interested in developing Bazaar, and some parts will
7
7
also be useful to people developing Bazaar plugins.
8
8
 
11
11
the Bazaar mailing list.  To propose a correction or addition to this
12
12
document, send a merge request or new text to the mailing list.
13
13
 
14
 
The latest developer documentation can be found online at
15
 
http://doc.bazaar.canonical.com/developers/.
 
14
The current version of this document is available in the file 
 
15
``doc/developers/HACKING.txt`` in the source tree, or at
 
16
http://doc.bazaar-vcs.org/bzr.dev/en/developer-guide/HACKING.html
 
17
 
 
18
See also:
 
19
`Bazaar Developer Documentation Catalog <../../developers/index.html>`_.
 
20
 
 
21
.. contents::
 
22
 
16
23
 
17
24
Getting Started
18
25
###############
28
35
To answer these questions and more, take a moment to explore the
29
36
overall Bazaar Platform. Here are some links to browse:
30
37
 
31
 
* The Plugins page on the Wiki - http://wiki.bazaar.canonical.com/BzrPlugins
 
38
* The Plugins page on the Wiki - http://bazaar-vcs.org/BzrPlugins
32
39
 
33
40
* The Bazaar product family on Launchpad - https://launchpad.net/bazaar
34
41
 
35
42
* Bug Tracker for the core product - https://bugs.launchpad.net/bzr/
36
43
 
 
44
* Blueprint Tracker for the core product - https://blueprints.launchpad.net/bzr/
 
45
 
37
46
If nothing else, perhaps you'll find inspiration in how other developers
38
47
have solved their challenges.
39
48
 
40
 
Finding Something To Do
41
 
=======================
42
 
 
43
 
Ad-hoc performance work can also be done. One useful tool is the 'evil' debug
44
 
flag. For instance running ``bzr -Devil commit -m "test"`` will log a backtrace
45
 
to the bzr log file for every method call which triggers a slow or non-scalable
46
 
part of the bzr library. So checking that a given command with ``-Devil`` has
47
 
no backtraces logged to the log file is a good way to find problem function
48
 
calls that might be nested deep in the code base.
49
49
 
50
50
Planning and Discussing Changes
51
51
===============================
52
52
 
53
53
There is a very active community around Bazaar. Mostly we meet on IRC
54
54
(#bzr on irc.freenode.net) and on the mailing list. To join the Bazaar
55
 
community, see http://wiki.bazaar.canonical.com/BzrSupport.
 
55
community, see http://bazaar-vcs.org/BzrSupport.
56
56
 
57
57
If you are planning to make a change, it's a very good idea to mention it
58
58
on the IRC channel and/or on the mailing list. There are many advantages
59
59
to involving the community before you spend much time on a change.
60
60
These include:
61
61
 
62
 
* you get to build on the wisdom of others, saving time
 
62
* you get to build on the wisdom on others, saving time
63
63
 
64
 
* if others can direct you to similar code, it minimises the work to be done
 
64
* if others can direct you to similar code, it minimises the work to be done 
65
65
 
66
66
* it assists everyone in coordinating direction, priorities and effort.
67
67
 
73
73
Bazaar Development in a Nutshell
74
74
================================
75
75
 
76
 
.. was from bazaar-vcs.org/BzrGivingBack
77
 
 
78
 
One of the fun things about working on a version control system like Bazaar is
79
 
that the users have a high level of proficiency in contributing back into
80
 
the tool.  Consider the following very brief introduction to contributing back
81
 
to Bazaar.  More detailed instructions are in the following sections.
82
 
 
83
 
Making the change
84
 
-----------------
85
 
 
86
 
First, get a local copy of the development mainline (See `Why make a local
87
 
copy of bzr.dev?`_.)
88
 
::
89
 
 
90
 
 $ bzr init-repo ~/bzr
91
 
 $ cd ~/bzr
92
 
 $ bzr branch http://bazaar-vcs.org/bzr/bzr.dev/ bzr.dev
93
 
 
94
 
Now make your own branch::
95
 
 
96
 
 $ bzr branch bzr.dev 123456-my-bugfix
97
 
 
98
 
This will give you a branch called "123456-my-bugfix" that you can work on
99
 
and commit in. Here, you can study the code, make a fix or a new feature.
100
 
Feel free to commit early and often (after all, it's your branch!).
101
 
 
102
 
Documentation improvements are an easy place to get started giving back to the
103
 
Bazaar project.  The documentation is in the `doc/` subdirectory of the Bazaar
104
 
source tree.
105
 
 
106
 
When you are done, make sure that you commit your last set of changes as well!
107
 
Once you are happy with your changes, ask for them to be merged, as described
108
 
below.
109
 
 
110
 
Making a Merge Proposal
111
 
-----------------------
112
 
 
113
 
The Bazaar developers use Launchpad to further enable a truly distributed
114
 
style of development.  Anyone can propose a branch for merging into the Bazaar
115
 
trunk.  To start this process, you need to push your branch to Launchpad.  To
116
 
do this, you will need a Launchpad account and user name, e.g.
117
 
`your_lp_username`.  You can push your branch to Launchpad directly from
118
 
Bazaar::
119
 
 
120
 
  $ bzr push lp:~your_lp_username/bzr/meaningful_name_here
121
 
 
122
 
After you have pushed your branch, you will need to propose it for merging to
123
 
the Bazaar trunk.  Go to
124
 
<https://launchpad.net/your_lp_username/bzr/meaningful_name_here> and choose
125
 
"Propose for merging into another branch".  Select "~bzr/bzr/trunk" to hand
126
 
your changes off to the Bazaar developers for review and merging.
127
 
 
128
 
Alternatively, after pushing you can use the ``lp-propose`` command to 
129
 
create the merge proposal.
130
 
 
131
 
Using a meaningful name for your branch will help you and the reviewer(s)
132
 
better track the submission. Use a very succint description of your submission
133
 
and prefix it with bug number if needed (lp:~mbp/bzr/484558-merge-directory
134
 
for example). Alternatively, you can suffix with the bug number
135
 
(lp:~jameinel/bzr/export-file-511987).
136
 
 
137
 
 
138
 
Review cover letters
139
 
--------------------
140
 
 
141
 
Please put a "cover letter" on your merge request explaining:
142
 
 
143
 
* the reason **why** you're making this change
144
 
 
145
 
* **how** this change achieves this purpose
146
 
 
147
 
* anything else you may have fixed in passing
148
 
 
149
 
* anything significant that you thought of doing, such as a more
150
 
  extensive fix or a different approach, but didn't or couldn't do now
151
 
 
152
 
A good cover letter makes reviewers' lives easier because they can decide
153
 
from the letter whether they agree with the purpose and approach, and then
154
 
assess whether the patch actually does what the cover letter says.
155
 
Explaining any "drive-by fixes" or roads not taken may also avoid queries
156
 
from the reviewer.  All in all this should give faster and better reviews.
157
 
Sometimes writing the cover letter helps the submitter realize something
158
 
else they need to do.  The size of the cover letter should be proportional
159
 
to the size and complexity of the patch.
160
 
 
161
 
 
162
 
Why make a local copy of bzr.dev?
163
 
---------------------------------
164
 
 
165
 
Making a local mirror of bzr.dev is not strictly necessary, but it means
166
 
 
167
 
- You can use that copy of bzr.dev as your main bzr executable, and keep it
168
 
  up-to-date using ``bzr pull``.
169
 
- Certain operations are faster, and can be done when offline.  For example:
170
 
 
171
 
  - ``bzr bundle``
172
 
  - ``bzr diff -r ancestor:...``
173
 
  - ``bzr merge``
174
 
 
175
 
- When it's time to create your next branch, it's more convenient.  When you
176
 
  have further contributions to make, you should do them in their own branch::
177
 
 
178
 
    $ cd ~/bzr
179
 
    $ bzr branch bzr.dev additional_fixes
180
 
    $ cd additional_fixes # hack, hack, hack
181
 
 
 
76
Looking for a 10 minute introduction to submitting a change?
 
77
See http://bazaar-vcs.org/BzrGivingBack.
 
78
 
 
79
TODO: Merge that Wiki page into this document.
182
80
 
183
81
 
184
82
Understanding the Development Process
201
99
 
202
100
* Launchpad - https://launchpad.net/
203
101
 
204
 
* Bazaar - http://bazaar.canonical.com/
 
102
* Bazaar - http://bazaar-vcs.org/
 
103
 
 
104
* Bundle Buggy - http://bundlebuggy.aaronbentley.com/
205
105
 
206
106
* Patch Queue Manager - https://launchpad.net/pqm/
207
107
 
208
 
For further information, see <http://wiki.bazaar.canonical.com/BzrDevelopment>.
 
108
For further information, see http://bazaar-vcs.org/BzrDevelopment.
209
109
 
210
110
 
211
111
 
214
114
================================================
215
115
 
216
116
Bazaar supports many ways of organising your work. See
217
 
http://wiki.bazaar.canonical.com/SharedRepositoryLayouts for a summary of the
 
117
http://bazaar-vcs.org/SharedRepositoryLayouts for a summary of the
218
118
popular alternatives.
219
119
 
220
120
Of course, the best choice for you will depend on numerous factors:
223
123
 
224
124
* create a local copy of the main development branch (bzr.dev) by using
225
125
  this command::
226
 
 
 
126
  
227
127
    bzr branch http://bazaar-vcs.org/bzr/bzr.dev/ bzr.dev
228
 
 
229
 
* keep your copy of bzr.dev pristine (by not developing in it) and keep
 
128
   
 
129
* keep your copy of bzr.dev prestine (by not developing in it) and keep
230
130
  it up to date (by using bzr pull)
231
131
 
232
132
* create a new branch off your local bzr.dev copy for each issue
234
134
 
235
135
This approach makes it easy to go back and make any required changes
236
136
after a code review. Resubmitting the change is then simple with no
237
 
risk of accidentally including edits related to other issues you may
 
137
risk of accidentially including edits related to other issues you may
238
138
be working on. After the changes for an issue are accepted and merged,
239
139
the associated branch can be deleted or archived as you wish.
240
140
 
252
152
 
253
153
README
254
154
    This file covers a brief introduction to Bazaar and lists some of its
255
 
    key features.
 
155
    key features. 
256
156
 
257
157
NEWS
258
 
    Summary of changes in each Bazaar release that can affect users or
 
158
    Summary of changes in each Bazaar release that can affect users or 
259
159
    plugin developers.
260
160
 
261
161
setup.py
267
167
    with this but don't be confused by it. The build process puts a copy
268
168
    of the main code base into this build directory, along with some other
269
169
    files. You don't need to go in here for anything discussed in this
270
 
    guide.
 
170
    guide. 
271
171
 
272
172
bzrlib
273
173
    Possibly the most exciting folder of all, bzrlib holds the main code
278
178
    Holds documentation on a whole range of things on Bazaar from the
279
179
    origination of ideas within the project to information on Bazaar
280
180
    features and use cases.  Within this directory there is a subdirectory
281
 
    for each translation into a human language.  All the documentation
 
181
    for each translation into a human language.  All the documentation 
282
182
    is in the ReStructuredText markup language.
283
183
 
284
 
doc/developers
285
 
    Documentation specifically targeted at Bazaar and plugin developers.
 
184
doc/developers 
 
185
    Documentation specifically targetted at Bazaar and plugin developers.
286
186
    (Including this document.)
287
 
 
288
 
 
289
 
 
290
 
Automatically-generated API reference information is available at
291
 
<http://starship.python.net/crew/mwh/bzrlibapi/>.
292
 
 
293
 
See also the `Bazaar Architectural Overview
294
 
<http://doc.bazaar.canonical.com/developers/overview.html>`_.
 
187
    
 
188
        
 
189
 
 
190
Automatically-generated API reference information is available at 
 
191
<http://starship.python.net/crew/mwh/bzrlibapi/>.  
 
192
 
 
193
See also the `Bazaar Architectural Overview  <../../developers/overview.html>`_.
 
194
 
 
195
 
 
196
The Code Review Process
 
197
#######################
 
198
 
 
199
All code changes coming in to Bazaar are reviewed by someone else.
 
200
Normally changes by core contributors are reviewed by one other core
 
201
developer, and changes from other people are reviewed by two core
 
202
developers.  Use intelligent discretion if the patch is trivial.
 
203
 
 
204
Good reviews do take time. They also regularly require a solid
 
205
understanding of the overall code base. In practice, this means a small
 
206
number of people often have a large review burden - with knowledge comes
 
207
responsibility. No one like their merge requests sitting in a queue going
 
208
nowhere, so reviewing sooner rather than later is strongly encouraged.
 
209
 
 
210
 
 
211
 
 
212
Sending patches for review
 
213
==========================
 
214
 
 
215
If you'd like to propose a change, please post to the
 
216
bazaar@lists.canonical.com list with a bundle, patch, or link to a
 
217
branch. Put ``[PATCH]`` or ``[MERGE]`` in the subject so Bundle Buggy
 
218
can pick it out, and explain the change in the email message text.
 
219
Remember to update the NEWS file as part of your change if it makes any
 
220
changes visible to users or plugin developers. Please include a diff
 
221
against mainline if you're giving a link to a branch.
 
222
 
 
223
You can generate a merge request like this::
 
224
 
 
225
  bzr send -o bug-1234.patch
 
226
  
 
227
A ``.patch`` extension is recommended instead of .bundle as many mail clients
 
228
will send the latter as a binary file.
 
229
 
 
230
``bzr send`` can also send mail directly if you prefer; see the help.
 
231
 
 
232
Please do **NOT** put [PATCH] or [MERGE] in the subject line if you don't
 
233
want it to be merged. If you want comments from developers rather than
 
234
to be merged, you can put ``[RFC]`` in the subject line.
 
235
 
 
236
If this change addresses a bug, please put the bug number in the subject
 
237
line too, in the form ``[#1]`` so that Bundle Buggy can recognize it.
 
238
 
 
239
If the change is intended for a particular release mark that in the
 
240
subject too, e.g. ``[1.6]``.
 
241
 
 
242
 
 
243
Review cover letters
 
244
====================
 
245
 
 
246
Please put a "cover letter" on your merge request explaining:
 
247
 
 
248
* the reason **why** you're making this change
 
249
 
 
250
* **how** this change achieves this purpose
 
251
 
 
252
* anything else you may have fixed in passing 
 
253
 
 
254
* anything significant that you thought of doing, such as a more
 
255
  extensive fix or a different approach, but didn't or couldn't do now
 
256
 
 
257
A good cover letter makes reviewers' lives easier because they can decide
 
258
from the letter whether they agree with the purpose and approach, and then
 
259
assess whether the patch actually does what the cover letter says.
 
260
Explaining any "drive-by fixes" or roads not taken may also avoid queries
 
261
from the reviewer.  All in all this should give faster and better reviews.
 
262
Sometimes writing the cover letter helps the submitter realize something
 
263
else they need to do.  The size of the cover letter should be proportional
 
264
to the size and complexity of the patch.
 
265
 
 
266
 
 
267
Reviewing proposed changes
 
268
==========================
 
269
 
 
270
Anyone is welcome to review code, and reply to the thread with their
 
271
opinion or comments.
 
272
 
 
273
The simplest way to review a proposed change is to just read the patch on
 
274
the list or in Bundle Buggy.  For more complex changes it may be useful
 
275
to make a new working tree or branch from trunk, and merge the proposed
 
276
change into it, so you can experiment with the code or look at a wider
 
277
context.
 
278
 
 
279
There are three main requirements for code to get in:
 
280
 
 
281
* Doesn't reduce test coverage: if it adds new methods or commands,
 
282
  there should be tests for them.  There is a good test framework
 
283
  and plenty of examples to crib from, but if you are having trouble
 
284
  working out how to test something feel free to post a draft patch
 
285
  and ask for help.
 
286
 
 
287
* Doesn't reduce design clarity, such as by entangling objects
 
288
  we're trying to separate.  This is mostly something the more
 
289
  experienced reviewers need to help check.
 
290
 
 
291
* Improves bugs, features, speed, or code simplicity.
 
292
 
 
293
Code that goes in should not degrade any of these aspects.  Patches are
 
294
welcome that only cleanup the code without changing the external
 
295
behaviour.  The core developers take care to keep the code quality high
 
296
and understandable while recognising that perfect is sometimes the enemy
 
297
of good. 
 
298
 
 
299
It is easy for reviews to make people notice other things which should be
 
300
fixed but those things should not hold up the original fix being accepted.
 
301
New things can easily be recorded in the Bug Tracker instead.
 
302
 
 
303
It's normally much easier to review several smaller patches than one large
 
304
one.  You might want to use ``bzr-loom`` to maintain threads of related
 
305
work, or submit a preparatory patch that will make your "real" change
 
306
easier.
 
307
 
 
308
 
 
309
Checklist for reviewers
 
310
=======================
 
311
 
 
312
* Do you understand what the code's doing and why?
 
313
 
 
314
* Will it perform reasonably for large inputs, both in memory size and
 
315
  run time?  Are there some scenarios where performance should be
 
316
  measured?
 
317
 
 
318
* Is it tested, and are the tests at the right level?  Are there both
 
319
  blackbox (command-line level) and API-oriented tests?
 
320
 
 
321
* If this change will be visible to end users or API users, is it
 
322
  appropriately documented in NEWS?
 
323
 
 
324
* Does it meet the coding standards below?
 
325
 
 
326
* If it changes the user-visible behaviour, does it update the help
 
327
  strings and user documentation?
 
328
 
 
329
* If it adds a new major concept or standard practice, does it update the
 
330
  developer documentation?
 
331
 
 
332
* (your ideas here...)
 
333
 
 
334
 
 
335
Bundle Buggy and review outcomes
 
336
================================
 
337
 
 
338
Anyone can "vote" on the mailing list by expressing an opinion. Core
 
339
developers can also vote using Bundle Buggy. Here are the voting codes and
 
340
their explanations.
 
341
 
 
342
:approve:  Reviewer wants this submission merged.
 
343
:tweak:    Reviewer wants this submission merged with small changes. (No
 
344
  re-review required.)
 
345
:abstain:  Reviewer does not intend to vote on this patch.
 
346
:resubmit: Please make changes and resubmit for review.
 
347
:reject:   Reviewer doesn't want this kind of change merged.
 
348
:comment:  Not really a vote. Reviewer just wants to comment, for now.
 
349
 
 
350
If a change gets two approvals from core reviewers, and no rejections,
 
351
then it's OK to come in.  Any of the core developers can bring it into the
 
352
bzr.dev trunk and backport it to maintenance branches if required.  The
 
353
Release Manager will merge the change into the branch for a pending
 
354
release, if any. As a guideline, core developers usually merge their own
 
355
changes and volunteer to merge other contributions if they were the second
 
356
reviewer to agree to a change.
 
357
 
 
358
To track the progress of proposed changes, use Bundle Buggy. See
 
359
http://bundlebuggy.aaronbentley.com/help for a link to all the
 
360
outstanding merge requests together with an explanation of the columns.
 
361
Bundle Buggy will also mail you a link to track just your change.
 
362
 
 
363
Coding Style Guidelines
 
364
#######################
 
365
 
 
366
hasattr and getattr
 
367
===================
 
368
 
 
369
``hasattr`` should not be used because it swallows exceptions including
 
370
``KeyboardInterrupt``.  Instead, say something like ::
 
371
 
 
372
  if getattr(thing, 'name', None) is None
 
373
 
 
374
 
 
375
Code layout
 
376
===========
 
377
 
 
378
Please write PEP-8__ compliant code.  
 
379
 
 
380
__ http://www.python.org/peps/pep-0008.html
 
381
 
 
382
One often-missed requirement is that the first line of docstrings
 
383
should be a self-contained one-sentence summary.
 
384
 
 
385
We use 4 space indents for blocks, and never use tab characters.  (In vim,
 
386
``set expandtab``.)
 
387
 
 
388
Trailing white space should be avoided, but is allowed.
 
389
You should however not make lots of unrelated white space changes.
 
390
 
 
391
Unix style newlines (LF) are used.
 
392
 
 
393
Each file must have a newline at the end of it.
 
394
 
 
395
Lines should be no more than 79 characters if at all possible.
 
396
Lines that continue a long statement may be indented in either of 
 
397
two ways:
 
398
 
 
399
within the parenthesis or other character that opens the block, e.g.::
 
400
 
 
401
    my_long_method(arg1,
 
402
                   arg2,
 
403
                   arg3)
 
404
 
 
405
or indented by four spaces::
 
406
 
 
407
    my_long_method(arg1,
 
408
        arg2,
 
409
        arg3)
 
410
 
 
411
The first is considered clearer by some people; however it can be a bit
 
412
harder to maintain (e.g. when the method name changes), and it does not
 
413
work well if the relevant parenthesis is already far to the right.  Avoid
 
414
this::
 
415
 
 
416
     self.legbone.kneebone.shinbone.toebone.shake_it(one,
 
417
                                                     two,
 
418
                                                     three)
 
419
 
 
420
but rather ::
 
421
 
 
422
     self.legbone.kneebone.shinbone.toebone.shake_it(one,
 
423
         two,
 
424
         three)
 
425
 
 
426
or ::
 
427
 
 
428
     self.legbone.kneebone.shinbone.toebone.shake_it(
 
429
         one, two, three)
 
430
 
 
431
For long lists, we like to add a trailing comma and put the closing
 
432
character on the following line.  This makes it easier to add new items in
 
433
future::
 
434
 
 
435
    from bzrlib.goo import (
 
436
        jam,
 
437
        jelly,
 
438
        marmalade,
 
439
        )
 
440
 
 
441
There should be spaces between function paramaters, but not between the
 
442
keyword name and the value::
 
443
 
 
444
    call(1, 3, cheese=quark)
 
445
 
 
446
In emacs::
 
447
 
 
448
    ;(defface my-invalid-face
 
449
    ;  '((t (:background "Red" :underline t)))
 
450
    ;  "Face used to highlight invalid constructs or other uglyties"
 
451
    ;  )
 
452
 
 
453
    (defun my-python-mode-hook ()
 
454
     ;; setup preferred indentation style.
 
455
     (setq fill-column 79)
 
456
     (setq indent-tabs-mode nil) ; no tabs, never, I will not repeat
 
457
    ;  (font-lock-add-keywords 'python-mode
 
458
    ;                         '(("^\\s *\t" . 'my-invalid-face) ; Leading tabs
 
459
    ;                            ("[ \t]+$" . 'my-invalid-face)  ; Trailing spaces
 
460
    ;                            ("^[ \t]+$" . 'my-invalid-face)); Spaces only
 
461
    ;                          )
 
462
     )
 
463
 
 
464
    (add-hook 'python-mode-hook 'my-python-mode-hook)
 
465
 
 
466
The lines beginning with ';' are comments. They can be activated
 
467
if one want to have a strong notice of some tab/space usage
 
468
violations.
 
469
 
 
470
 
 
471
Module Imports
 
472
==============
 
473
 
 
474
* Imports should be done at the top-level of the file, unless there is
 
475
  a strong reason to have them lazily loaded when a particular
 
476
  function runs.  Import statements have a cost, so try to make sure
 
477
  they don't run inside hot functions.
 
478
 
 
479
* Module names should always be given fully-qualified,
 
480
  i.e. ``bzrlib.hashcache`` not just ``hashcache``.
 
481
 
 
482
 
 
483
Naming
 
484
======
 
485
 
 
486
Functions, methods or members that are "private" to bzrlib are given
 
487
a leading underscore prefix.  Names without a leading underscore are
 
488
public not just across modules but to programmers using bzrlib as an
 
489
API. As a consequence, a leading underscore is appropriate for names
 
490
exposed across modules but that are not to be exposed to bzrlib API
 
491
programmers.
 
492
 
 
493
We prefer class names to be concatenated capital words (``TestCase``)
 
494
and variables, methods and functions to be lowercase words joined by
 
495
underscores (``revision_id``, ``get_revision``).
 
496
 
 
497
For the purposes of naming some names are treated as single compound
 
498
words: "filename", "revno".
 
499
 
 
500
Consider naming classes as nouns and functions/methods as verbs.
 
501
 
 
502
Try to avoid using abbreviations in names, because there can be
 
503
inconsistency if other people use the full name.
 
504
 
 
505
 
 
506
Standard Names
 
507
==============
 
508
 
 
509
``revision_id`` not ``rev_id`` or ``revid``
 
510
 
 
511
Functions that transform one thing to another should be named ``x_to_y``
 
512
(not ``x2y`` as occurs in some old code.)
 
513
 
 
514
 
 
515
Destructors
 
516
===========
 
517
 
 
518
Python destructors (``__del__``) work differently to those of other
 
519
languages.  In particular, bear in mind that destructors may be called
 
520
immediately when the object apparently becomes unreferenced, or at some
 
521
later time, or possibly never at all.  Therefore we have restrictions on
 
522
what can be done inside them.
 
523
 
 
524
 0. If you think you need to use a ``__del__`` method ask another
 
525
    developer for alternatives.  If you do need to use one, explain
 
526
    why in a comment.
 
527
 
 
528
 1. Never rely on a ``__del__`` method running.  If there is code that
 
529
    must run, do it from a ``finally`` block instead.
 
530
 
 
531
 2. Never ``import`` from inside a ``__del__`` method, or you may crash the
 
532
    interpreter!!
 
533
 
 
534
 3. In some places we raise a warning from the destructor if the object
 
535
    has not been cleaned up or closed.  This is considered OK: the warning
 
536
    may not catch every case but it's still useful sometimes.
 
537
 
 
538
 
 
539
Factories
 
540
=========
 
541
 
 
542
In some places we have variables which point to callables that construct
 
543
new instances.  That is to say, they can be used a lot like class objects,
 
544
but they shouldn't be *named* like classes:
 
545
 
 
546
> I think that things named FooBar should create instances of FooBar when
 
547
> called. Its plain confusing for them to do otherwise. When we have
 
548
> something that is going to be used as a class - that is, checked for via
 
549
> isinstance or other such idioms, them I would call it foo_class, so that
 
550
> it is clear that a callable is not sufficient. If it is only used as a
 
551
> factory, then yes, foo_factory is what I would use.
 
552
 
 
553
 
 
554
Registries
 
555
==========
 
556
 
 
557
Several places in Bazaar use (or will use) a registry, which is a 
 
558
mapping from names to objects or classes.  The registry allows for 
 
559
loading in registered code only when it's needed, and keeping
 
560
associated information such as a help string or description.
 
561
 
 
562
 
 
563
InterObject and multiple dispatch
 
564
=================================
 
565
 
 
566
The ``InterObject`` provides for two-way `multiple dispatch`__: matching
 
567
up for example a source and destination repository to find the right way
 
568
to transfer data between them. 
 
569
 
 
570
.. __: http://en.wikipedia.org/wiki/Multiple_dispatch
 
571
 
 
572
There is a subclass ``InterObject`` classes for each type of object that is
 
573
dispatched this way, e.g. ``InterRepository``.  Calling ``.get()`` on this
 
574
class will return an ``InterObject`` instance providing the best match for 
 
575
those parameters, and this instance then has methods for operations
 
576
between the objects.
 
577
 
 
578
  inter = InterRepository.get(source_repo, target_repo)
 
579
  inter.fetch(revision_id)
 
580
 
 
581
``InterRepository`` also acts as a registry-like object for its
 
582
subclasses, and they can be added through ``.register_optimizer``.  The
 
583
right one to run is selected by asking each class, in reverse order of
 
584
registration, whether it ``.is_compatible`` with the relevant objects.
 
585
 
 
586
Lazy Imports
 
587
============
 
588
 
 
589
To make startup time faster, we use the ``bzrlib.lazy_import`` module to
 
590
delay importing modules until they are actually used. ``lazy_import`` uses
 
591
the same syntax as regular python imports. So to import a few modules in a
 
592
lazy fashion do::
 
593
 
 
594
  from bzrlib.lazy_import import lazy_import
 
595
  lazy_import(globals(), """
 
596
  import os
 
597
  import subprocess
 
598
  import sys
 
599
  import time
 
600
 
 
601
  from bzrlib import (
 
602
     errors,
 
603
     transport,
 
604
     revision as _mod_revision,
 
605
     )
 
606
  import bzrlib.transport
 
607
  import bzrlib.xml5
 
608
  """)
 
609
 
 
610
At this point, all of these exist as a ``ImportReplacer`` object, ready to
 
611
be imported once a member is accessed. Also, when importing a module into
 
612
the local namespace, which is likely to clash with variable names, it is
 
613
recommended to prefix it as ``_mod_<module>``. This makes it clearer that
 
614
the variable is a module, and these object should be hidden anyway, since
 
615
they shouldn't be imported into other namespaces.
 
616
 
 
617
While it is possible for ``lazy_import()`` to import members of a module
 
618
when using the ``from module import member`` syntax, it is recommended to
 
619
only use that syntax to load sub modules ``from module import submodule``.
 
620
This is because variables and classes can frequently be used without
 
621
needing a sub-member for example::
 
622
 
 
623
  lazy_import(globals(), """
 
624
  from module import MyClass
 
625
  """)
 
626
 
 
627
  def test(x):
 
628
      return isinstance(x, MyClass)
 
629
 
 
630
This will incorrectly fail, because ``MyClass`` is a ``ImportReplacer``
 
631
object, rather than the real class.
 
632
 
 
633
It also is incorrect to assign ``ImportReplacer`` objects to other variables.
 
634
Because the replacer only knows about the original name, it is unable to
 
635
replace other variables. The ``ImportReplacer`` class will raise an
 
636
``IllegalUseOfScopeReplacer`` exception if it can figure out that this
 
637
happened. But it requires accessing a member more than once from the new
 
638
variable, so some bugs are not detected right away.
 
639
 
 
640
 
 
641
The Null revision
 
642
=================
 
643
 
 
644
The null revision is the ancestor of all revisions.  Its revno is 0, its
 
645
revision-id is ``null:``, and its tree is the empty tree.  When referring
 
646
to the null revision, please use ``bzrlib.revision.NULL_REVISION``.  Old
 
647
code sometimes uses ``None`` for the null revision, but this practice is
 
648
being phased out.
 
649
 
 
650
 
 
651
Object string representations
 
652
=============================
 
653
 
 
654
Python prints objects using their ``__repr__`` method when they are
 
655
written to logs, exception tracebacks, or the debugger.  We want
 
656
objects to have useful representations to help in determining what went
 
657
wrong.
 
658
 
 
659
If you add a new class you should generally add a ``__repr__`` method
 
660
unless there is an adequate method in a parent class.  There should be a
 
661
test for the repr.  
 
662
 
 
663
Representations should typically look like Python constructor syntax, but
 
664
they don't need to include every value in the object and they don't need
 
665
to be able to actually execute.  They're to be read by humans, not
 
666
machines.  Don't hardcode the classname in the format, so that we get the
 
667
correct value if the method is inherited by a subclass.  If you're
 
668
printing attributes of the object, including strings, you should normally
 
669
use ``%r`` syntax (to call their repr in turn).
 
670
 
 
671
Try to avoid the representation becoming more than one or two lines long.
 
672
(But balance this against including useful information, and simplicity of
 
673
implementation.)
 
674
 
 
675
Because repr methods are often called when something has already gone
 
676
wrong, they should be written somewhat more defensively than most code.
 
677
The object may be half-initialized or in some other way in an illegal
 
678
state.  The repr method shouldn't raise an exception, or it may hide the
 
679
(probably more useful) underlying exception.
 
680
 
 
681
Example::
 
682
 
 
683
    def __repr__(self):
 
684
        return '%s(%r)' % (self.__class__.__name__,
 
685
                           self._transport)
 
686
 
 
687
 
 
688
Exception handling
 
689
==================
 
690
 
 
691
A bare ``except`` statement will catch all exceptions, including ones that
 
692
really should terminate the program such as ``MemoryError`` and
 
693
``KeyboardInterrupt``.  They should rarely be used unless the exception is
 
694
later re-raised.  Even then, think about whether catching just
 
695
``Exception`` (which excludes system errors in Python2.5 and later) would
 
696
be better.
 
697
 
 
698
 
 
699
Test coverage
 
700
=============
 
701
 
 
702
All code should be exercised by the test suite.  See `Guide to Testing
 
703
Bazaar <../../developers/testing.html>`_ for detailed information about writing tests.
295
704
 
296
705
 
297
706
Core Topics
300
709
Evolving Interfaces
301
710
===================
302
711
 
303
 
We don't change APIs in stable branches: any supported symbol in a stable
304
 
release of bzr must not be altered in any way that would result in
 
712
We have a commitment to 6 months API stability - any supported symbol in a
 
713
release of bzr MUST NOT be altered in any way that would result in
305
714
breaking existing code that uses it. That means that method names,
306
715
parameter ordering, parameter names, variable and attribute names etc must
307
716
not be changed without leaving a 'deprecated forwarder' behind. This even
311
720
way, you need to change its name as well. For instance, if I add an optional keyword
312
721
parameter to branch.commit - that's fine. On the other hand, if I add a
313
722
keyword parameter to branch.commit which is a *required* transaction
314
 
object, I should rename the API - i.e. to 'branch.commit_transaction'.
315
 
 
316
 
  (Actually, that may break code that provides a new implementation of
317
 
  ``commit`` and doesn't expect to receive the parameter.)
 
723
object, I should rename the API - i.e. to 'branch.commit_transaction'. 
318
724
 
319
725
When renaming such supported API's, be sure to leave a deprecated_method (or
320
726
_function or ...) behind which forwards to the new API. See the
321
727
bzrlib.symbol_versioning module for decorators that take care of the
322
728
details for you - such as updating the docstring, and issuing a warning
323
 
when the old API is used.
 
729
when the old api is used.
324
730
 
325
731
For unsupported API's, it does not hurt to follow this discipline, but it's
326
732
not required. Minimally though, please try to rename things so that
443
849
The user should call `finish` on the `ProgressTask` when the logical
444
850
operation has finished, so it can be removed from the stack.
445
851
 
446
 
Progress tasks have a complex relationship with generators: it's a very
 
852
Progress tasks have a complex relatioship with generators: it's a very
447
853
good place to use them, but because python2.4 does not allow ``finally``
448
854
blocks in generators it's hard to clean them up properly.  In this case
449
855
it's probably better to have the code calling the generator allocate a
453
859
time until the finally block runs.
454
860
 
455
861
 
456
 
Message guidelines
457
 
------------------
458
 
 
459
 
When filenames or similar variables are presented inline within a message,
460
 
they should be enclosed in double quotes (ascii 0x22, not chiral unicode
461
 
quotes)::
462
 
 
463
 
  bzr: ERROR: No such file "asdf"
464
 
 
465
 
When we print just a list of filenames there should not be any quoting:
466
 
see `bug 544297`_.
467
 
 
468
 
.. _bug 544297: https://bugs.launchpad.net/bugs/544297
469
 
 
470
 
https://wiki.ubuntu.com/UnitsPolicy provides a good explanation about
471
 
which unit should be used when. Roughly speaking, IEC standard applies
472
 
for base-2 units and SI standard applies for base-10 units:
473
 
 
474
 
* for network bandwidth and disk sizes, use base-10 (Mbits/s, kB/s, GB)
475
 
 
476
 
* for RAM sizes, use base-2 (GiB, TiB)
477
 
 
478
 
 
479
 
 
480
862
Displaying help
481
863
===============
482
864
 
485
867
and on other help topics.  (See ``help_topics.py``.)
486
868
 
487
869
As for python docstrings, the first paragraph should be a single-sentence
488
 
synopsis of the command. These are user-visible and should be prefixed with
489
 
``__doc__ =`` so help works under ``python -OO`` with docstrings stripped.
 
870
synopsis of the command.
490
871
 
491
872
The help for options should be one or more proper sentences, starting with
492
873
a capital letter and finishing with a full stop (period).
506
887
 
507
888
    0. OK.
508
889
    1. Conflicts in merge-like operations, or changes are present in
509
 
       diff-like operations.
510
 
    2. Unrepresentable diff changes (i.e. binary files that we cannot show
 
890
       diff-like operations. 
 
891
    2. Unrepresentable diff changes (i.e. binary files that we cannot show 
511
892
       a diff of).
512
893
    3. An error or exception has occurred.
513
894
    4. An internal error occurred (one that shows a traceback.)
544
925
format string.
545
926
 
546
927
#. If it is something that a caller can recover from, a custom exception
547
 
   is reasonable.
 
928
   is reasonable. 
548
929
 
549
930
#. If it is a data consistency issue, using a builtin like
550
 
   ``ValueError``/``TypeError`` is reasonable.
 
931
   ``ValueError``/``TypeError`` is reasonable. 
551
932
 
552
933
#. If it is a programmer error (using an api incorrectly)
553
 
   ``AssertionError`` is reasonable.
 
934
   ``AssertionError`` is reasonable. 
554
935
 
555
936
#. Otherwise, use ``BzrError`` or ``InternalBzrError``.
556
937
 
558
939
final fullstop.  If long, they may contain newlines to break the text.
559
940
 
560
941
 
 
942
Assertions
 
943
==========
 
944
 
 
945
Do not use the Python ``assert`` statement, either in tests or elsewhere.
 
946
A source test checks that it is not used.  It is ok to explicitly raise
 
947
AssertionError.
 
948
 
 
949
Rationale:
 
950
 
 
951
 * It makes the behaviour vary depending on whether bzr is run with -O
 
952
   or not, therefore giving a chance for bugs that occur in one case or
 
953
   the other, several of which have already occurred: assertions with
 
954
   side effects, code which can't continue unless the assertion passes,
 
955
   cases where we should give the user a proper message rather than an
 
956
   assertion failure.
 
957
 * It's not that much shorter than an explicit if/raise.
 
958
 * It tends to lead to fuzzy thinking about whether the check is
 
959
   actually needed or not, and whether it's an internal error or not
 
960
 * It tends to cause look-before-you-leap patterns.
 
961
 * It's unsafe if the check is needed to protect the integrity of the
 
962
   user's data.
 
963
 * It tends to give poor messages since the developer can get by with
 
964
   no explanatory text at all.
 
965
 * We can't rely on people always running with -O in normal use, so we
 
966
   can't use it for tests that are actually expensive.
 
967
 * Expensive checks that help developers are better turned on from the
 
968
   test suite or a -D flag.
 
969
 * If used instead of ``self.assert*()`` in tests it makes them falsely pass with -O.
 
970
 
561
971
 
562
972
Documenting Changes
563
973
===================
580
990
Within each release, entries in the news file should have the most
581
991
user-visible changes first.  So the order should be approximately:
582
992
 
583
 
 * changes to existing behaviour - the highest priority because the
 
993
 * changes to existing behaviour - the highest priority because the 
584
994
   user's existing knowledge is incorrect
585
995
 * new features - should be brought to their attention
586
996
 * bug fixes - may be of interest if the bug was affecting them, and
587
997
   should include the bug number if any
588
 
 * major documentation changes, including fixed documentation bugs
 
998
 * major documentation changes
589
999
 * changes to internal interfaces
590
1000
 
591
1001
People who made significant contributions to each change are listed in
592
1002
parenthesis.  This can include reporting bugs (particularly with good
593
1003
details or reproduction recipes), submitting patches, etc.
594
1004
 
595
 
To help with merging, NEWS entries should be sorted lexicographically
596
 
within each section.
597
 
 
598
1005
Commands
599
1006
--------
600
1007
 
608
1015
-----------------
609
1016
 
610
1017
Functions, methods, classes and modules should have docstrings
611
 
describing how they are used.
 
1018
describing how they are used. 
612
1019
 
613
1020
The first line of the docstring should be a self-contained sentence.
614
1021
 
639
1046
    We had the problem that lots of our files were "Copyright Canonical
640
1047
    Development Ltd" which is not a real company, and some other variations
641
1048
    on this theme. Also, some files were missing the GPL statements.
642
 
 
 
1049
    
643
1050
    I want to be clear about the intent of this patch, since copyright can
644
1051
    be a little controversial.
645
 
 
 
1052
    
646
1053
    1) The big motivation for this is not to shut out the community, but
647
1054
    just to clean up all of the invalid copyright statements.
648
 
 
 
1055
    
649
1056
    2) It has been the general policy for bzr that we want a single
650
1057
    copyright holder for all of the core code. This is following the model
651
1058
    set by the FSF, which makes it easier to update the code to a new
658
1065
    I'm sure Canonical would do the same).
659
1066
    As such, Canonical has requested copyright assignments from all of the
660
1067
    major contributers.
661
 
 
 
1068
    
662
1069
    3) If someone wants to add code and not attribute it to Canonical, there
663
1070
    is a specific list of files that are excluded from this check. And the
664
1071
    test failure indicates where that is, and how to update it.
665
 
 
 
1072
    
666
1073
    4) If anyone feels that I changed a copyright statement incorrectly, just
667
1074
    let me know, and I'll be happy to correct it. Whenever you have large
668
1075
    mechanical changes like this, it is possible to make some mistakes.
669
 
 
 
1076
    
670
1077
    Just to reiterate, this is a community project, and it is meant to stay
671
1078
    that way. Core bzr code is copyright Canonical for legal reasons, and
672
1079
    the tests are just there to help us maintain that.
683
1090
 
684
1091
.. _pdb: http://docs.python.org/lib/debugger-commands.html
685
1092
 
686
 
If the ``BZR_PDB`` environment variable is set
 
1093
If the ``BZR_PDB`` environment variable is set 
687
1094
then bzr will go into pdb post-mortem mode when an unhandled exception
688
1095
occurs.
689
1096
 
690
 
If you send a SIGQUIT or SIGBREAK signal to bzr then it will drop into the
691
 
debugger immediately. SIGQUIT can be generated by pressing Ctrl-\\ on
692
 
Unix.  SIGBREAK is generated with Ctrl-Pause on Windows (some laptops have
693
 
this as Fn-Pause).  You can continue execution by typing ``c``.  This can
694
 
be disabled if necessary by setting the environment variable
695
 
``BZR_SIGQUIT_PDB=0``.
 
1097
If you send a SIGQUIT signal to bzr, which can be done by pressing
 
1098
Ctrl-\\ on Unix, bzr will go into the debugger immediately.  You can
 
1099
continue execution by typing ``c``.  This can be disabled if necessary
 
1100
by setting the environment variable ``BZR_SIGQUIT_PDB=0``.
696
1101
 
697
1102
 
698
1103
Debug Flags
751
1156
    for automated processing.
752
1157
    For example: ``bzr log`` should not fail if one of the entries has text
753
1158
    that cannot be displayed.
754
 
 
 
1159
  
755
1160
  strict
756
1161
    Attempting to print an unprintable character will cause a UnicodeError.
757
1162
    This is for commands that are intended more as scripting support, rather
758
1163
    than plain user review.
759
 
    For example: ``bzr ls`` is designed to be used with shell scripting. One
760
 
    use would be ``bzr ls --null --unknowns | xargs -0 rm``.  If ``bzr``
 
1164
    For exampl: ``bzr ls`` is designed to be used with shell scripting. One
 
1165
    use would be ``bzr ls --null --unknows | xargs -0 rm``.  If ``bzr``
761
1166
    printed a filename with a '?', the wrong file could be deleted. (At the
762
1167
    very least, the correct file would not be deleted). An error is used to
763
1168
    indicate that the requested action could not be performed.
764
 
 
 
1169
  
765
1170
  exact
766
1171
    Do not attempt to automatically convert Unicode strings. This is used
767
1172
    for commands that must handle conversion themselves.
781
1186
valid characters are generated where possible.
782
1187
 
783
1188
 
 
1189
Portability Tips
 
1190
================
 
1191
 
 
1192
The ``bzrlib.osutils`` module has many useful helper functions, including
 
1193
some more portable variants of functions in the standard library.
 
1194
 
 
1195
In particular, don't use ``shutil.rmtree`` unless it's acceptable for it
 
1196
to fail on Windows if some files are readonly or still open elsewhere.
 
1197
Use ``bzrlib.osutils.rmtree`` instead.
 
1198
 
 
1199
 
784
1200
C Extension Modules
785
1201
===================
786
1202
 
804
1220
 
805
1221
To create an extension, add rules to setup.py for building it with pyrex,
806
1222
and with distutils. Now start with an empty .pyx file. At the top add
807
 
"include 'yourmodule.py'". This will import the contents of foo.py into this
 
1223
"include 'yourmodule.py'". This will import the contents of foo.py into this 
808
1224
file at build time - remember that only one module will be loaded at
809
1225
runtime. Now you can subclass classes, or replace functions, and only your
810
1226
changes need to be present in the .pyx file.
811
1227
 
812
1228
Note that pyrex does not support all 2.4 programming idioms, so some
813
 
syntax changes may be required. I.e.
 
1229
syntax changes may be required. I.e. 
814
1230
 
815
 
 - 'from foo import (bar, gam)' needs to change to not use the brackets.
816
 
 - 'import foo.bar as bar' needs to be 'import foo.bar; bar = foo.bar'
 
1231
 - 'from foo import (bar, gam)' needs to change to not use the brackets. 
 
1232
 - 'import foo.bar as bar' needs to be 'import foo.bar; bar = foo.bar' 
817
1233
 
818
1234
If the changes are too dramatic, consider
819
1235
maintaining the python code twice - once in the .pyx, and once in the .py,
823
1239
Making Installers for OS Windows
824
1240
================================
825
1241
To build a win32 installer, see the instructions on the wiki page:
826
 
http://wiki.bazaar.canonical.com/BzrWin32Installer
 
1242
http://bazaar-vcs.org/BzrWin32Installer
 
1243
 
827
1244
 
828
1245
Core Developer Tasks
829
1246
####################
842
1259
* reviewing changes
843
1260
* reviewing blueprints
844
1261
* planning releases
845
 
* managing releases (see `Releasing Bazaar <http://doc.bazaar.canonical.com/developers/releasing.html>`_)
 
1262
* managing releases (see the `Releasing Bazaar <../../developers/releasing.html>`_)
846
1263
 
847
1264
.. note::
848
1265
  Removing barriers to community participation is a key reason for adopting
869
1286
energy by emailing the **bazaar-commits** list implicitly. To do this,
870
1287
install and configure the Email plugin. One way to do this is add these
871
1288
configuration settings to your central configuration file (e.g.
872
 
``~/.bazaar/bazaar.conf``)::
 
1289
``~/.bazaar/bazaar.conf`` on Linux)::
873
1290
 
874
1291
  [DEFAULT]
875
1292
  email = Joe Smith <joe.smith@internode.on.net>
885
1302
how to set it up and configure it.
886
1303
 
887
1304
 
 
1305
Submitting Changes
 
1306
==================
 
1307
 
 
1308
An Overview of PQM
 
1309
------------------
 
1310
 
 
1311
Of the many workflows supported by Bazaar, the one adopted for Bazaar
 
1312
development itself is known as "Decentralized with automatic gatekeeper".
 
1313
To repeat the explanation of this given on
 
1314
http://bazaar-vcs.org/Workflows:
 
1315
 
 
1316
.. pull-quote::
 
1317
  In this workflow, each developer has their own branch or
 
1318
  branches, plus read-only access to the mainline. A software gatekeeper
 
1319
  (e.g. PQM) has commit rights to the main branch. When a developer wants
 
1320
  their work merged, they request the gatekeeper to merge it. The gatekeeper
 
1321
  does a merge, a compile, and runs the test suite. If the code passes, it
 
1322
  is merged into the mainline.
 
1323
 
 
1324
In a nutshell, here's the overall submission process:
 
1325
 
 
1326
#. get your work ready (including review except for trivial changes)
 
1327
#. push to a public location
 
1328
#. ask PQM to merge from that location
 
1329
 
 
1330
.. note::
 
1331
  At present, PQM always takes the changes to merge from a branch
 
1332
  at a URL that can be read by it. For Bazaar, that means a public,
 
1333
  typically http, URL.
 
1334
 
 
1335
As a result, the following things are needed to use PQM for submissions:
 
1336
 
 
1337
#. A publicly available web server
 
1338
#. Your OpenPGP key registered with PQM (contact RobertCollins for this)
 
1339
#. The PQM plugin installed and configured (not strictly required but
 
1340
   highly recommended).
 
1341
 
 
1342
 
 
1343
Selecting a Public Branch Location
 
1344
----------------------------------
 
1345
 
 
1346
If you don't have your own web server running, branches can always be
 
1347
pushed to Launchpad. Here's the process for doing that:
 
1348
 
 
1349
Depending on your location throughout the world and the size of your
 
1350
repository though, it is often quicker to use an alternative public
 
1351
location to Launchpad, particularly if you can set up your own repo and
 
1352
push into that. By using an existing repo, push only needs to send the
 
1353
changes, instead of the complete repository every time. Note that it is
 
1354
easy to register branches in other locations with Launchpad so no benefits
 
1355
are lost by going this way.
 
1356
 
 
1357
.. note::
 
1358
  For Canonical staff, http://people.ubuntu.com/~<user>/ is one
 
1359
  suggestion for public http branches. Contact your manager for information
 
1360
  on accessing this system if required.
 
1361
 
 
1362
It should also be noted that best practice in this area is subject to
 
1363
change as things evolve. For example, once the Bazaar smart server on
 
1364
Launchpad supports server-side branching, the performance situation will
 
1365
be very different to what it is now (Jun 2007).
 
1366
 
 
1367
 
 
1368
Configuring the PQM Plug-In
 
1369
---------------------------
 
1370
 
 
1371
While not strictly required, the PQM plugin automates a few things and
 
1372
reduces the chance of error. Before looking at the plugin, it helps to
 
1373
understand  a little more how PQM operates. Basically, PQM requires an
 
1374
email indicating what you want it to do. The email typically looks like
 
1375
this::
 
1376
 
 
1377
  star-merge source-branch target-branch
 
1378
 
 
1379
For example::
 
1380
 
 
1381
  star-merge http://bzr.arbash-meinel.com/branches/bzr/jam-integration http://bazaar-vcs.org/bzr/bzr.dev
 
1382
 
 
1383
Note that the command needs to be on one line. The subject of the email
 
1384
will be used for the commit message. The email also needs to be ``gpg``
 
1385
signed with a key that PQM accepts.
 
1386
 
 
1387
The advantages of using the PQM plugin are:
 
1388
 
 
1389
#. You can use the config policies to make it easy to set up public
 
1390
   branches, so you don't have to ever type the full paths you want to merge
 
1391
   from or into.
 
1392
 
 
1393
#. It checks to make sure the public branch last revision matches the
 
1394
   local last revision so you are submitting what you think you are.
 
1395
 
 
1396
#. It uses the same public_branch and smtp sending settings as bzr-email,
 
1397
   so if you have one set up, you have the other mostly set up.
 
1398
 
 
1399
#. Thunderbird refuses to not wrap lines, and request lines are usually
 
1400
   pretty long (you have 2 long URLs in there).
 
1401
 
 
1402
Here are sample configuration settings for the PQM plugin. Here are the
 
1403
lines in bazaar.conf::
 
1404
 
 
1405
  [DEFAULT]
 
1406
  email = Joe Smith <joe.smith@internode.on.net>
 
1407
  smtp_server=mail.internode.on.net:25
 
1408
 
 
1409
And here are the lines in ``locations.conf`` (or ``branch.conf`` for
 
1410
dirstate-tags branches)::
 
1411
 
 
1412
  [/home/joe/bzr/my-integration]
 
1413
  push_location = sftp://joe-smith@bazaar.launchpad.net/%7Ejoe-smith/bzr/my-integration/
 
1414
  push_location:policy = norecurse
 
1415
  public_branch = http://bazaar.launchpad.net/~joe-smith/bzr/my-integration/
 
1416
  public_branch:policy = appendpath
 
1417
  pqm_email = Bazaar PQM <pqm@bazaar-vcs.org>
 
1418
  pqm_branch = http://bazaar-vcs.org/bzr/bzr.dev
 
1419
 
 
1420
Note that the push settings will be added by the first ``push`` on
 
1421
a branch. Indeed the preferred way to generate the lines above is to use
 
1422
``push`` with an argument, then copy-and-paste the other lines into
 
1423
the relevant file.
 
1424
 
 
1425
 
 
1426
Submitting a Change
 
1427
-------------------
 
1428
 
 
1429
Here is one possible recipe once the above environment is set up:
 
1430
 
 
1431
#. pull bzr.dev => my-integration
 
1432
#. merge patch => my-integration
 
1433
#. fix up any final merge conflicts (NEWS being the big killer here).
 
1434
#. commit
 
1435
#. push
 
1436
#. pqm-submit
 
1437
 
 
1438
.. note::
 
1439
  The ``push`` step is not required if ``my-integration`` is a checkout of
 
1440
  a public branch.
 
1441
 
 
1442
  Because of defaults, you can type a single message into commit and
 
1443
  pqm-commit will reuse that.
 
1444
 
 
1445
 
 
1446
Tracking Change Acceptance
 
1447
--------------------------
 
1448
 
 
1449
The web interface to PQM is https://pqm.bazaar-vcs.org/. After submitting
 
1450
a change, you can visit this URL to confirm it was received and placed in
 
1451
PQM's queue.
 
1452
 
 
1453
When PQM completes processing a change, an email is sent to you with the
 
1454
results.
 
1455
 
 
1456
 
 
1457
Reviewing Blueprints
 
1458
====================
 
1459
 
 
1460
Blueprint Tracking Using Launchpad
 
1461
----------------------------------
 
1462
 
 
1463
New features typically require a fair amount of discussion, design and
 
1464
debate. For Bazaar, that information is often captured in a so-called
 
1465
"blueprint" on our Wiki. Overall tracking of blueprints and their status
 
1466
is done using Launchpad's relevant tracker,
 
1467
https://blueprints.launchpad.net/bzr/. Once a blueprint for ready for
 
1468
review, please announce it on the mailing list.
 
1469
 
 
1470
Alternatively, send an email begining with [RFC] with the proposal to the
 
1471
list. In some cases, you may wish to attach proposed code  or a proposed
 
1472
developer document if that best communicates the idea. Debate can then
 
1473
proceed using the normal merge review processes.
 
1474
 
 
1475
 
 
1476
Recording Blueprint Review Feedback
 
1477
-----------------------------------
 
1478
 
 
1479
Unlike its Bug Tracker, Launchpad's Blueprint Tracker doesn't currently
 
1480
(Jun 2007) support a chronological list of comment responses. Review
 
1481
feedback can either be recorded on the Wiki hosting the blueprints or by
 
1482
using Launchpad's whiteboard feature.
 
1483
 
888
1484
 
889
1485
Planning Releases
890
1486
=================
891
1487
 
 
1488
Roadmaps
 
1489
--------
 
1490
 
 
1491
As the two senior developers, Martin Pool and Robert Collins coordinate
 
1492
the overall Bazaar product development roadmap. Core developers provide
 
1493
input and review into this, particularly during sprints. It's totally
 
1494
expected that community members ought to be working on things that
 
1495
interest them the most. The roadmap is valuable though because it provides
 
1496
context for understanding where the product is going as a whole and why.
 
1497
 
 
1498
 
 
1499
Using Releases and Milestones in Launchpad
 
1500
------------------------------------------
 
1501
 
 
1502
TODO ... (Exact policies still under discussion)
 
1503
 
892
1504
 
893
1505
Bug Triage
894
1506
----------
910
1522
.. note::
911
1523
  As well as prioritizing bugs and nominating them against a
912
1524
  target milestone, Launchpad lets core developers offer to mentor others in
913
 
  fixing them.
 
1525
  fixing them. 
914
1526
 
915
1527
 
916
1528
..