← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/plugins.txt

  • Committer: Ian Clatworthy
  • Date: 2007-11-30 04:28:32 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071130042832-6prruj0kzg3fodm8
chapter 2 tweaks

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/plugins.txt
9
9
A plugin is an external component for Bazaar that is typically made by
10
10
third parties. A plugin is capable of augmenting Bazaar by adding new
11
11
functionality.  A plugin can also change current Bazaar behavior by
12
 
replacing current functionality. Plugins often work as a way for
13
 
developers to test new features for Bazaar prior to inclusion in the
14
 
official codebase. Plugins can do a variety of things, including
15
 
overriding commands, adding new commands, providing additional network
16
 
transports, or customizing log output. The sky is the limit for the
17
 
customization that can be done through plugins.
 
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.
18
27
 
19
28
Where to find plugins 
20
29
---------------------
24
33
How to install a plugin 
25
34
-----------------------
26
35
 
27
 
Installing a plugin is very easy! One can either install a plugin
28
 
system-wide or on a per user basis. Both methods involve creating a
29
 
``plugins`` directory. Within this directory one can place plugins in
30
 
subdirectories. For example, ``plugins/bzrtools/``.
31
 
 
32
 
Two locations are currently checked:  the bzrlib/plugins directory
33
 
(typically found in ``/usr/lib/python2.4/site-packages/bzrlib/plugins/``) and
34
 
``$HOME/.bazaar/plugins/``.
35
 
 
36
 
One can additionally override the home plugins by setting the environment
37
 
variable ``BZR_PLUGIN_PATH`` to a directory that contains plugins. The
38
 
installation of a plugin can be checked by running ``bzr plugins`` at
39
 
any time. New commands can be seen by running ``bzr help commands``.
40
 
The commands provided by a plugin are shown followed by the name of the
41
 
plugin in brackets.
 
36
Installing a plugin is very easy! If not already created, create a
 
37
``plugins`` directory under your Bazaar configuration directory
 
38
($BZR_HOME), i.e. ``~/.bazaar/`` on Linux and
 
39
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\``
 
40
on Windows. Within this directory, each plugin is placed in its own
 
41
subdirectory.
42
42
 
43
43
Plugins work particularly well with Bazaar branches. For example, to
44
 
install the bzrtools plugins for your main user account, one can perform
45
 
the following:: 
 
44
install the bzrtools plugins for your main user account on Linux,
 
45
one can perform the following:: 
46
46
 
47
47
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
48
48
    ~/.bazaar/plugins/bzrtools
53
53
than installing ``bzr-gtk`` to ``~/.bazaar/plugins/bzr-gtk``, install it
54
54
to ``~/.bazaar/plugins/gtk``.
55
55
 
 
56
Alternative plugin locations
 
57
----------------------------
 
58
 
 
59
If you have the necessary permissions, plugins can also be installed on
 
60
a system-wide basis. Two locations are currently checked for plugins:
 
61
 
 
62
 1. the system location - bzrlib/plugins
 
63
 2. the personal location - $BZR_HOME/plugins.
 
64
 
 
65
On a Linux installation, these locations are typically
 
66
``/usr/lib/python2.4/site-packages/bzrlib/plugins/`` and
 
67
``$HOME/.bazaar/plugins/``.
 
68
On a Windows installation, the system location might be
 
69
``C:\\Program Files\\Bazaar\\plugins``
 
70
while the personal location might be
 
71
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\plugins``.
 
72
 
 
73
One can additionally override the personal plugins location
 
74
by setting the environment variable ``BZR_PLUGIN_PATH``
 
75
to a directory that contains plugins.
 
76
 
56
77
Listing the installed plugins
57
78
-----------------------------
58
79
 
62
83
 
63
84
The name, location and version of each plugin installed will be displayed.
64
85
 
 
86
New commands added by plugins can be seen by running ``bzr help commands``.
 
87
The commands provided by a plugin are shown followed by the name of the
 
88
plugin in brackets.
 
89
 
65
90
Popular plugins
66
91
---------------
67
92
 
73
98
  GUI              QBzr              Qt-based GUI tools
74
99
  GUI              bzr-gtk           GTK-based GUI tools
75
100
  GUI              bzr-eclipse       Eclipse integration
 
101
  General          bzrtools          misc. enhancements including shelf
76
102
  General          difftools         external diff tool helper
77
103
  General          extmerge          external merge tool helper
78
 
  General          bzrtools          misc. enhancements including shelf
79
104
  Integration      bzr-svn           use Subversion as a repository
80
105
  Migration        cvsps             migrate CVS patch-sets
81
106
  ================ ================= ==================================