~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/principles.txt

  • Committer: Martin Pool
  • Date: 2009-12-14 04:58:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4891.
  • Revision ID: mbp@sourcefrog.net-20091214045808-80g7pac284k3unh6
Note about branch.conf being a .bzr file you can edit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
 
5
5
We have learned or adopted a few general principles for code in Bazaar.
6
6
Generally we will try to follow them in future, either for consistency or
7
 
because they've been proven to work well, or both.  We may need to depart
8
 
from these principles in particular cases or modify them as we learn more.
 
7
because they've been proven to work well, or both.  
 
8
 
 
9
We may need to depart from these principles in particular special cases,
 
10
or modify them as we learn more, or we might be diverging for them for no
 
11
very good reason but just because of bugs.  If in doubt, ask.  
9
12
 
10
13
See also: `Bazaar Developer Document Catalog <index.html>`_.
11
14
 
50
53
them.  Within bzr, code addressing the abstract interface of the Branch,
51
54
BzrDir, etc shouldn't know where or how the internal files are stored.  If
52
55
anything else is written in there, it won't be propagated when pushing or
53
 
pulling, and won't be converted when upgrading.
 
56
pulling, and won't be converted when upgrading.  (This is not quite true
 
57
though; there is a ``branch.conf``.)
54
58
 
55
59
User files within the tree, by contrast, we always store and return
56
60
verbatim.  It's OK for Bazaar to read and act on these files (as we do