1
============================
2
Guidelines for modifying bzr
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)
13
* New functionality should have test cases. Preferably write the
14
test before writing the code.
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.
21
* Before fixing a bug, write a test case so that it does not regress.
23
* Exceptions should be defined inside bzrlib.errors, so that we can
24
see the whole tree at a glance.
26
* Imports should be done at the top-level of the file, unless there is
27
a strong reason to have them lazily loaded when a particular
28
function runs. Import statements have a cost, so try to make sure
29
they don't run inside hot functions.
31
* Module names should always be given fully-qualified,
32
i.e. ``bzrlib.hashcache`` not just ``hashcache``.
38
If you change the behaviour of an API in an incompatible way, please
39
be sure to change its name as well. For instance, if I add a keyword
40
parameter to branch.commit - that's fine. On the other hand, if I add
41
a keyword parameter to branch.commit which is a *required* transaction
42
object, I should rename the api - i.e. to 'branch.commit_transaction'.
44
This will prevent users of the old api getting surprising results.
45
Instead, they will get an Attribute error as the api is missing, and
46
will know to update their code. If in doubt, just ask on #bzr.
52
If you change the behaviour of a command, please update its docstring
53
in bzrlib/commands.py. This is displayed by the 'bzr help' command.
55
If you make a user-visible change, please add a note to the NEWS file.
56
The description should be written to make sense to someone who's just
57
a user of bzr, not a developer: new functions or classes shouldn't be
58
mentioned, but new commands, changes in behaviour or fixed nontrivial
59
bugs should be listed. See the existing entries for an idea of what
66
Functions, methods, classes and modules should have docstrings
67
describing how they are used.
69
The first line of the docstring should be a self-contained sentence.
71
For the special case of Command classes, this acts as the user-visible
72
documentation shown by the help command.
74
The docstrings should be formatted as reStructuredText_ (like this
75
document), suitable for processing using the epydoc_ tool into HTML
78
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
79
.. _epydoc: http://epydoc.sourceforge.net/
86
Please write PEP-8__ compliant code.
88
One often-missed requirement is that the first line of docstrings
89
should be a self-contained one-sentence summary.
91
__ http://www.python.org/peps/pep-0008.html
98
Functions, methods or members that are in some sense "private" are given
99
a leading underscore prefix. This is just a hint that code outside the
100
implementation should probably not use that interface.
102
We prefer class names to be concatenated capital words (``TestCase``)
103
and variables, methods and functions to be lowercase words joined by
104
underscores (``revision_id``, ``get_revision``).
106
For the purposes of naming some names are treated as single compound
107
words: "filename", "revno".
109
Consider naming classes as nouns and functions/methods as verbs.
115
``revision_id`` not ``rev_id`` or ``revid``
117
Functions that transform one thing to another should be named ``x_to_y``
118
(not ``x2y`` as occurs in some old code.)
124
(The strategy described here is what we want to get to, but it's not
125
consistently followed in the code at the moment.)
127
bzrlib is intended to be a generically reusable library. It shouldn't
128
write messages to stdout or stderr, because some programs that use it
129
might want to display that information through a GUI or some other
132
We can distinguish two types of output from the library:
134
1. Structured data representing the progress or result of an
135
operation. For example, for a commit command this will be a list
136
of the modified files and the finally committed revision number
139
These should be exposed either through the return code or by calls
140
to a callback parameter.
142
A special case of this is progress indicators for long-lived
143
operations, where the caller should pass a ProgressBar object.
145
2. Unstructured log/debug messages, mostly for the benefit of the
146
developers or users trying to debug problems. This should always
147
be sent through ``bzrlib.trace`` and Python ``logging``, so that
148
it can be redirected by the client.
150
The distinction between the two is a bit subjective, but in general if
151
there is any chance that a library would want to see something as
152
structured data, we should make it so.
154
The policy about how output is presented in the text-mode client
155
should be only in the command-line tool.
159
In general tests should be placed in a file named test_FOO.py where
160
FOO is the logical thing under test. That file should be placed in the
161
tests subdirectory under the package being tested.
163
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
167
Currently, bzr selftest is used to invoke tests.
168
You can provide a pattern argument to run a subset. For example,
169
to run just the whitebox tests, run bzr selftest --pattern .*whitebox.*
176
Integer identifier for a revision on the main line of a branch.
177
Revision 0 is always the null revision; others are 1-based
178
indexes into the branch's revision history.