/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

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

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Using plugins
2
2
=============
3
3
 
4
 
.. Information on how to use plugins in Bazaar.
 
4
.. Information on how to use plugins in Breezy.
5
5
 
6
6
What is a plugin?
7
7
-----------------
8
8
 
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
 
9
A plugin is an external component for Breezy that is typically made by
 
10
third parties. A plugin is capable of augmenting Breezy by adding new
 
11
functionality.  A plugin can also change current Breezy behavior by
12
12
replacing current functionality. Sample applications of plugins are:
13
13
 
14
14
* overriding commands
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
 
Bazaar prior to inclusion in the official codebase. Plugins are helpful
 
21
Breezy prior to inclusion in the official codebase. Plugins are helpful
22
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.
 
23
day be removed from the Breezy core and be made available as a plugin instead.
24
24
 
25
25
Plugins are good for users, good for external developers and good for
26
 
Bazaar itself.
 
26
Breezy itself.
27
27
 
28
28
Where to find plugins
29
29
---------------------
34
34
-----------------------
35
35
 
36
36
Installing a plugin is very easy! If not already created, create a
37
 
``plugins`` directory under your Bazaar configuration directory,
 
37
``plugins`` directory under your Breezy configuration directory,
38
38
``~/.bazaar/`` on Unix and
39
 
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\``
 
39
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0\``
40
40
on Windows. Within this directory (referred to as $BZR_HOME below),
41
41
each plugin is placed in its own subdirectory.
42
42
 
43
 
Plugins work particularly well with Bazaar branches. For example, to
44
 
install the bzrtools plugins for your main user account on GNU/Linux,
 
43
Plugins work particularly well with Breezy branches. For example, to
 
44
install the brztools plugins for your main user account on GNU/Linux,
45
45
one can perform the following::
46
46
 
47
 
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
48
 
    ~/.bazaar/plugins/bzrtools
 
47
    brz branch http://panoramicfeedback.com/opensource/brz/brztools
 
48
    ~/.bazaar/plugins/brztools
49
49
 
50
50
When installing plugins, the directories that you install them in must
51
51
be valid python identifiers. This means that they can only contain
52
52
certain characters, notably they cannot contain hyphens (``-``). Rather
53
 
than installing ``bzr-gtk`` to ``$BZR_HOME/plugins/bzr-gtk``, install it
 
53
than installing ``brz-gtk`` to ``$BZR_HOME/plugins/brz-gtk``, install it
54
54
to ``$BZR_HOME/plugins/gtk``.
55
55
 
56
56
Alternative plugin locations
59
59
If you have the necessary permissions, plugins can also be installed on a
60
60
system-wide basis.  One can additionally override the personal plugins
61
61
location by setting the environment variable ``BZR_PLUGIN_PATH`` (see `User
62
 
Reference <../user-reference/configuration-help.html#bzr-plugin-path>`_ 
 
62
Reference <../user-reference/configuration-help.html#brz-plugin-path>`_ 
63
63
for a detailed explanation).
64
64
 
65
65
Listing the installed plugins
67
67
 
68
68
To do this, use the plugins command like this::
69
69
 
70
 
    bzr plugins
 
70
    brz plugins
71
71
 
72
72
The name, location and version of each plugin installed will be displayed.
73
73
 
74
 
New commands added by plugins can be seen by running ``bzr help commands``.
 
74
New commands added by plugins can be seen by running ``brz help commands``.
75
75
The commands provided by a plugin are shown followed by the name of the
76
76
plugin in brackets.
77
77
 
84
84
  Category         Name              Description
85
85
  ================ ================= ==================================
86
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
 
87
  GUI              brz-gtk           GTK-based GUI tools
 
88
  GUI              brz-eclipse       Eclipse integration
 
89
  General          brztools          misc. enhancements including shelf
90
90
  General          difftools         external diff tool helper
91
91
  General          extmerge          external merge tool helper
92
 
  Integration      bzr-svn           use Subversion as a repository
 
92
  Integration      brz-svn           use Subversion as a repository
93
93
  Migration        cvsps             migrate CVS patch-sets
94
94
  ================ ================= ==================================
95
95