← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/plugins.txt

  • Committer: John Arbash Meinel
  • Date: 2007-07-16 19:55:36 UTC
  • mfrom: (2601.1.3 bzr.dev.docs)
  • mto: This revision was merged to the branch mainline in revision 2621.
  • Revision ID: john@arbash-meinel.com-20070716195536-7swyum1epmk0313d
(James Westby) documentation updates (plugins, configuration, etc)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/plugins.txt
20
20
=====================
21
21
We keep our list of plugins on the http://bazaar-vcs.org/BzrPlugins page.
22
22
 
 
23
How to Install a plugin 
 
24
=======================
 
25
Installing a plugin is very easy! One can either install a plugin
 
26
system-wide or on a per user basis. Both methods involve creating a
 
27
``plugins`` directory. Within this directory one can place plugins in
 
28
subdirectories. For example, ``plugins/bzrtools/``.
 
29
 
 
30
Two locations are currently checked:  the bzrlib/plugins directory
 
31
(typically found in ``/usr/lib/python2.4/site-packages/bzrlib/plugins/``) and
 
32
``$HOME/.bazaar/plugins/``.
 
33
 
 
34
One can additionally override the home plugins by setting the environment
 
35
variable ``BZR_PLUGIN_PATH`` to a directory that contains plugins. The
 
36
installation of a plugin can be checked by running ``bzr plugins`` at
 
37
any time. New commands can be seen by running ``bzr help commands``.
 
38
The commands provided by a plugin are shown followed by the name of the
 
39
plugin in brackets.
 
40
 
 
41
Plugins work particularly well with Bazaar branches. For example, to
 
42
install the bzrtools plugins for your main user account, one can perform
 
43
the following:: 
 
44
 
 
45
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
 
46
    ~/.bazaar/plugins/bzrtools
 
47
 
 
48
When installing plugins the directories that you install them in must
 
49
be valid python identifiers. This means that they can only contain
 
50
certain characters, notably they cannot contain hyphens (``-``). Rather
 
51
than installing ``bzr-gtk`` to ``~/.bazaar/plugins/bzr-gtk``, install it
 
52
to ``~/.bazaar/plugins/gtk``.
 
53
 
23
54
Writing a plugin
24
55
================
25
56
Plugins are very similar to bzr core functionality.  They can import
47
78
Please feel free to contribute your plugin to BzrTools, if you think it
48
79
would be useful to other people.
49
80
 
50
 
How to Install a plugin 
51
 
=======================
52
 
Installing a plugin is very easy! One can either install a plugin
53
 
system-wide or on a per user basis. Both methods involve creating a
54
 
``plugins`` directory. Within this directory one can place plugins in
55
 
subdirectories. For example, ``plugins/bzrtools/``.
56
 
 
57
 
Two locations are currently checked:  the bzrlib/plugins directory
58
 
(typically found in ``/usr/lib/python2.4/site-packages/bzrlib/plugins/``) and
59
 
``$HOME/.bazaar/plugins/``.
60
 
 
61
 
One can additionally override the home plugins by setting the environment
62
 
variable ``BZR_PLUGIN_PATH`` to a directory that contains plugins. The
63
 
installation of a plugin can be checked by running ``bzr plugins`` at
64
 
any time. New commands can be seen by running ``bzr help commands``.
65
 
 
66
 
Plugins work particularly well with Bazaar branches. For example, to
67
 
install the bzrtools plugins for your main user account, one can perform
68
 
the following:: 
69
 
 
70
 
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
71
 
    ~/.bazaar/plugins/bzrtools
72