# bzr plugin

## bzr - stage files from a bazaar repository

Host dependencies:

> - bzr

Usage:

    # Specify the bzr source kind
    kind: bzr

    # Specify the bzr url. Bazaar URLs come in many forms, see
    # `bzr help urlspec` for more information. Using an alias defined
    # in your project configuration is encouraged.
    url: https://launchpad.net/bzr

    # Specify the tracking branch. This is mandatory, as bzr cannot identify
    # an individual revision outside its branch. bzr URLs that omit the branch
    # name implicitly specify the trunk branch, but bst requires this to be
    # explicit.
    track: trunk

    # Specify the ref. This is a revision number. This is usually a decimal,
    # but revisions on a branch are of the form
    # <revision-branched-from>.<branch-number>.<revision-since-branching>
    # e.g. 6622.1.6.
    # The ref must be specified to build, and 'bst source track' will update the
    # revision number to the one on the tip of the branch specified in 'track'.
    ref: 6622

    # Specify the version to be reported as the *guess_version* when reporting
    # SourceInfo
    #
    # Since 2.5
    #
    version: 1.2

See built-in functionality doumentation for details on common configuration options for sources.

### Reporting SourceInfo

The bzr source reports the URL of the bzr repository as the url.

Further, the bzr source reports the SourceInfoMedium.BZR medium and the` SourceVersionType.COMMIT version_type, for which it reports the bzr revision number as the version.

Since the bzr source does not have a way to know what the release version corresponds to the revision number, the bzr source exposes the `version` configuration attribute to allow explicit specification of the guess_version.