← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: John Arbash Meinel
  • Date: 2010-02-17 17:11:16 UTC
  • mfrom: (4797.2.17 2.1)
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: john@arbash-meinel.com-20100217171116-h7t9223ystbnx5h8
merge bzr.2.1 in preparation for NEWS entry.

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
 
 * `Bazaar Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ for
27
 
   more suggestions about particular APIs.
 
25
 * `Bazaar Developer Documentation Catalog <index.html>`_.
 
26
 * <http://bazaar-vcs.org/WritingPlugins> wiki page with many more
 
27
   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
 
This is a user-visible docstring so should be prefixed with ``__doc__ =``
190
 
to ensure help works under ``python -OO`` with docstrings stripped.
 
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.
191
192
 
192
193
API version
193
194
-----------
241
242
time other than register or override functions to be called later.
242
243
 
243
244
The plugin can import bzrlib and call any function.
244
 
Some interesting APIs are described in `Bazaar Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_.
 
245
Some interesting APIs are described in <http://bazaar-vcs.org/WritingPlugins>
245
246
 
246
247
 
247
248
Publishing your plugin
254
255
   <https://launchpad.net/bzr-fastimport>
255
256
   and publish the branches or tarballs there
256
257
 
257
 
 * include the plugin in <http://wiki.bazaar.canonical.com/BzrPlugins>
 
258
 * include the plugin in <http://bazaar-vcs.org/BzrPlugins>
258
259
 
259
260
 * post about it to the ``bazaar-announce`` list at ``lists.canonical.com``
260
261