26
31
For other platforms and to install from source code, see the Download_
27
32
and Installation_ pages.
29
.. _installation instructions for Windows: http://wiki.bazaar.canonical.com/WindowsDownloads
30
.. _installation instructions for Mac OS X: http://wiki.bazaar.canonical.com/MacOSXBundle
31
.. _Download: http://wiki.bazaar.canonical.com/Download
32
.. _Installation: http://wiki.bazaar.canonical.com/InstallationFaq
34
.. _installation instructions for Windows: http://bazaar-vcs.org/WindowsDownloads
35
.. _installation instructions for Mac OS X: http://bazaar-vcs.org/MacOSXBundle
36
.. _Download: http://bazaar-vcs.org/Download
37
.. _Installation: http://bazaar-vcs.org/InstallationFaq
35
40
Introducing yourself
36
41
====================
38
Bazaar records changes to source code, and it records who made the change.
39
The person is identified by their name and email address. (If you're
40
concerned about spam, you don't need to use a real address that you
41
actually read, but the convention is that it looks like an email address.)
43
Before you start working, it is good to tell Bazaar who you are. That
44
way your work is properly identified in revision logs.
43
Before you start working, let's tell Bazaar who you are. Using your name
44
and email address, instead of John Doe's, type::
46
Using your name and email address, instead of John Doe's, type::
46
48
$ bzr whoami "John Doe <john.doe@gmail.com>"
50
Bazaar will now create or modify a configuration file, including your
51
name and email address.
48
You can check what identity is stored in Bazaar's configuration::
53
Now, check that your name and email address are correctly registered::
51
56
John Doe <john.doe@gmail.com>
54
Starting a new project
55
======================
57
Let's suppose we want to store a new project under Bazaar. First, we'll
58
make a *repository directory* to hold all our work related to this
59
project, where developers can create branches to test development of
60
specific features or, more generally, modifications to the working file
63
After creating the repository, change to that directory, and create the
64
project's main trunk branch.
68
$ bzr init-repo sample
69
Shared repository with trees (format: 2a)
71
shared repository: sample
72
$ bzr init sample/trunk
74
Created a repository tree (format: 2a)
75
Using shared repository: /home/john/sample/
81
Now that we have the trunk, we need to move to that directory and
82
create some example files for the first version of that project. Create
83
a file ``test1.txt`` using a text editor (like emacs, nano, or notepad),
84
and save it. Then we'll "add" the file, which tells bzr we want it to
89
and then commit, which saves a snapshot of all versioned files::
91
bzr commit -m "Added first line of text"
59
Putting files under version control
60
===================================
62
Let's create a directory and some files to use with Bazaar::
67
$ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
69
**Note for Windows users:** use Windows Explorer to create your
70
directories, then right-click in those directories and select
71
``New file`` to create your files.
73
Now get Bazaar to initalize itself in your project directory::
77
If it looks like nothing happened, don't worry. Bazaar has created a
78
branch_ where it will store your files and their revision histories.
80
.. _branch: http://bazaar-vcs.org/Branch
82
The next step is to tell Bazaar which files you want to track. Running
83
``bzr add`` will recursively add everything in the project::
90
added subdirectory/test4.txt
92
Next, take a snapshot of your files by committing them to your branch. Add
93
a message to explain why you made the commit::
95
$ bzr commit -m "Initial import"
97
As Bazaar is a distributed version control system, it doesn't need to
98
connect to a central server to make the commit. Instead, Bazaar stores your
99
branch and all its commits inside the directory you're working with; look
100
for the ``.bzr`` sub-directory.
94
103
Making changes to your files
95
104
============================
98
106
Let's change a file and commit that change to your branch.
100
Edit ``test1.txt`` in your favourite editor, then use ``bzr add`` to tell bzr
101
to track changes to this file ::
103
$ echo test test test > test1.txt
107
`bzr diff` shows the changes between the last revision in this branch, and your
108
current tree (or, with the ``-r`` option, between any two trees). ::
108
Edit ``test1.txt`` in your favourite editor, then check what have you done::
111
111
=== modified file 'test1.txt'
127
126
You can see the history of your branch by browsing its log::
129
------------------------------------------------------------
131
committer: John Doe <john.doe@gmail.com>
132
branch nick: myproject
133
timestamp: Mon 2007-10-08 17:56:14 +0000
135
Added first line of text
136
------------------------------------------------------------
131
138
committer: John Doe <john.doe@gmail.com>
139
branch nick: myproject
133
140
timestamp: Mon 2006-10-08 17:46:22 +0000
138
Publishing your branch on Launchpad
139
===================================
141
Launchpad is a suite of development and hosting tools for
142
software projects. You can use it to publish your branch. (You can
143
also publish branches onto your own server or other hosting services.)
145
The steps to publishing branches on Launchpad are:
147
1. Create a Launchpad account: visit the `Launchpad login page`_ and choose to create a new account.
149
.. _Launchpad login page: https://launchpad.net/+login
151
2. Bazaar uses the SSH encryption and authentication protocol to connect
152
to Launchpad. You need to first `create an SSH key`_ on your own computer,
153
by running the command::
157
.. _create an SSH key: https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair
159
3. `Upload your SSH public key to Launchpad`_.
161
.. _Upload your SSH public key to Launchpad: https://launchpad.net/~/+editsshkeys
163
4. `Make a team for your project`_. Even if you're starting as the only
164
developer on this project, creating a new one now will let you more
165
easily add other people later.
167
.. _Make a team for your project: https://help.launchpad.net/Teams/CreatingAndRunning
169
5. `Create a project`_.
171
.. _Create a project: https://help.launchpad.net/Projects/Registering
173
6. Tell Bazaar your Launchpad account name. If your account is john.doe, type ::
175
$ bzr launchpad-login john.doe
177
7. `Push the branch for your project`_. Once you've committed your changes
178
locally, you can publish them as the trunk of your new project by saying
180
$ bzr push lp:~sample-developers/sample/trunk
182
(Of course, using the team and project names you just chose.)
184
.. _Push the branch for your project: https://help.launchpad.net/Code/UploadingABranch
145
Publishing your branch with sftp
146
================================
148
There are a couple of ways to publish your branch. If you already have
149
an SFTP server or are comfortable setting one up, you can publish your
152
Otherwise, skip to the next section to publish with Launchpad_, a free
153
hosting service for Bazaar.
155
.. _Launchpad: https://launchpad.net/
157
Let's assume you want to publish your branch at ``www.example.com/myproject``::
159
$ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
160
2 revision(s) pushed.
162
Bazaar will create a ``myproject`` directory on the remote server and
163
push your branch to it.
165
Now anyone can create their own copy of your branch by typing::
167
$ bzr branch http://www.example.com/myproject
169
**Note:** to use sftp, you may need to install ``paramiko`` and
170
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
173
Publishing your branch with Launchpad
174
=====================================
176
Launchpad is a suite of development and hosting tools for free
177
software projects. You can use it to publish your branch.
179
If you don't have a Launchpad account, follow the `account signup guide`_
180
and `register an SSH key`_ in your new Launchpad account.
182
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
183
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
185
Replacing ``john.doe`` with your own Launchpad username, type::
187
$ bzr push bzr+ssh://john.doe@bazaar.launchpad.net/~john.doe/+junk/myproject
189
**Note:** ``+junk`` means that this branch isn't associated with any particular
190
project in Launchpad.
192
Now, anyone can create their own copy of your branch by typing::
194
$ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject
196
You can also see information about your branch, including its revision
197
history, at https://code.launchpad.net/people/+me/+junk/myproject
186
200
Creating your own copy of another branch
187
201
========================================
189
To work with someone else's code, you can make your own copy of their
203
To work with someone else's code, you can make your own copy of their
190
204
branch. Let's take a real-world example, Bazaar's GTK interface::
192
$ bzr init-repo ~/bzr-gtk
193
$ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
194
Branched 292 revision(s).
206
$ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john
207
Branched 292 revision(s).
196
209
Bazaar will download all the files and complete revision history from the
197
bzr-gtk project's trunk branch and create a copy called ``john``.
210
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
199
Now, you have your own copy of the branch and can commit changes with
200
or without a net connection. You can share your branch at any time by
201
publishing it and, if the bzr-gtk team want to use your work, Bazaar
212
Now, you have your own copy of the branch and can commit changes with
213
or without a net connection. You can share your branch at any time by
214
publishing it and, if the bzr-gtk team want to use your work, Bazaar
202
215
makes it easy for them to merge your branch back into their trunk branch.
added
removed
doc/en/mini-tutorial/index.txt
