/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/plugins.txt
 
1
Using plugins
 
2
=============
 
3
 
 
4
.. Information on how to use plugins in Breezy.
 
5
 
 
6
What is a plugin?
 
7
-----------------
 
8
 
 
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
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
Breezy 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 Breezy core and be made available as a plugin instead.
 
24
 
 
25
Plugins are good for users, good for external developers and good for
 
26
Breezy itself.
 
27
 
 
28
Where to find plugins
 
29
---------------------
 
30
 
 
31
The old plugins for Bazaar can be found at 
 
32
<http://wiki.bazaar.canonical.com/BzrPlugins>, these are not guareteed to work
 
33
with Breezy.
 
34
 
 
35
How to handle Breezy plugins is to be determined.
 
36
 
 
37
How to install a plugin
 
38
-----------------------
 
39
 
 
40
Installing a plugin is very easy! If not already created, create a
 
41
``plugins`` directory under your Breezy configuration directory,
 
42
``~/.config/breezy/`` on Unix and
 
43
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0\``
 
44
on Windows. Within this directory (referred to as $BRZ_HOME below),
 
45
each plugin is placed in its own subdirectory.
 
46
 
 
47
Plugins work particularly well with Breezy branches. For example, to
 
48
install the brztools plugins for your main user account on GNU/Linux,
 
49
one can perform the following::
 
50
 
 
51
    brz branch http://panoramicfeedback.com/opensource/brz/brztools
 
52
    ~/.config/breezy/plugins/brztools
 
53
 
 
54
When installing plugins, the directories that you install them in must
 
55
be valid python identifiers. This means that they can only contain
 
56
certain characters, notably they cannot contain hyphens (``-``). Rather
 
57
than installing ``brz-gtk`` to ``$BRZ_HOME/plugins/brz-gtk``, install it
 
58
to ``$BRZ_HOME/plugins/gtk``.
 
59
 
 
60
Alternative plugin locations
 
61
----------------------------
 
62
 
 
63
If you have the necessary permissions, plugins can also be installed on a
 
64
system-wide basis.  One can additionally override the personal plugins
 
65
location by setting the environment variable ``BRZ_PLUGIN_PATH`` (see `User
 
66
Reference <../user-reference/configuration-help.html#brz-plugin-path>`_ 
 
67
for a detailed explanation).
 
68
 
 
69
Listing the installed plugins
 
70
-----------------------------
 
71
 
 
72
To do this, use the plugins command like this::
 
73
 
 
74
    brz plugins
 
75
 
 
76
The name, location and version of each plugin installed will be displayed.
 
77
 
 
78
New commands added by plugins can be seen by running ``brz help commands``.
 
79
The commands provided by a plugin are shown followed by the name of the
 
80
plugin in brackets.
 
81
 
 
82
Popular plugins
 
83
---------------
 
84
 
 
85
Here is a sample of some of the more popular plugins.
 
86
 
 
87
  ================ ================= ==================================
 
88
  Category         Name              Description
 
89
  ================ ================= ==================================
 
90
  GUI              QBzr              Qt-based GUI tools
 
91
  GUI              brz-gtk           GTK-based GUI tools
 
92
  GUI              brz-eclipse       Eclipse integration
 
93
  General          brztools          misc. enhancements including shelf
 
94
  General          difftools         external diff tool helper
 
95
  General          extmerge          external merge tool helper
 
96
  Integration      brz-svn           use Subversion as a repository
 
97
  Migration        cvsps             migrate CVS patch-sets
 
98
  ================ ================= ==================================
 
99
 
 
100
If you wish to write your own plugins, it is not difficult to do.
 
101
See `Writing a plugin <writing a plugin.html>`_ in the appendices to get
 
102
started.