/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/overview.txt

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/overview.txt
1
1
=============================
2
 
Breezy Architectural Overview
 
2
Bazaar Architectural Overview
3
3
=============================
4
4
 
5
 
This document describes the key classes and concepts within Breezy.  It is
6
 
intended to be useful to people working on the Breezy codebase, or to
 
5
This document describes the key classes and concepts within Bazaar.  It is
 
6
intended to be useful to people working on the Bazaar codebase, or to
7
7
people writing plugins.  People writing plugins may also like to read the 
8
 
guide to `Integrating with Breezy <integration.html>`_ for some specific recipes.
 
8
guide to `Integrating with Bazaar <integration.html>`_ for some specific recipes.
9
9
 
10
10
There's some overlap between this and the `Core Concepts`_ section of the
11
11
user guide, but this document is targetted to people interested in the
15
15
 
16
16
If you have any questions, or if something seems to be incorrect, unclear
17
17
or missing, please talk to us in ``irc://irc.freenode.net/#bzr``, write to
18
 
the Breezy mailing list, or simply file a bug report.
 
18
the Bazaar mailing list, or simply file a bug report.
19
19
 
20
20
 
21
21
IDs and keys
24
24
IDs
25
25
===
26
26
 
27
 
All IDs are globally unique identifiers.  Inside breezy they are almost
 
27
All IDs are globally unique identifiers.  Inside bzrlib they are almost
28
28
always represented as UTF-8 encoded bytestrings (i.e. ``str`` objects).
29
29
 
30
30
The main two IDs are:
33
33
  ``pqm@pqm.ubuntu.com-20110201161347-ao76mv267gc1b5v2``
34
34
:File IDs: The unique identifier of a single file.
35
35
 
36
 
By convention, in the breezy API, parameters of methods that are expected
 
36
By convention, in the bzrlib API, parameters of methods that are expected
37
37
to be IDs (as opposed to keys, revision numbers, or some other handle)
38
38
will end in ``id``, e.g.  ``revid`` or ``file_id``.
39
39
 
40
40
Ids may be stored directly or they can be inferred from other
41
 
data. Native Breezy formats store ids directly; foreign VCS
 
41
data. Native Bazaar formats store ids directly; foreign VCS
42
42
support usually generates them somehow. For example, the
43
43
Git commit with SHA ``fb235a3be6372e40ff7f7ebbcd7905a08cb04444``
44
44
is referred to with the revision ID
82
82
actual file. This means that lookups of file ids doesn't scale with
83
83
the number of nested trees.
84
84
 
85
 
Inventory file ids are only relevant for native Breezy formats; foreign
 
85
Inventory file ids are only relevant for native Bazaar formats; foreign
86
86
formats don't use inventories.
87
87
 
88
88
Transform ids
160
160
 
161
161
See also:
162
162
 
163
 
* `Developer guide to breezy transports <transports.html>`_ 
164
 
* API docs for ``breezy.transport.Transport``
 
163
* `Developer guide to bzrlib transports <transports.html>`_ 
 
164
* API docs for ``bzrlib.transport.Transport``
165
165
 
166
166
Control directory
167
167
=================
188
188
Trees have an inventory and parents (an ordered list of zero or more
189
189
revision IDs).
190
190
 
191
 
The implementation of ``Tree`` for Breezy's own formats is based around
 
191
The implementation of ``Tree`` for Bazaar's own formats is based around
192
192
``Inventory`` objects which describe the shape of the tree. Each tree has
193
193
at least one inventory associated with it, which is available as the
194
194
``root_inventory`` attribute on tree. The tree can have more inventories