/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 bzrlib/__init__.py

  • Committer: mernst at mit
  • Date: 2008-10-16 10:57:16 UTC
  • mto: This revision was merged to the branch mainline in revision 3799.
  • Revision ID: mernst@csail.mit.edu-20081016105716-v8x8n5t2pf7f6uds
Improved documentation of stacked and lightweight branches

These patches improve the User Guide's documentation of stacked and
lightweight branches.

Section "1.2.6 Putting the concepts together" should mention stacked
branches and the difference between them and lightweight branches.  It
should also contain links to further details of the common scenarios.

Section "5.3.4 Getting a lightweight checkout" should mention stacked
branches as an option, and should link to all the options, not just some of
them.  It should also clarify that lightweight only applies to checkouts,
not to arbitrary branches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""bzr library"""
 
18
 
 
19
import time
 
20
 
 
21
# Keep track of when bzrlib was first imported, so that we can give rough
 
22
# timestamps relative to program start in the log file kept by bzrlib.trace.
 
23
_start_time = time.time()
 
24
 
 
25
import sys
 
26
if getattr(sys, '_bzr_lazy_regex', False):
 
27
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
 
28
    # hack as soon as possible so that as much of the standard library can
 
29
    # benefit, including the 'string' module.
 
30
    del sys._bzr_lazy_regex
 
31
    import bzrlib.lazy_regex
 
32
    bzrlib.lazy_regex.install_lazy_compile()
 
33
 
 
34
from bzrlib.osutils import get_user_encoding
 
35
 
 
36
 
 
37
IGNORE_FILENAME = ".bzrignore"
 
38
 
 
39
 
 
40
# XXX: Compatibility. This should probably be deprecated
 
41
user_encoding = get_user_encoding()
 
42
 
 
43
 
 
44
__copyright__ = "Copyright 2005, 2006, 2007, 2008 Canonical Ltd."
 
45
 
 
46
# same format as sys.version_info: "A tuple containing the five components of
 
47
# the version number: major, minor, micro, releaselevel, and serial. All
 
48
# values except releaselevel are integers; the release level is 'alpha',
 
49
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
 
50
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
51
# releaselevel of 'dev' for unreleased under-development code.
 
52
 
 
53
version_info = (1, 9, 0, 'dev', 0)
 
54
 
 
55
 
 
56
# API compatibility version: bzrlib is currently API compatible with 1.7.
 
57
api_minimum_version = (1, 7, 0)
 
58
 
 
59
 
 
60
def _format_version_tuple(version_info):
 
61
    """Turn a version number 3-tuple or 5-tuple into a short string.
 
62
 
 
63
    This format matches <http://docs.python.org/dist/meta-data.html>
 
64
    and the typical presentation used in Python output.
 
65
 
 
66
    This also checks that the version is reasonable: the sub-release must be
 
67
    zero for final releases, and non-zero for alpha, beta and preview.
 
68
 
 
69
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
 
70
    1.0
 
71
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
 
72
    1.2dev
 
73
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
 
74
    1.1.1rc2
 
75
    >>> print _format_version_tuple((1, 4, 0))
 
76
    1.4
 
77
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
 
78
    Traceback (most recent call last):
 
79
    ...
 
80
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
 
81
    """
 
82
    if version_info[2] == 0:
 
83
        main_version = '%d.%d' % version_info[:2]
 
84
    else:
 
85
        main_version = '%d.%d.%d' % version_info[:3]
 
86
    if len(version_info) <= 3:
 
87
        return main_version
 
88
 
 
89
    __release_type = version_info[3]
 
90
    __sub = version_info[4]
 
91
 
 
92
    # check they're consistent
 
93
    if __release_type == 'final' and __sub == 0:
 
94
        __sub_string = ''
 
95
    elif __release_type == 'dev' and __sub == 0:
 
96
        __sub_string = 'dev'
 
97
    elif __release_type in ('alpha', 'beta') and __sub != 0:
 
98
        __sub_string = __release_type[0] + str(__sub)
 
99
    elif __release_type == 'candidate' and __sub != 0:
 
100
        __sub_string = 'rc' + str(__sub)
 
101
    else:
 
102
        raise ValueError("version_info %r not valid" % (version_info,))
 
103
 
 
104
    version_string = '%d.%d.%d.%s.%d' % version_info
 
105
    return main_version + __sub_string
 
106
 
 
107
__version__ = _format_version_tuple(version_info)
 
108
version_string = __version__
 
109
 
 
110
 
 
111
# allow bzrlib plugins to be imported.
 
112
import bzrlib.plugin
 
113
bzrlib.plugin.set_plugins_path()
 
114
 
 
115
 
 
116
def test_suite():
 
117
    import tests
 
118
    return tests.test_suite()