← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

[merge] jelmer

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
38
38
  the user should really pay attention to - which includes trivial shell
39
39
  pipelines.
40
40
 
41
 
  Recommanded values are 
 
41
  Recommended values are 
42
42
    0- OK, 
43
43
    1- Conflicts in merge-like operations, or changes are present in
44
44
       diff-like operations. 
45
45
    2- Unrepresentable diff changes (i.e. binary files that we cannot show 
46
46
       a diff of).
47
 
    3- An error or exception has occured.
 
47
    3- An error or exception has occurred.
48
48
 
49
49
Evolving interfaces
50
50
-------------------
53
53
be sure to change its name as well. For instance, if I add a keyword
54
54
parameter to branch.commit - that's fine. On the other hand, if I add
55
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'.
 
56
object, I should rename the API - i.e. to 'branch.commit_transaction'.
57
57
 
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
 
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
60
will know to update their code. If in doubt, just ask on #bzr.
61
61
 
62
62
Documentation