← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/plugins.txt

Merge bzr.dev (and fix NEWS)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/plugins.txt
1
 
Using plugins
2
 
=============
3
 
 
4
 
.. Information on how to use plugins in Bazaar.
5
 
 
6
 
What is a plugin?
7
 
-----------------
8
 
 
 
1
==============
 
2
Bazaar plugins
 
3
==============
 
4
 
 
5
Information on how to use plugins in Bazaar.
 
6
 
 
7
What is a Plugin
 
8
================
9
9
A plugin is an external component for Bazaar that is typically made by
10
 
third parties. A plugin is capable of augmenting Bazaar by adding new
11
 
functionality.  A plugin can also change current Bazaar behavior by
12
 
replacing current functionality. Sample applications of plugins are:
13
 
 
14
 
* overriding commands
15
 
* adding new commands
16
 
* providing additional network transports
17
 
* customizing log output.
18
 
 
19
 
The sky is the limit for the customization that can be done through plugins.
20
 
In fact, plugins often work as a way for developers to test new features for
21
 
Bazaar prior to inclusion in the official codebase. Plugins are helpful
22
 
at feature retirement time as well, e.g. deprecated file formats may one
23
 
day be removed from the Bazaar core and be made available as a plugin instead.
24
 
 
25
 
Plugins are good for users, good for external developers and good for
26
 
Bazaar itself.
27
 
 
28
 
Where to find plugins
29
 
---------------------
30
 
 
31
 
We keep our list of plugins on the http://wiki.bazaar.canonical.com/BzrPlugins page.
32
 
 
33
 
How to install a plugin
34
 
-----------------------
35
 
 
36
 
Installing a plugin is very easy! If not already created, create a
37
 
``plugins`` directory under your Bazaar configuration directory,
38
 
``~/.bazaar/`` on Unix and
39
 
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\``
40
 
on Windows. Within this directory (referred to as $BZR_HOME below),
41
 
each plugin is placed in its own subdirectory.
 
10
third parties. A plugin is capable of augmenting Bazaar by adding or
 
11
replacing new or current functionality in Bazaar. Plugins often work as
 
12
a way for developers to test new features for Bazaar prior to inclusion
 
13
in the official codebase. Plugins can do a variety of things, including
 
14
overriding commands, adding new commands, providing additional network
 
15
transports, customizing log output. The sky is the limit for the
 
16
customization that can be done through plugins.
 
17
 
 
18
Where to find Plugins 
 
19
=====================
 
20
We keep our list of plugins on the http://bazaar-vcs.org/PluginRegistry page.
 
21
 
 
22
Writing a plugin
 
23
================
 
24
Plugins are very similar to bzr core functionality.  They can import
 
25
anything in bzrlib.  A plugin may simply override standard functionality,
 
26
but most plugins supply new commands.
 
27
 
 
28
To create a command, make a new object that derives from
 
29
`bzrlib.commands.Command`, and name it cmd_foo, where foo is the name of
 
30
your command.  If you create a command whose name contains an underscore,
 
31
it will appear in the UI with the underscore turned into a hyphen.  For
 
32
example, "cmd_baz_import" will appear as "baz-import".  For examples of how
 
33
to write commands, please see builtins.py.
 
34
 
 
35
Once you've created a command you must register the command with
 
36
`bzrlib.commands.register_command(cmd_foo)`.  You must register the command
 
37
when your file is imported, otherwise bzr will not see it.
 
38
 
 
39
Bzr will scan **bzrlib/plugins** and **~/.bazaar/plugins** for plugins by
 
40
default.  You can override this with **BZR_PLUGIN_PATH**.  Plugins may be
 
41
either modules or packages.  If your plugin is a single file, you can
 
42
structure it as a module.  If it has multiple files, or if you want to
 
43
distribute it as a bzr branch, you should structure it as a package, i.e. a
 
44
directory with an **__init__.py** file.
 
45
 
 
46
Please feel free to contribute your plugin to BzrTools, if you think it
 
47
would be useful to other people.
 
48
 
 
49
How to Install a plugin 
 
50
=======================
 
51
Installing a plugin is very easy! One can either install a plugin
 
52
systemwide or on a user by user basis. Both methods involve create a
 
53
"plugins" directory. Within this directory one can place plugins in
 
54
subdirectories. For example, "plugins/bzrtools/".
 
55
 
 
56
Two locations are currently checked; the bzrlib/plugins directory
 
57
(typically found in /usr/lib/python2.4/site-packages/bzrlib/plugins/) and
 
58
$HOME/.bazaar/plugins/.
 
59
 
 
60
One can additionally override the home plugins by setting the environment
 
61
variable BZR_PLUGIN_PATH to a directory that contains plugins. The
 
62
installation of a plugin can be checked by running **bzr plugins** at
 
63
any time. New commands can be seen by running **bzr help commands**.
42
64
 
43
65
Plugins work particularly well with Bazaar branches. For example, to
44
 
install the bzrtools plugins for your main user account on GNU/Linux,
45
 
one can perform the following::
 
66
install the bzrtools plugins for your main user account, one can perform
 
67
the following:: 
46
68
 
47
69
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
48
70
    ~/.bazaar/plugins/bzrtools
49
71
 
50
 
When installing plugins, the directories that you install them in must
51
 
be valid python identifiers. This means that they can only contain
52
 
certain characters, notably they cannot contain hyphens (``-``). Rather
53
 
than installing ``bzr-gtk`` to ``$BZR_HOME/plugins/bzr-gtk``, install it
54
 
to ``$BZR_HOME/plugins/gtk``.
55
 
 
56
 
Alternative plugin locations
57
 
----------------------------
58
 
 
59
 
If you have the necessary permissions, plugins can also be installed on a
60
 
system-wide basis.  One can additionally override the personal plugins
61
 
location by setting the environment variable ``BZR_PLUGIN_PATH`` (see `User
62
 
Reference <../user-reference/configuration-help.html#bzr-plugin-path>`_ 
63
 
for a detailed explanation).
64
 
 
65
 
Listing the installed plugins
66
 
-----------------------------
67
 
 
68
 
To do this, use the plugins command like this::
69
 
 
70
 
    bzr plugins
71
 
 
72
 
The name, location and version of each plugin installed will be displayed.
73
 
 
74
 
New commands added by plugins can be seen by running ``bzr help commands``.
75
 
The commands provided by a plugin are shown followed by the name of the
76
 
plugin in brackets.
77
 
 
78
 
Popular plugins
79
 
---------------
80
 
 
81
 
Here is a sample of some of the more popular plugins.
82
 
 
83
 
  ================ ================= ==================================
84
 
  Category         Name              Description
85
 
  ================ ================= ==================================
86
 
  GUI              QBzr              Qt-based GUI tools
87
 
  GUI              bzr-gtk           GTK-based GUI tools
88
 
  GUI              bzr-eclipse       Eclipse integration
89
 
  General          bzrtools          misc. enhancements including shelf
90
 
  General          difftools         external diff tool helper
91
 
  General          extmerge          external merge tool helper
92
 
  Integration      bzr-svn           use Subversion as a repository
93
 
  Migration        cvsps             migrate CVS patch-sets
94
 
  ================ ================= ==================================
95
 
 
96
 
If you wish to write your own plugins, it is not difficult to do.
97
 
See `Writing a plugin <writing a plugin.html>`_ in the appendices to get
98
 
started.