← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/overview.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-20 02:55:35 UTC
  • mfrom: (4170.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090320025535-havsm27xdtwnpl42
Copy-edits to developer docs (Eric Siegerman)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/overview.txt
3
3
=============================
4
4
 
5
5
This document describes the key classes and concepts within Bazaar.  It is
6
 
intended to be useful to be useful to people working on the Bazaar
7
 
codebase, or to people writing plugins.
 
6
intended to be useful to people working on the Bazaar codebase, or to
 
7
people writing plugins.
8
8
 
9
 
If you have any questions or something seems to be incorrect, unclear or
10
 
missing, please talk to us in ``irc://irc.freenode.net/#bzr``, or write to
11
 
the Bazaar mailing list.  To propose a correction or addition to this
 
9
If you have any questions, or if something seems to be incorrect, unclear
 
10
or missing, please talk to us in ``irc://irc.freenode.net/#bzr``, or write
 
11
to the Bazaar mailing list.  To propose a correction or addition to this
12
12
document, send a merge request or new text to the mailing list.
13
13
 
14
14
The current version of this document is available in the file
43
43
#########
44
44
 
45
45
The ``Transport`` layer handles access to local or remote directories.
46
 
Each Transport object acts like a logical connection to a particular
 
46
Each Transport object acts as a logical connection to a particular
47
47
directory, and it allows various operations on files within it.  You can
48
48
*clone* a transport to get a new Transport connected to a subdirectory or
49
49
parent directory.
50
50
 
51
51
Transports are not used for access to the working tree.  At present
52
52
working trees are always local and they are accessed through the regular
53
 
Python file io mechanisms.
 
53
Python file I/O mechanisms.
54
54
 
55
55
Filenames vs URLs
56
56
=================
57
57
 
58
 
Transports work in URLs.  Take note that URLs are by definition only
59
 
ASCII - the decision of how to encode a Unicode string into a URL must be
60
 
taken at a higher level, typically in the Store.  (Note that Stores also
61
 
escape filenames which cannot be safely stored on all filesystems, but
62
 
this is a different level.)
 
58
Transports work in terms of URLs.  Take note that URLs are by definition
 
59
only ASCII - the decision of how to encode a Unicode string into a URL
 
60
must be taken at a higher level, typically in the Store.  (Note that
 
61
Stores also escape filenames which cannot be safely stored on all
 
62
filesystems, but this is a different level.)
63
63
 
64
64
The main reason for this is that it's not possible to safely roundtrip a
65
65
URL into Unicode and then back into the same URL.  The URL standard
67
67
doesn't say how those bytes represent non-ASCII characters.  (They're not
68
68
guaranteed to be UTF-8 -- that is common but doesn't happen everywhere.)
69
69
 
70
 
For example if the user enters the url ``http://example/%e0`` there's no
 
70
For example, if the user enters the URL ``http://example/%e0``, there's no
71
71
way to tell whether that character represents "latin small letter a with
72
 
grave" in iso-8859-1, or "latin small letter r with acute" in iso-8859-2
73
 
or malformed UTF-8.  So we can't convert their URL to Unicode reliably.
74
 
 
75
 
Equally problematic if we're given a url-like string containing non-ascii
76
 
characters (such as the accented a) we can't be sure how to convert that
77
 
to the correct URL, because we don't know what encoding the server expects
78
 
for those characters.  (Although this is not totally reliable we might still
79
 
accept these and assume they should be put into UTF-8.)
80
 
 
81
 
A similar edge case is that the url ``http://foo/sweet%2Fsour`` contains
 
72
grave" in iso-8859-1, or "latin small letter r with acute" in iso-8859-2,
 
73
or malformed UTF-8.  So we can't convert the URL to Unicode reliably.
 
74
 
 
75
Equally problematic is if we're given a URL-like string containing
 
76
(unescaped) non-ASCII characters (such as the accented a).  We can't be
 
77
sure how to convert that to a valid (i.e. ASCII-only) URL, because we
 
78
don't know what encoding the server expects for those characters.
 
79
(Although it is not totally reliable, we might still accept these and
 
80
assume that they should be put into UTF-8.)
 
81
 
 
82
A similar edge case is that the URL ``http://foo/sweet%2Fsour`` contains
82
83
one directory component whose name is "sweet/sour".  The escaped slash is
83
 
not a directory separator.  If we try to convert URLs to regular Unicode
84
 
paths this information will be lost.
 
84
not a directory separator, but if we try to convert the URL to a regular
 
85
Unicode path, this information will be lost.
85
86
 
86
 
This implies that Transports must natively deal with URLs; for simplicity
87
 
they *only* deal with URLs and conversion of other strings to URLs is done
88
 
elsewhere.  Information they return, such as from ``list_dir``, is also in
89
 
the form of URL components.
 
87
This implies that Transports must natively deal with URLs.  For simplicity
 
88
they *only* deal with URLs; conversion of other strings to URLs is done
 
89
elsewhere.  Information that Transports return, such as from ``list_dir``,
 
90
is also in the form of URL components.
90
91
 
91
92
 
92
93
Repository
98
99
Stacked Repositories
99
100
====================
100
101
 
101
 
Repositories can be configured to refer to a list of "fallback"
 
102
A repository can be configured to refer to a list of "fallback"
102
103
repositories.  If a particular revision is not present in the original
103
104
repository, it refers the query to the fallbacks.
104
105
 
105
106
Compression deltas don't span physical repository boundaries.  So the
106
 
first commit to a new empty repository with fallback repositories will
 
107
first commit to a new, empty repository with fallback repositories will
107
108
store a full text of the inventory, and of every new file text.
108
109
 
109
110
At runtime, repository stacking is actually configured by the branch, not
110
111
the repository.  So doing ``a_bzrdir.open_repository()`` 
111
112
gets you just the single physical repository, while 
112
113
``a_bzrdir.open_branch().repository`` gets one configured with a stacking. 
113
 
Therefore to permanently change the fallback repository stored on disk,
 
114
Therefore, to permanently change the fallback repository stored on disk,
114
115
you must use ``Branch.set_stacked_on_url``.  
115
116
 
116
 
Changing away from an existing stacked on url will copy across any
 
117
Changing away from an existing stacked-on URL will copy across any
117
118
necessary history so that the repository remains usable.
118
119
 
119
 
A repository opened from an hpss server is never stacked on the server
 
120
A repository opened from an HPSS server is never stacked on the server
120
121
side, because this could cause complexity or security problems with the
121
122
server acting as a proxy for the client.  Instead, the branch on the
122
123
server exposes the stacked-on URL and the client can open that.