← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/plugin-api.txt

(gz) Backslash escape selftest output when printing to non-unicode consoles
 (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/plugin-api.txt
22
22
See also
23
23
--------
24
24
 
25
 
 * `Bazaar Developer Documentation Catalog <index.html>`_.
26
 
 * <http://bazaar-vcs.org/WritingPlugins> wiki page with many more
27
 
   suggestions about particular APIs
 
25
 * `Bazaar Developer Documentation Catalog <../index.html>`_.
 
26
 * `Bazaar Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ for
 
27
   more suggestions about particular APIs.
28
28
 
29
29
 
30
30
Structure of a plugin
186
186
short complete sentence summarizing the plugin.  The full docstring is
187
187
shown by ``bzr help PLUGIN_NAME``.
188
188
 
189
 
Remember that to be effective, the module docstring must be the first
190
 
statement in the file.  It may come after comments but it must be before
191
 
any import statements.
 
189
This is a user-visible docstring so should be prefixed with ``__doc__ =``
 
190
to ensure help works under ``python -OO`` with docstrings stripped.
192
191
 
193
192
API version
194
193
-----------
242
241
time other than register or override functions to be called later.
243
242
 
244
243
The plugin can import bzrlib and call any function.
245
 
Some interesting APIs are described in <http://bazaar-vcs.org/WritingPlugins>
 
244
Some interesting APIs are described in `Bazaar Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_.
246
245
 
247
246
 
248
247
Publishing your plugin
255
254
   <https://launchpad.net/bzr-fastimport>
256
255
   and publish the branches or tarballs there
257
256
 
258
 
 * include the plugin in <http://bazaar-vcs.org/BzrPlugins>
 
257
 * include the plugin in <http://wiki.bazaar.canonical.com/BzrPlugins>
259
258
 
260
259
 * post about it to the ``bazaar-announce`` list at ``lists.canonical.com``
261
260