Bazaar Explorer logo Bazaar Explorer - Version Control for Human Beings

Bazaar Explorer Visual Tour (Mac OS X)

Introduction

This tour shows Bazaar Explorer running on a Mac OS X desktop. If you are using another desktop, you may prefer to take the GNOME, KDE or Windows tour.

Bazaar Explorer has 3 main views:

  • Welcome page
  • Repository view
  • Status view

Welcome page

If Explorer is started without an initial location, the Welcome page is opened. There are four panels as shown below.

_images/welcome-setup3.png _images/welcome-get-source2.png _images/welcome-new-project2.png _images/welcome-bookmarks2.png

Normally, the welcome page opens to the first panel. If you have bookmarks defined though, it will open to the last panel and display them. To open a bookmark, double-click it.

Note

The Preferences action is called Options on Windows: Explorer detects whether it is running on Windows, GNOME, KDE or OS X and adjusts its menus accordingly.

Repository view

The repository view shows the branches and checkouts inside a repository. It is also used for managing branches.

_images/repository-recent-history2.png

The last 5 revisions are shown in the Recent History tab. To open a branch, double-click on it or select it and select Open.

To create a new branch from an existing one, click on the branch to use as the source and select Branch.

The Local Changes tab shows you whether the working tree has uncommitted changes or not. It also shows you whether a given branch has revisions which are yet to be merged into the parent branch.

_images/repository-local-changes2.png

The Missing Revisions tab shows the revisions which are in the parent branch but not this one.

_images/repository-missing-revisions2.png

The Manage button opens the repository’s root directory in your file manager. This is useful if you wish to rename or delete branches.

Status view

When you open a branch or checkout, the status view is shown.

_images/status-unversioned-modified.png

The left-hand side shows the current status of the working tree. This shows what files have been added, deleted, renamed, modified, etc. It also shows recommended actions to take next. For example, if there are no conflicts and no unversioned files, it will suggest either the Diff or Commit actions.

_images/status-with-add-modified.png

The right-hand side is a working tree browser which can be used to navigate the current working tree. To open a file using the default application, double-click it. To edit a file, select it and select Edit. If your project has lots of files, you may wish to filter the files and directories displayed. To do this, type a string into the Filter field.

Configuration

Before using Bazaar, take a moment to configure things.

User configuration

These settings impact both Bazaar Explorer and the command line client (bzr).

_images/dialog-config1.png

Configuring your name and email address is important when using a distributed version control system (DVCS) like Bazaar. You may also wish to configure your preferred text editor, etc.

Preferences

These settings only impact Explorer.

_images/dialog-options.png

If you are an experienced user of DVCS tools, using the expanded toolbar is highly recommended. Once you are familiar with Explorer’s icons, you may wish to hide the text as well. The result is shown below.

_images/toolbar-expanded-icons-only.png

If you wish to use bzr-gtk dialogs with Explorer, select gtk as the application suite. gtk will only appear as an option if you have the bzr-gtk plugin installed.

Start actions

Branch

Use the Branch dialog to create a new branch by cloning an existing one.

_images/dialog-branch3.png

If the destination is outside a shared repository, the Branch dialog will suggest creating one. If you agree, a cut-down version of the Initialize dialog is launched.

Checkout

If you want a working tree in a separate location to a branch, use the Checkout dialog.

_images/dialog-checkout2.png

Initialize

Start a new project using the Initialize dialog.

_images/dialog-init2.png

The tooltips for the various models are given below.

Model Tooltip
Feature branches Create a shared repository at location then create a trunk branch inside that repository.
Shared tree Create a shared repository with treeless branches at location. Then create a trunk branch and separate working tree (checkout) inside that repository.
Plain branch Create a plain branch at location. If inside a shared repository, revisions will be stored there. Otherwise the revisions will be stored in the branch.
Shared repository Create a repository at location. Branches created under the repository will use it for storing revisions.
Shared repo with... Create a shared repository at location and configure it so branches under it are created without a working tree. Repositories on servers are usually configured this way.

Note

For most small-to-medium sized projects, the feature branches model is recommended. For large projects, the (git-like) shared trees model is often preferred.

Core actions

These actions appear on the toolbar. They may also be suggested in the status view if Explorer thinks they are the logical next step.

Add

Before Bazaar tracks files and directories, they need to be explicitly specified using the Add dialog.

_images/dialog-add3.png

Diff

Diff shows what’s changed since the last commit. An example of the diff dialog is shown later.

Commit

Commit records a new revision.

_images/dialog-commit4.png

Collaborate actions

These actions help you work with others.

Pull new revisions

To make a branch a mirror of another one, use the Pull dialog.

_images/dialog-pull3.png

Merge changes

To merge changes made elsewhere into a branch, use the Merge dialog.

_images/dialog-merge4.png

Update working tree

The Update dialog refreshes the working tree with changes made to the branch. Update is a commonly used action on a checkout.

Push new revisions

After making changes, you may wish to push them to a central location using the Push dialog.

_images/dialog-push4.png

Send new revisions

After making changes, you may wish to email them to others using the Send dialog.

_images/dialog-send3.png

Tag

The Tag dialog lets you add, rename and delete tags.

_images/dialog-tag3.png

Export

The export dialog creates archives of the last revision or an earlier one.

_images/dialog-export3.png

This is useful for packaging your project as a zip or tar.gz file, say.

Explore actions

Log history

The Log dialog shows the revision graph over time.

_images/dialog-log3.png

From this dialog, you can double-click on a revision to see the changes made.

_images/dialog-diff-historical2.png

You can also Annotate a file (see who changed each line and when) from the context (right-click) menu.

_images/dialog-annotate3.png

Browse items

This dialog is also available from the working tree browser in the status view. By default, it shows the status of each file. To see the tree as it was at a given revision, enter the revision identifier into the Revision field.

_images/dialog-browse3.png

To see the content of a file at that given revision, double-click on it. You can also view the annotations and log history for a given file from the context (right-click) menu.

Location information

This dialog shows information about the current branch, checkout or repository.

_images/dialog-info3.png

System information

This dialog shows information about how Bazaar is installed.

_images/dialog-version3.png

Note

For information about your Bazaar Explorer installation, see the About ... dialog under the Application menu.

System log

This displays the bzr.log file. You may be asked to provide information out of this file when troubleshooting problems.

Work actions

Resolve conflicts

After merging branches, some changes may conflict with each other. The conflicts dialog is used to resolve them.

Switch checkout

The branch a checkout is pointing to is changed using the switch dialog.

Bind branch

Bazaar lets you bind a local branch to a remote branch so that commits are made to both places at once. Bound branches implement the commonly-used centralized version control workflow.

_images/dialog-bind4.png

Note

Bound branches are more intelligent than a post-commit hook that propagates changes. In particular, a commit to a bound branch will only succeed if the local branch is up to date with the remote branch and the commit to the remote branch succeeds.

Unbind branch

To unbind a bound branch, use the Unbind dialog.

Revert working tree

To undo changes to one or more files, use the Revert dialog.

_images/dialog-revert3.png

Uncommit revisions

To rollback one of more commits, use the Uncommit dialog.

_images/dialog-uncommit3.png

The main reasons for doing this are to correct the commit message or to change the set of files committed.

Tools menu

The tools menu provides miscellaneous features.

Plugins

This dialog shows the plugins currently installed and their locations.

_images/dialog-plugins3.png

Note

Some time in the future, this dialog will be extended with plugin management features, e.g. updating a plugin, disable/enable functionality, etc.

Advanced commands

This dialog launches a Terminal shell from which the bzr command line client can be used.

Register project on

This submenu has links to popular project hosting sites that support Bazaar. These sites include Launchpad, SourceForge and GNU Savannah.

Custom tools

You can add your own tools to this menu by defining them in an xml file. Three types of tools are supported:

  • Bazaar sub-commands, e.g. lp-open
  • Local applications, e.g. eclipse
  • Web links.

Tool collections can be packaged by experienced users to help others ramp up to speed on your project.

Further information

We hope you enjoyed the tour above. For more information about Bazaar Explorer, see the key features or contact us.