← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

Merge up through 2.2.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/writing_a_plugin.txt
22
22
``bzrlib.commands.register_command(cmd_foo)``.  You must register the
23
23
command when your file is imported, otherwise bzr will not see it.
24
24
 
 
25
Installing a hook
 
26
-----------------
 
27
 
 
28
See `Using hooks`_.
 
29
 
 
30
 .. _Using hooks: hooks.txt
 
31
 
 
32
 
25
33
Specifying a plugin version number
26
34
----------------------------------
27
35
Simply define ``version_info`` to be a tuple defining the current version
32
40
Plugin searching rules
33
41
----------------------
34
42
 
35
 
Bzr will scan ``bzrlib/plugins`` and ``~/.bazaar/plugins`` for plugins
36
 
by default.  You can override this with ``BZR_PLUGIN_PATH``.  Plugins
37
 
may be either modules or packages.  If your plugin is a single file,
38
 
you can structure it as a module.  If it has multiple files, or if you
39
 
want to distribute it as a bzr branch, you should structure it as a
 
43
Bzr will scan ``~/.bazaar/plugins``  and ``bzrlib/plugins`` for plugins
 
44
by default.  You can override this with  ``BZR_PLUGIN_PATH``
 
45
(see `User Reference <../user-reference/bzr_man.html#bzr-plugin-path>`_
 
46
for details).
 
47
 
 
48
Plugins may be either modules or packages.  If your plugin is a single
 
49
file, you can structure it as a module.  If it has multiple files, or if
 
50
you want to distribute it as a bzr branch, you should structure it as a
40
51
package, i.e. a directory with an ``__init__.py`` file.
41
52
 
42
53
More information