← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/upgrade-guide/overview.txt

Turn completion assertions into separate methods.

Many common assertions used to be expressed as arguments to the complete
method.  This makes the checks more explicit, and the code easier to read.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/upgrade-guide/overview.txt
1
 
Overview
2
 
########
3
 
 
4
 
High level upgrade process
5
 
--------------------------
6
 
 
7
 
In broad terms, there are 3 steps involved in upgrading a new format:
8
 
 
9
 
1. Upgrade the core software
10
 
 
11
 
2. Upgrade required plugins
12
 
 
13
 
3. Migrate data to the new default format.
14
 
 
15
 
Bazaar supports branches in earlier formats so the third step is strictly not
16
 
required. However, when new default formats are introduced, they are more
17
 
space efficient, faster on large projects and/or provide new features. So it
18
 
is recommended that most projects migrate to it at a convenient time.
19
 
 
20
 
For most users, upgrading and migrating to the new format is straight
21
 
forward. For projects with a large community of developers though, things
22
 
become more complex. In these cases, careful planning and good communications
23
 
become essential. This document provides general advice which aims to assist
24
 
in this regard. If in doubt, please contact us on our mailing list or IRC
25
 
channel with any questions or concerns you have.
26
 
 
27
 
 
28
 
Upgrading the core software
29
 
---------------------------
30
 
 
31
 
The steps required to upgrade the core software vary from operating system to
32
 
operating system.  A brief outline of the steps is given below.
33
 
 
34
 
To upgrade Bazaar on Ubuntu:
35
 
 
36
 
1. Ensure your package manager is configured with the required software
37
 
   sources, e.g. the official stable release PPA for Ubuntu:
38
 
   https://launchpad.net/~bzr/+archive
39
 
 
40
 
2. Use your package manager to upgrade to the latest version.
41
 
 
42
 
To upgrade Bazaar on Windows:
43
 
 
44
 
1. Uninstall the existing version using Add/Remove Programs.
45
 
 
46
 
2. Install the new version using the relevant installer.
47
 
 
48
 
To upgrade Bazaar on OS X (via the installer):
49
 
 
50
 
1. Install the new version using the relevant installer.
51
 
 
52
 
To upgrade Bazaar on OS X (via MacPorts):
53
 
 
54
 
1. Refresh the package metadata using **sudo port selfupdate**
55
 
 
56
 
2. Upgrade to the latest version using **sudo port upgrade bzr**
57
 
 
58
 
For further information on installing and upgrading, see
59
 
http://wiki.bazaar.canonical.com/Download.
60
 
 
61
 
 
62
 
Upgrading required plugins
63
 
--------------------------
64
 
 
65
 
Many plugins are not dependent on a particular Bazaar version so
66
 
upgrading them is optional. Other plugins, notably bzrtools and
67
 
bzr-svn, are more tightly associated with Bazaar's APIs so these
68
 
typically need to be upgraded in lockstep with the core software.
69
 
 
70
 
For Windows and OS X users, bzrtools and bzr-svn are typically included in
71
 
the installer so no special steps are required to upgrade these. For
72
 
Ubuntu and other GNU/Linux or Unix systems users, bztrools, bzr-svn and
73
 
many other popular plugins can be installed and upgraded using your
74
 
platform's package manager, e.g. Synaptic on Ubuntu.
75
 
 
76
 
 
77
 
Migrating data to the new default format
78
 
----------------------------------------
79
 
 
80
 
As mentioned earlier, the complexity of migrating to a new format
81
 
depends on several factors, particularly project community size.
82
 
It also depends on how data is currently stored, e.g. in a
83
 
standalone branch, multiple branches in a shared repository,
84
 
stacked branches on Launchpad, etc. These various scenarios are
85
 
covered in the next chapter.