~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Robert Collins
  • Date: 2005-12-02 03:23:47 UTC
  • Revision ID: robertc@robertcollins.net-20051202032347-ba08123207a945a0
Test for Jeff Bailey.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
======================
2
 
Bazaar Developer Guide
3
 
======================
4
 
 
5
 
This document describes the Bazaar internals and the development process.
6
 
It's meant for people interested in developing Bazaar, and some parts will
7
 
also be useful to people developing Bazaar plugins.
8
 
 
9
 
If you have any questions or something seems to be incorrect, unclear or
10
 
missing, please talk to us in ``irc://irc.freenode.net/#bzr``, or write to
11
 
the Bazaar mailing list.  To propose a correction or addition to this
12
 
document, send a merge request or new text to the mailing list.
13
 
 
14
 
The latest developer documentation can be found online at
15
 
http://doc.bazaar.canonical.com/developers/.
16
 
 
17
 
Getting Started
18
 
###############
19
 
 
20
 
Exploring the Bazaar Platform
21
 
=============================
22
 
 
23
 
Before making changes, it's a good idea to explore the work already
24
 
done by others. Perhaps the new feature or improvement you're looking
25
 
for is available in another plug-in already? If you find a bug,
26
 
perhaps someone else has already fixed it?
27
 
 
28
 
To answer these questions and more, take a moment to explore the
29
 
overall Bazaar Platform. Here are some links to browse:
30
 
 
31
 
* The Plugins page on the Wiki - http://wiki.bazaar.canonical.com/BzrPlugins
32
 
 
33
 
* The Bazaar product family on Launchpad - https://launchpad.net/bazaar
34
 
 
35
 
* Bug Tracker for the core product - https://bugs.launchpad.net/bzr/
36
 
 
37
 
If nothing else, perhaps you'll find inspiration in how other developers
38
 
have solved their challenges.
39
 
 
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
 
 
50
 
Planning and Discussing Changes
51
 
===============================
52
 
 
53
 
There is a very active community around Bazaar. Mostly we meet on IRC
54
 
(#bzr on irc.freenode.net) and on the mailing list. To join the Bazaar
55
 
community, see http://wiki.bazaar.canonical.com/BzrSupport.
56
 
 
57
 
If you are planning to make a change, it's a very good idea to mention it
58
 
on the IRC channel and/or on the mailing list. There are many advantages
59
 
to involving the community before you spend much time on a change.
60
 
These include:
61
 
 
62
 
* you get to build on the wisdom of others, saving time
63
 
 
64
 
* if others can direct you to similar code, it minimises the work to be done
65
 
 
66
 
* it assists everyone in coordinating direction, priorities and effort.
67
 
 
68
 
In summary, maximising the input from others typically minimises the
69
 
total effort required to get your changes merged. The community is
70
 
friendly, helpful and always keen to welcome newcomers.
71
 
 
72
 
 
73
 
Bazaar Development in a Nutshell
74
 
================================
75
 
 
76
 
.. was from http://wiki.bazaar.canonical.com/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 lp:bzr 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
 
 
182
 
 
183
 
 
184
 
Understanding the Development Process
185
 
=====================================
186
 
 
187
 
The development team follows many practices including:
188
 
 
189
 
* a public roadmap and planning process in which anyone can participate
190
 
 
191
 
* time based milestones everyone can work towards and plan around
192
 
 
193
 
* extensive code review and feedback to contributors
194
 
 
195
 
* complete and rigorous test coverage on any code contributed
196
 
 
197
 
* automated validation that all tests still pass before code is merged
198
 
  into the main code branch.
199
 
 
200
 
The key tools we use to enable these practices are:
201
 
 
202
 
* Launchpad - https://launchpad.net/
203
 
 
204
 
* Bazaar - http://bazaar.canonical.com/
205
 
 
206
 
* Patch Queue Manager - https://launchpad.net/pqm/
207
 
 
208
 
For further information, see <http://wiki.bazaar.canonical.com/BzrDevelopment>.
209
 
 
210
 
 
211
 
 
212
 
 
213
 
Preparing a Sandbox for Making Changes to Bazaar
214
 
================================================
215
 
 
216
 
Bazaar supports many ways of organising your work. See
217
 
http://wiki.bazaar.canonical.com/SharedRepositoryLayouts for a summary of the
218
 
popular alternatives.
219
 
 
220
 
Of course, the best choice for you will depend on numerous factors:
221
 
the number of changes you may be making, the complexity of the changes, etc.
222
 
As a starting suggestion though:
223
 
 
224
 
* create a local copy of the main development branch (bzr.dev) by using
225
 
  this command::
226
 
 
227
 
    bzr branch lp:bzr bzr.dev
228
 
 
229
 
* keep your copy of bzr.dev pristine (by not developing in it) and keep
230
 
  it up to date (by using bzr pull)
231
 
 
232
 
* create a new branch off your local bzr.dev copy for each issue
233
 
  (bug or feature) you are working on.
234
 
 
235
 
This approach makes it easy to go back and make any required changes
236
 
after a code review. Resubmitting the change is then simple with no
237
 
risk of accidentally including edits related to other issues you may
238
 
be working on. After the changes for an issue are accepted and merged,
239
 
the associated branch can be deleted or archived as you wish.
240
 
 
241
 
 
242
 
Navigating the Code Base
243
 
========================
244
 
 
245
 
.. Was at <http://wiki.bazaar.canonical.com/NewDeveloperIntroduction>
246
 
 
247
 
Some of the key files in this directory are:
248
 
 
249
 
bzr
250
 
    The command you run to start Bazaar itself.  This script is pretty
251
 
    short and just does some checks then jumps into bzrlib.
252
 
 
253
 
README
254
 
    This file covers a brief introduction to Bazaar and lists some of its
255
 
    key features.
256
 
 
257
 
NEWS
258
 
    Summary of changes in each Bazaar release that can affect users or
259
 
    plugin developers.
260
 
 
261
 
setup.py
262
 
    Installs Bazaar system-wide or to your home directory.  To perform
263
 
    development work on Bazaar it is not required to run this file - you
264
 
    can simply run the bzr command from the top level directory of your
265
 
    development copy. Note: That if you run setup.py this will create a
266
 
    'build' directory in your development branch. There's nothing wrong
267
 
    with this but don't be confused by it. The build process puts a copy
268
 
    of the main code base into this build directory, along with some other
269
 
    files. You don't need to go in here for anything discussed in this
270
 
    guide.
271
 
 
272
 
bzrlib
273
 
    Possibly the most exciting folder of all, bzrlib holds the main code
274
 
    base. This is where you will go to edit python files and contribute to
275
 
    Bazaar.
276
 
 
277
 
doc
278
 
    Holds documentation on a whole range of things on Bazaar from the
279
 
    origination of ideas within the project to information on Bazaar
280
 
    features and use cases.  Within this directory there is a subdirectory
281
 
    for each translation into a human language.  All the documentation
282
 
    is in the ReStructuredText markup language.
283
 
 
284
 
doc/developers
285
 
    Documentation specifically targeted at Bazaar and plugin developers.
286
 
    (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>`_.
295
 
 
296
 
 
297
 
Core Topics
298
 
###########
299
 
 
300
 
Evolving Interfaces
301
 
===================
302
 
 
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
305
 
breaking existing code that uses it. That means that method names,
306
 
parameter ordering, parameter names, variable and attribute names etc must
307
 
not be changed without leaving a 'deprecated forwarder' behind. This even
308
 
applies to modules and classes.
309
 
 
310
 
If you wish to change the behaviour of a supported API in an incompatible
311
 
way, you need to change its name as well. For instance, if I add an optional keyword
312
 
parameter to branch.commit - that's fine. On the other hand, if I add a
313
 
keyword parameter to branch.commit which is a *required* transaction
 
1
============================
 
2
Guidelines for modifying bzr
 
3
============================
 
4
 
 
5
.. contents::
 
6
 
 
7
(The current version of this document is available in the file ``HACKING``
 
8
in the source tree, or at http://bazaar-ng.org/hacking.html)
 
9
 
 
10
Overall
 
11
=======
 
12
 
 
13
* New functionality should have test cases.  Preferably write the
 
14
  test before writing the code.
 
15
 
 
16
  In general, you can test at either the command-line level or the
 
17
  internal API level.  Choose whichever is appropriate: if adding a
 
18
  new command, or a new command option, then call through run_bzr().
 
19
  It is not necessary to do both. Tests that test the command line level
 
20
  are appropriate for checking the UI behaves well - bug fixes and
 
21
  core improvements should be tested closer to the code that is doing the
 
22
  work. Command line level tests should be placed in 'blackbox.py'.
 
23
 
 
24
* Try to practice Test-Driven Development.  before fixing a bug, write a
 
25
  test case so that it does not regress.  Similarly for adding a new
 
26
  feature: write a test case for a small version of the new feature before
 
27
  starting on the code itself.  Check the test fails on the old code, then
 
28
  add the feature or fix and check it passes.
 
29
 
 
30
* Exceptions should be defined inside bzrlib.errors, so that we can
 
31
  see the whole tree at a glance.
 
32
 
 
33
* Imports should be done at the top-level of the file, unless there is
 
34
  a strong reason to have them lazily loaded when a particular
 
35
  function runs.  Import statements have a cost, so try to make sure
 
36
  they don't run inside hot functions.
 
37
 
 
38
* Module names should always be given fully-qualified,
 
39
  i.e. ``bzrlib.hashcache`` not just ``hashcache``.
 
40
 
 
41
* Commands should return non-zero when they encounter circumstances that
 
42
  the user should really pay attention to - which includes trivial shell
 
43
  pipelines.
 
44
 
 
45
  Recommended values are 
 
46
    0- OK, 
 
47
    1- Conflicts in merge-like operations, or changes are present in
 
48
       diff-like operations. 
 
49
    2- Unrepresentable diff changes (i.e. binary files that we cannot show 
 
50
       a diff of).
 
51
    3- An error or exception has occurred.
 
52
 
 
53
Evolving interfaces
 
54
-------------------
 
55
 
 
56
If you change the behaviour of an API in an incompatible way, please
 
57
be sure to change its name as well. For instance, if I add a keyword
 
58
parameter to branch.commit - that's fine. On the other hand, if I add
 
59
a keyword parameter to branch.commit which is a *required* transaction
314
60
object, I should rename the API - i.e. to 'branch.commit_transaction'.
315
61
 
316
 
  (Actually, that may break code that provides a new implementation of
317
 
  ``commit`` and doesn't expect to receive the parameter.)
318
 
 
319
 
When renaming such supported API's, be sure to leave a deprecated_method (or
320
 
_function or ...) behind which forwards to the new API. See the
321
 
bzrlib.symbol_versioning module for decorators that take care of the
322
 
details for you - such as updating the docstring, and issuing a warning
323
 
when the old API is used.
324
 
 
325
 
For unsupported API's, it does not hurt to follow this discipline, but it's
326
 
not required. Minimally though, please try to rename things so that
327
 
callers will at least get an AttributeError rather than weird results.
328
 
 
329
 
 
330
 
Deprecation decorators
331
 
----------------------
332
 
 
333
 
``bzrlib.symbol_versioning`` provides decorators that can be attached to
334
 
methods, functions, and other interfaces to indicate that they should no
335
 
longer be used.  For example::
336
 
 
337
 
   @deprecated_method(deprecated_in((0, 1, 4)))
338
 
   def foo(self):
339
 
        return self._new_foo()
340
 
 
341
 
To deprecate a static method you must call ``deprecated_function``
342
 
(**not** method), after the staticmethod call::
343
 
 
344
 
    @staticmethod
345
 
    @deprecated_function(deprecated_in((0, 1, 4)))
346
 
    def create_repository(base, shared=False, format=None):
347
 
 
348
 
When you deprecate an API, you should not just delete its tests, because
349
 
then we might introduce bugs in them.  If the API is still present at all,
350
 
it should still work.  The basic approach is to use
351
 
``TestCase.applyDeprecated`` which in one step checks that the API gives
352
 
the expected deprecation message, and also returns the real result from
353
 
the method, so that tests can keep running.
354
 
 
355
 
Deprecation warnings will be suppressed for final releases, but not for
356
 
development versions or release candidates, or when running ``bzr
357
 
selftest``. This gives developers information about whether their code is
358
 
using deprecated functions, but avoids confusing users about things they
359
 
can't fix.
360
 
 
361
 
 
362
 
Documenting Changes
363
 
===================
364
 
 
365
 
When you change bzrlib, please update the relevant documentation for the
366
 
change you made: Changes to commands should update their help, and
367
 
possibly end user tutorials; changes to the core library should be
368
 
reflected in API documentation.
369
 
 
370
 
NEWS File
 
62
This will prevent users of the old API getting surprising results. 
 
63
Instead, they will get an Attribute error as the API is missing, and
 
64
will know to update their code. If in doubt, just ask on #bzr.
 
65
 
 
66
Documentation
 
67
=============
 
68
 
 
69
If you change the behaviour of a command, please update its docstring
 
70
in bzrlib/commands.py.  This is displayed by the 'bzr help' command.
 
71
 
 
72
NEWS file
371
73
---------
372
74
 
373
75
If you make a user-visible change, please add a note to the NEWS file.
380
82
Within each release, entries in the news file should have the most
381
83
user-visible changes first.  So the order should be approximately:
382
84
 
383
 
 * changes to existing behaviour - the highest priority because the
 
85
 * changes to existing behaviour - the highest priority because the 
384
86
   user's existing knowledge is incorrect
385
87
 * new features - should be brought to their attention
386
88
 * bug fixes - may be of interest if the bug was affecting them, and
387
89
   should include the bug number if any
388
 
 * major documentation changes, including fixed documentation bugs
 
90
 * major documentation changes
389
91
 * changes to internal interfaces
390
92
 
391
93
People who made significant contributions to each change are listed in
392
94
parenthesis.  This can include reporting bugs (particularly with good
393
95
details or reproduction recipes), submitting patches, etc.
394
96
 
395
 
To help with merging, NEWS entries should be sorted lexicographically
396
 
within each section.
397
 
 
398
 
Commands
399
 
--------
400
 
 
401
 
The docstring of a command is used by ``bzr help`` to generate help output
402
 
for the command. The list 'takes_options' attribute on a command is used by
403
 
``bzr help`` to document the options for the command - the command
404
 
docstring does not need to document them. Finally, the '_see_also'
405
 
attribute on a command can be used to reference other related help topics.
406
 
 
407
 
API Documentation
 
97
API documentation
408
98
-----------------
409
99
 
410
100
Functions, methods, classes and modules should have docstrings
411
 
describing how they are used.
 
101
describing how they are used. 
412
102
 
413
103
The first line of the docstring should be a self-contained sentence.
414
104
 
423
113
.. _epydoc: http://epydoc.sourceforge.net/
424
114
 
425
115
 
426
 
General Guidelines
427
 
==================
428
 
 
429
 
Copyright
430
 
---------
431
 
 
432
 
The copyright policy for bzr was recently made clear in this email (edited
433
 
for grammatical correctness)::
434
 
 
435
 
    The attached patch cleans up the copyright and license statements in
436
 
    the bzr source. It also adds tests to help us remember to add them
437
 
    with the correct text.
438
 
 
439
 
    We had the problem that lots of our files were "Copyright Canonical
440
 
    Development Ltd" which is not a real company, and some other variations
441
 
    on this theme. Also, some files were missing the GPL statements.
442
 
 
443
 
    I want to be clear about the intent of this patch, since copyright can
444
 
    be a little controversial.
445
 
 
446
 
    1) The big motivation for this is not to shut out the community, but
447
 
    just to clean up all of the invalid copyright statements.
448
 
 
449
 
    2) It has been the general policy for bzr that we want a single
450
 
    copyright holder for all of the core code. This is following the model
451
 
    set by the FSF, which makes it easier to update the code to a new
452
 
    license in case problems are encountered. (For example, if we want to
453
 
    upgrade the project universally to GPL v3 it is much simpler if there is
454
 
    a single copyright holder). It also makes it clearer if copyright is
455
 
    ever debated, there is a single holder, which makes it easier to defend
456
 
    in court, etc. (I think the FSF position is that if you assign them
457
 
    copyright, they can defend it in court rather than you needing to, and
458
 
    I'm sure Canonical would do the same).
459
 
    As such, Canonical has requested copyright assignments from all of the
460
 
    major contributers.
461
 
 
462
 
    3) If someone wants to add code and not attribute it to Canonical, there
463
 
    is a specific list of files that are excluded from this check. And the
464
 
    test failure indicates where that is, and how to update it.
465
 
 
466
 
    4) If anyone feels that I changed a copyright statement incorrectly, just
467
 
    let me know, and I'll be happy to correct it. Whenever you have large
468
 
    mechanical changes like this, it is possible to make some mistakes.
469
 
 
470
 
    Just to reiterate, this is a community project, and it is meant to stay
471
 
    that way. Core bzr code is copyright Canonical for legal reasons, and
472
 
    the tests are just there to help us maintain that.
473
 
 
474
 
 
475
 
Miscellaneous Topics
476
 
####################
477
 
 
478
 
Debugging
479
 
=========
480
 
 
481
 
Bazaar has a few facilities to help debug problems by going into pdb_, the
482
 
Python debugger.
483
 
 
484
 
.. _pdb: http://docs.python.org/lib/debugger-commands.html
485
 
 
486
 
If the ``BZR_PDB`` environment variable is set
487
 
then bzr will go into pdb post-mortem mode when an unhandled exception
488
 
occurs.
489
 
 
490
 
If you send a SIGQUIT or SIGBREAK signal to bzr then it will drop into the
491
 
debugger immediately. SIGQUIT can be generated by pressing Ctrl-\\ on
492
 
Unix.  SIGBREAK is generated with Ctrl-Pause on Windows (some laptops have
493
 
this as Fn-Pause).  You can continue execution by typing ``c``.  This can
494
 
be disabled if necessary by setting the environment variable
495
 
``BZR_SIGQUIT_PDB=0``.
496
 
 
497
 
 
498
 
Debug Flags
499
 
===========
500
 
 
501
 
Bazaar accepts some global options starting with ``-D`` such as
502
 
``-Dhpss``.  These set a value in `bzrlib.debug.debug_flags`, and
503
 
typically cause more information to be written to the trace file.  Most
504
 
`mutter` calls should be guarded by a check of those flags so that we
505
 
don't write out too much information if it's not needed.
506
 
 
507
 
Debug flags may have effects other than just emitting trace messages.
508
 
 
509
 
Run ``bzr help global-options`` to see them all.
510
 
 
511
 
These flags may also be set as a comma-separated list in the
512
 
``debug_flags`` option in e.g.  ``~/.bazaar/bazaar.conf``.  (Note that it
513
 
must be in this global file, not in the branch or location configuration,
514
 
because it's currently only loaded at startup time.)  For instance you may
515
 
want to always record hpss traces and to see full error tracebacks::
516
 
 
517
 
    debug_flags = hpss, error
 
116
 
 
117
Coding style
 
118
============
 
119
 
 
120
Please write PEP-8__ compliant code.  
 
121
 
 
122
One often-missed requirement is that the first line of docstrings
 
123
should be a self-contained one-sentence summary.
 
124
 
 
125
__ http://www.python.org/peps/pep-0008.html
 
126
 
 
127
 
 
128
 
 
129
Naming
 
130
------
 
131
 
 
132
Functions, methods or members that are in some sense "private" are given
 
133
a leading underscore prefix.  This is just a hint that code outside the
 
134
implementation should probably not use that interface.
 
135
 
 
136
We prefer class names to be concatenated capital words (``TestCase``)
 
137
and variables, methods and functions to be lowercase words joined by
 
138
underscores (``revision_id``, ``get_revision``).
 
139
 
 
140
For the purposes of naming some names are treated as single compound
 
141
words: "filename", "revno".
 
142
 
 
143
Consider naming classes as nouns and functions/methods as verbs.
 
144
 
 
145
 
 
146
Standard names
 
147
--------------
 
148
 
 
149
``revision_id`` not ``rev_id`` or ``revid``
 
150
 
 
151
Functions that transform one thing to another should be named ``x_to_y``
 
152
(not ``x2y`` as occurs in some old code.)
 
153
 
 
154
 
 
155
Destructors
 
156
-----------
 
157
 
 
158
Python destructors (``__del__``) work differently to those of other
 
159
languages.  In particular, bear in mind that destructors may be called
 
160
immediately when the object apparently becomes unreferenced, or at some
 
161
later time, or possibly never at all.  Therefore we have restrictions on
 
162
what can be done inside them.
 
163
 
 
164
 0. Never use a __del__ method without asking Martin/Robert first.
 
165
 
 
166
 1. Never rely on a ``__del__`` method running.  If there is code that
 
167
    must run, do it from a ``finally`` block instead.
 
168
 
 
169
 2. Never ``import`` from inside a ``__del__`` method, or you may crash the
 
170
    interpreter!!
 
171
 
 
172
 3. In some places we raise a warning from the destructor if the object
 
173
    has not been cleaned up or closed.  This is considered OK: the warning
 
174
    may not catch every case but it's still useful sometimes.
 
175
 
 
176
 
 
177
Writing output
 
178
==============
 
179
 
 
180
(The strategy described here is what we want to get to, but it's not
 
181
consistently followed in the code at the moment.)
 
182
 
 
183
bzrlib is intended to be a generically reusable library.  It shouldn't
 
184
write messages to stdout or stderr, because some programs that use it
 
185
might want to display that information through a GUI or some other
 
186
mechanism.
 
187
 
 
188
We can distinguish two types of output from the library:
 
189
 
 
190
 1. Structured data representing the progress or result of an
 
191
    operation.  For example, for a commit command this will be a list
 
192
    of the modified files and the finally committed revision number
 
193
    and id.
 
194
 
 
195
    These should be exposed either through the return code or by calls
 
196
    to a callback parameter.
 
197
 
 
198
    A special case of this is progress indicators for long-lived
 
199
    operations, where the caller should pass a ProgressBar object.
 
200
 
 
201
 2. Unstructured log/debug messages, mostly for the benefit of the
 
202
    developers or users trying to debug problems.  This should always
 
203
    be sent through ``bzrlib.trace`` and Python ``logging``, so that
 
204
    it can be redirected by the client.
 
205
 
 
206
The distinction between the two is a bit subjective, but in general if
 
207
there is any chance that a library would want to see something as
 
208
structured data, we should make it so.
 
209
 
 
210
The policy about how output is presented in the text-mode client
 
211
should be only in the command-line tool.
 
212
 
 
213
 
 
214
Writing tests
 
215
=============
 
216
In general tests should be placed in a file named testFOO.py where 
 
217
FOO is the logical thing under test. That file should be placed in the
 
218
tests subdirectory under the package being tested.
 
219
 
 
220
For example, tests for merge3 in bzrlib belong in bzrlib/tests/testmerge3.py.
 
221
See bzrlib/selftest/testsampler.py for a template test script.
 
222
 
 
223
 
 
224
Running tests
 
225
=============
 
226
Currently, bzr selftest is used to invoke tests.
 
227
You can provide a pattern argument to run a subset. For example, 
 
228
to run just the whitebox tests, run::
 
229
 
 
230
  bzr selftest -v whitebox
 
231
 
 
232
 
 
233
Errors and exceptions
 
234
=====================
 
235
 
 
236
Errors are handled through Python exceptions.  They can represent user
 
237
errors, environmental errors or program bugs.  Sometimes we can't be sure
 
238
at the time it's raised which case applies.  See bzrlib/errors.py for 
 
239
details on the error-handling practices.
518
240
 
519
241
 
520
242
Jargon
525
247
    Revision 0 is always the null revision; others are 1-based
526
248
    indexes into the branch's revision history.
527
249
 
528
 
 
529
 
Unicode and Encoding Support
530
 
============================
531
 
 
532
 
This section discusses various techniques that Bazaar uses to handle
533
 
characters that are outside the ASCII set.
534
 
 
535
 
``Command.outf``
536
 
----------------
537
 
 
538
 
When a ``Command`` object is created, it is given a member variable
539
 
accessible by ``self.outf``.  This is a file-like object, which is bound to
540
 
``sys.stdout``, and should be used to write information to the screen,
541
 
rather than directly writing to ``sys.stdout`` or calling ``print``.
542
 
This file has the ability to translate Unicode objects into the correct
543
 
representation, based on the console encoding.  Also, the class attribute
544
 
``encoding_type`` will effect how unprintable characters will be
545
 
handled.  This parameter can take one of 3 values:
546
 
 
547
 
  replace
548
 
    Unprintable characters will be represented with a suitable replacement
549
 
    marker (typically '?'), and no exception will be raised. This is for
550
 
    any command which generates text for the user to review, rather than
551
 
    for automated processing.
552
 
    For example: ``bzr log`` should not fail if one of the entries has text
553
 
    that cannot be displayed.
554
 
 
555
 
  strict
556
 
    Attempting to print an unprintable character will cause a UnicodeError.
557
 
    This is for commands that are intended more as scripting support, rather
558
 
    than plain user review.
559
 
    For example: ``bzr ls`` is designed to be used with shell scripting. One
560
 
    use would be ``bzr ls --null --unknowns | xargs -0 rm``.  If ``bzr``
561
 
    printed a filename with a '?', the wrong file could be deleted. (At the
562
 
    very least, the correct file would not be deleted). An error is used to
563
 
    indicate that the requested action could not be performed.
564
 
 
565
 
  exact
566
 
    Do not attempt to automatically convert Unicode strings. This is used
567
 
    for commands that must handle conversion themselves.
568
 
    For example: ``bzr diff`` needs to translate Unicode paths, but should
569
 
    not change the exact text of the contents of the files.
570
 
 
571
 
 
572
 
``bzrlib.urlutils.unescape_for_display``
573
 
----------------------------------------
574
 
 
575
 
Because Transports work in URLs (as defined earlier), printing the raw URL
576
 
to the user is usually less than optimal. Characters outside the standard
577
 
set are printed as escapes, rather than the real character, and local
578
 
paths would be printed as ``file://`` urls. The function
579
 
``unescape_for_display`` attempts to unescape a URL, such that anything
580
 
that cannot be printed in the current encoding stays an escaped URL, but
581
 
valid characters are generated where possible.
582
 
 
583
 
 
584
 
C Extension Modules
585
 
===================
586
 
 
587
 
We write some extensions in C using pyrex. We design these to work in
588
 
three scenarios:
589
 
 
590
 
 * User with no C compiler
591
 
 * User with C compiler
592
 
 * Developers
593
 
 
594
 
The recommended way to install bzr is to have a C compiler so that the
595
 
extensions can be built, but if no C compiler is present, the pure python
596
 
versions we supply will work, though more slowly.
597
 
 
598
 
For developers we recommend that pyrex be installed, so that the C
599
 
extensions can be changed if needed.
600
 
 
601
 
For the C extensions, the extension module should always match the
602
 
original python one in all respects (modulo speed). This should be
603
 
maintained over time.
604
 
 
605
 
To create an extension, add rules to setup.py for building it with pyrex,
606
 
and with distutils. Now start with an empty .pyx file. At the top add
607
 
"include 'yourmodule.py'". This will import the contents of foo.py into this
608
 
file at build time - remember that only one module will be loaded at
609
 
runtime. Now you can subclass classes, or replace functions, and only your
610
 
changes need to be present in the .pyx file.
611
 
 
612
 
Note that pyrex does not support all 2.4 programming idioms, so some
613
 
syntax changes may be required. I.e.
614
 
 
615
 
 - 'from foo import (bar, gam)' needs to change to not use the brackets.
616
 
 - 'import foo.bar as bar' needs to be 'import foo.bar; bar = foo.bar'
617
 
 
618
 
If the changes are too dramatic, consider
619
 
maintaining the python code twice - once in the .pyx, and once in the .py,
620
 
and no longer including the .py file.
621
 
 
622
 
 
623
 
Making Installers for OS Windows
624
 
================================
625
 
To build a win32 installer, see the instructions on the wiki page:
626
 
http://wiki.bazaar.canonical.com/BzrWin32Installer
627
 
 
628
 
Core Developer Tasks
629
 
####################
630
 
 
631
 
Overview
632
 
========
633
 
 
634
 
What is a Core Developer?
635
 
-------------------------
636
 
 
637
 
While everyone in the Bazaar community is welcome and encouraged to
638
 
propose and submit changes, a smaller team is reponsible for pulling those
639
 
changes together into a cohesive whole. In addition to the general developer
640
 
stuff covered above, "core" developers have responsibility for:
641
 
 
642
 
* reviewing changes
643
 
* reviewing blueprints
644
 
* planning releases
645
 
* managing releases (see `Releasing Bazaar <http://doc.bazaar.canonical.com/developers/releasing.html>`_)
646
 
 
647
 
.. note::
648
 
  Removing barriers to community participation is a key reason for adopting
649
 
  distributed VCS technology. While DVCS removes many technical barriers,
650
 
  a small number of social barriers are often necessary instead.
651
 
  By documenting how the above things are done, we hope to
652
 
  encourage more people to participate in these activities, keeping the
653
 
  differences between core and non-core contributors to a minimum.
654
 
 
655
 
 
656
 
Communicating and Coordinating
657
 
------------------------------
658
 
 
659
 
While it has many advantages, one of the challenges of distributed
660
 
development is keeping everyone else aware of what you're working on.
661
 
There are numerous ways to do this:
662
 
 
663
 
#. Assign bugs to yourself in Launchpad
664
 
#. Mention it on the mailing list
665
 
#. Mention it on IRC
666
 
 
667
 
As well as the email notifcations that occur when merge requests are sent
668
 
and reviewed, you can keep others informed of where you're spending your
669
 
energy by emailing the **bazaar-commits** list implicitly. To do this,
670
 
install and configure the Email plugin. One way to do this is add these
671
 
configuration settings to your central configuration file (e.g.
672
 
``~/.bazaar/bazaar.conf``)::
673
 
 
674
 
  [DEFAULT]
675
 
  email = Joe Smith <joe.smith@internode.on.net>
676
 
  smtp_server = mail.internode.on.net:25
677
 
 
678
 
Then add these lines for the relevant branches in ``locations.conf``::
679
 
 
680
 
  post_commit_to = bazaar-commits@lists.canonical.com
681
 
  post_commit_mailer = smtplib
682
 
 
683
 
While attending a sprint, RobertCollins' Dbus plugin is useful for the
684
 
same reason. See the documentation within the plugin for information on
685
 
how to set it up and configure it.
686
 
 
687
 
 
688
 
 
689
 
Planning Releases
690
 
=================
691
 
 
692
 
 
693
 
Bug Triage
694
 
----------
695
 
 
696
 
Keeping on top of bugs reported is an important part of ongoing release
697
 
planning. Everyone in the community is welcome and encouraged to raise
698
 
bugs, confirm bugs raised by others, and nominate a priority. Practically
699
 
though, a good percentage of bug triage is often done by the core
700
 
developers, partially because of their depth of product knowledge.
701
 
 
702
 
With respect to bug triage, core developers are encouraged to play an
703
 
active role with particular attention to the following tasks:
704
 
 
705
 
* keeping the number of unconfirmed bugs low
706
 
* ensuring the priorities are generally right (everything as critical - or
707
 
  medium - is meaningless)
708
 
* looking out for regressions and turning those around sooner rather than later.
709
 
 
710
 
.. note::
711
 
  As well as prioritizing bugs and nominating them against a
712
 
  target milestone, Launchpad lets core developers offer to mentor others in
713
 
  fixing them.
714
 
 
715
 
 
716
 
..
717
 
   vim: ft=rst tw=74 ai
 
250
:: vim: tw=74 ai