/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: 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/developers/plugin-api.txt
23
23
--------
24
24
 
25
25
 * `Breezy Developer Documentation Catalog <../index.html>`_.
26
 
 * `Breezy Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ for
 
26
 * `Breezy Plugins Guide <plugin-development.txt>`_ for
27
27
   more suggestions about particular APIs.
28
28
 
29
29
 
138
138
 
139
139
An example setup.py follows::
140
140
 
141
 
  #!/usr/bin/env python2.4
 
141
  #!/usr/bin/env python3
142
142
  from distutils.core import setup
143
143
 
144
144
  brz_plugin_name = 'demo'
189
189
This is a user-visible docstring so should be prefixed with ``__doc__ =``
190
190
to ensure help works under ``python -OO`` with docstrings stripped.
191
191
 
192
 
API version
193
 
-----------
194
 
 
195
 
Plugins can and should declare that they depend on a particular version of
196
 
breezy like so::
197
 
 
198
 
    from breezy.api import require_api
199
 
 
200
 
    require_api(breezy, (1, 11, 0))
201
 
 
202
 
Please see `API versioning <api-versioning.html>`_ for more details on the API
203
 
metadata protocol used by breezy.
204
 
 
205
192
Plugin version
206
193
--------------
207
194
 
241
228
time other than register or override functions to be called later.
242
229
 
243
230
The plugin can import breezy and call any function.
244
 
Some interesting APIs are described in `Breezy Plugins Guide <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_.
 
231
Some interesting APIs are described in `Breezy Plugins Guide <plugin-development.txt>`_.
245
232
 
246
233
 
247
234
Publishing your plugin