← 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: Vincent Ladeuil
  • Date: 2010-02-10 15:46:03 UTC
  • mfrom: (4985.3.21 update)
  • mto: This revision was merged to the branch mainline in revision 5021.
  • Revision ID: v.ladeuil+lp@free.fr-20100210154603-k4no1gvfuqpzrw7p
https://launchpad.net/bugs/113809
Update performs two merges in a more logical order but stop on conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/plugins.txt
15
15
* adding new commands
16
16
* providing additional network transports
17
17
* customizing log output.
18
 
  
 
18
 
19
19
The sky is the limit for the customization that can be done through plugins.
20
20
In fact, plugins often work as a way for developers to test new features for
21
21
Bazaar prior to inclusion in the official codebase. Plugins are helpful
25
25
Plugins are good for users, good for external developers and good for
26
26
Bazaar itself.
27
27
 
28
 
Where to find plugins 
 
28
Where to find plugins
29
29
---------------------
30
30
 
31
31
We keep our list of plugins on the http://bazaar-vcs.org/BzrPlugins page.
32
32
 
33
 
How to install a plugin 
 
33
How to install a plugin
34
34
-----------------------
35
35
 
36
36
Installing a plugin is very easy! If not already created, create a
42
42
 
43
43
Plugins work particularly well with Bazaar branches. For example, to
44
44
install the bzrtools plugins for your main user account on Linux,
45
 
one can perform the following:: 
 
45
one can perform the following::
46
46
 
47
47
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
48
48
    ~/.bazaar/plugins/bzrtools
56
56
Alternative plugin locations
57
57
----------------------------
58
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.
 
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/bzr_man.html#bzr-plugin-path>`_ for a detailed
 
63
explanation).
76
64
 
77
65
Listing the installed plugins
78
66
-----------------------------
106
94
  ================ ================= ==================================
107
95
 
108
96
If you wish to write your own plugins, it is not difficult to do.
109
 
See `Writing a plugin`_ in the appendices to get started.
 
97
See `Writing a plugin <writing a plugin.html>`_ in the appendices to get
 
98
started.