/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/developers/plugin-api.txt

  • Committer: Jelmer Vernooij
  • Date: 2018-06-14 17:59:16 UTC
  • mto: This revision was merged to the branch mainline in revision 7065.
  • Revision ID: jelmer@jelmer.uk-20180614175916-a2e2xh5k533guq1x
Move breezy.plugins.git to breezy.git.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/plugin-api.txt
23
23
--------
24
24
 
25
25
 * `Breezy Developer Documentation Catalog <../index.html>`_.
26
 
 * `Breezy Plugins Guide <plugin-development.txt>`_ for
 
26
 * `Breezy Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ for
27
27
   more suggestions about particular APIs.
28
28
 
29
29
 
31
31
=====================
32
32
 
33
33
Plugins are Python modules under ``breezy.plugins``. They can be installed
34
 
either into the PYTHONPATH in that location, or in ~/.config/breezy/plugins.
 
34
either into the PYTHONPATH in that location, or in ~/.bazaar/plugins.
35
35
 
36
36
Plugins should have a setup.py.
37
37
 
45
45
Plugins can export a summary of what they provide, and what versions of breezy
46
46
they are compatible with. This allows tools to be written to work with plugins,
47
47
such as to generate a directory of plugins, or install them via a
48
 
symlink/checkout to ~/.config/breezy/plugins.
 
48
symlink/checkout to ~/.bazaar/plugins.
49
49
 
50
50
This interface allows Breezy to interrogate a plugin without actually loading
51
51
it. This is useful because loading a plugin may have side effects such
138
138
 
139
139
An example setup.py follows::
140
140
 
141
 
  #!/usr/bin/env python3
 
141
  #!/usr/bin/env python2.4
142
142
  from distutils.core import setup
143
143
 
144
144
  brz_plugin_name = 'demo'
241
241
time other than register or override functions to be called later.
242
242
 
243
243
The plugin can import breezy and call any function.
244
 
Some interesting APIs are described in `Breezy Plugins Guide <plugin-development.txt>`_.
 
244
Some interesting APIs are described in `Breezy Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_.
245
245
 
246
246
 
247
247
Publishing your plugin