1
1
============================
2
guidelines for modifying bzr
2
Guidelines for modifying bzr
3
3
============================
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)
5
13
* New functionality should have test cases. Preferably write the
6
14
test before writing the code.
8
16
In general, you can test at either the command-line level or the
9
17
internal API level. Choose whichever is appropriate: if adding a
10
18
new command, or a new command option, then call through run_bzr().
11
It is not necessary to do both.
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'.
13
24
* Before fixing a bug, write a test case so that it does not regress.
20
31
function runs. Import statements have a cost, so try to make sure
21
32
they don't run inside hot functions.
23
* Please write PEP-8__ compliant code.
25
One often-missed requirement is that the first line of docstrings
26
should be a self-contained one-sentence summary.
28
__ http://www.python.org/peps/pep-0008.html
30
34
* Module names should always be given fully-qualified,
31
35
i.e. ``bzrlib.hashcache`` not just ``hashcache``.
37
* Commands should return Non-Zero when they encounter circumstances that
38
the user should really pay attention to - which includes trivial shell
41
Recommended values are
43
1- Conflicts in merge-like operations, or changes are present in
45
2- Unrepresentable diff changes (i.e. binary files that we cannot show
47
3- An error or exception has occurred.
52
If you change the behaviour of an API in an incompatible way, please
53
be sure to change its name as well. For instance, if I add a keyword
54
parameter to branch.commit - that's fine. On the other hand, if I add
55
a keyword parameter to branch.commit which is a *required* transaction
56
object, I should rename the API - i.e. to 'branch.commit_transaction'.
58
This will prevent users of the old API getting surprising results.
59
Instead, they will get an Attribute error as the API is missing, and
60
will know to update their code. If in doubt, just ask on #bzr.
45
75
bugs should be listed. See the existing entries for an idea of what
78
Within each release, entries in the news file should have the most
79
user-visible changes first. So the order should be approximately:
81
* changes to existing behaviour - the highest priority because the
82
user's existing knowledge is incorrect
83
* new features - should be brought to their attention
84
* bug fixes - may be of interest if the bug was affecting them, and
85
should include the bug number if any
86
* major documentation changes
87
* changes to internal interfaces
89
People who made significant contributions to each change are listed in
90
parenthesis. This can include reporting bugs (particularly with good
91
details or reproduction recipes), submitting patches, etc.
96
Functions, methods, classes and modules should have docstrings
97
describing how they are used.
99
The first line of the docstring should be a self-contained sentence.
101
For the special case of Command classes, this acts as the user-visible
102
documentation shown by the help command.
104
The docstrings should be formatted as reStructuredText_ (like this
105
document), suitable for processing using the epydoc_ tool into HTML
108
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
109
.. _epydoc: http://epydoc.sourceforge.net/
116
Please write PEP-8__ compliant code.
118
One often-missed requirement is that the first line of docstrings
119
should be a self-contained one-sentence summary.
121
__ http://www.python.org/peps/pep-0008.html
128
Functions, methods or members that are in some sense "private" are given
129
a leading underscore prefix. This is just a hint that code outside the
130
implementation should probably not use that interface.
132
We prefer class names to be concatenated capital words (``TestCase``)
133
and variables, methods and functions to be lowercase words joined by
134
underscores (``revision_id``, ``get_revision``).
136
For the purposes of naming some names are treated as single compound
137
words: "filename", "revno".
139
Consider naming classes as nouns and functions/methods as verbs.
145
``revision_id`` not ``rev_id`` or ``revid``
147
Functions that transform one thing to another should be named ``x_to_y``
148
(not ``x2y`` as occurs in some old code.)
154
Python destructors (``__del__``) work differently to those of other
155
languages. In particular, bear in mind that destructors may be called
156
immediately when the object apparently becomes unreferenced, or at some
157
later time, or possibly never at all. Therefore we have restrictions on
158
what can be done inside them.
160
0. Never use a __del__ method without asking Martin/Robert first.
162
1. Never rely on a ``__del__`` method running. If there is code that
163
must run, do it from a ``finally`` block instead.
165
2. Never ``import`` from inside a ``__del__`` method, or you may crash the
168
3. In some places we raise a warning from the destructor if the object
169
has not been cleaned up or closed. This is considered OK: the warning
170
may not catch every case but it's still useful sometimes.
83
206
The policy about how output is presented in the text-mode client
84
207
should be only in the command-line tool.
88
In general tests should be placed in a file named test_FOO.py where
212
In general tests should be placed in a file named testFOO.py where
89
213
FOO is the logical thing under test. That file should be placed in the
90
214
tests subdirectory under the package being tested.
92
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
216
For example, tests for merge3 in bzrlib belong in bzrlib/tests/testmerge3.py.
217
See bzrlib/selftest/testsampler.py for a template test script.
96
222
Currently, bzr selftest is used to invoke tests.
97
223
You can provide a pattern argument to run a subset. For example,
98
to run just the whitebox tests, run bzr selftest --pattern .*whitebox.*
224
to run just the whitebox tests, run::
226
bzr selftest -v whitebox
229
Errors and exceptions
230
=====================
232
Errors are handled through Python exceptions. They can represent user
233
errors, environmental errors or program bugs. Sometimes we can't be sure
234
at the time it's raised which case applies. See bzrlib/errors.py for
235
details on the error-handling practices.
242
Integer identifier for a revision on the main line of a branch.
243
Revision 0 is always the null revision; others are 1-based
244
indexes into the branch's revision history.
added
removed
HACKING
