|
505
by Aaron Bentley
Add packaging notes |
1 |
Notes to packagers |
2 |
##################
|
|
3 |
||
4 |
Hi there, |
|
5 |
||
6 |
Thank you for packaging Bzrtools. Here are some notes. |
|
7 |
||
8 |
Bazaar version |
|
9 |
==============
|
|
10 |
Bzrtools' major and minor version number should be the same as Bazaar's. |
|
11 |
||
12 |
Newer versions of Bzrtools may use APIs that are not present in older Bazaar |
|
13 |
versions. To be on the safe side, Bzrtools disables itself in this |
|
14 |
situation. |
|
15 |
||
16 |
Old versions of Bzrtools may use APIs that are deprecated in newer versions |
|
17 |
of Bazaar. The deprecation period is one release, typically one month. |
|
18 |
So technically, slightly old versions of Bzrtools should work with newer |
|
19 |
versions of Bazaar. But even so, they will emit unpleasant deprecation |
|
20 |
warnings. |
|
21 |
||
22 |
In order to make things easier on maintainers, I've adopted the policy of |
|
23 |
releasing Bzrtools around the same time as the Bazaar release candidate. |
|
24 |
This gives you about a week of lead time before the final Bazaar release. |
|
25 |
||
26 |
Bzrtools releases are announced the bazaar@canonical.com and |
|
27 |
bazaar-announce@canonical.com mailing lists. |
|
28 |
||
29 |
Other dependencies |
|
30 |
==================
|
|
31 |
Certain bzrtools use or can use tools from the following packages: |
|
32 |
||
33 |
- rsync (rspush) |
|
34 |
- diff (shelve/unshelve) |
|
35 |
- patch (shelve/unshelve) |
|
36 |
- pybaz (baz-import) |
|
37 |
- librsvg-bin (graph-ancestry) |
|
38 |
||
39 |
This can be treated as recommended rather than hard dependencies. |
|
40 |
||
41 |
Additionally, the test suite uses testresources. |
|
42 |
||
43 |
Testing
|
|
44 |
=======
|
|
45 |
Note that Medusa is not required for the Bzrtools test suite. Medusa is used |
|
46 |
strictly by Bazaar, but ``bzr selftest bzrtools`` will suggest installing |
|
47 |
Medusa, because ``bzr selftest`` always suggests installing Medusa. |
|
48 |
||
49 |
If you prefer, you can run the ``test.py`` script provided. It runs the same |
|
50 |
tests as ``bzr selftest bzrtools``. |