diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-04-23 21:58:34 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-04-24 18:31:29 +0900 |
| commit | b3ef5fb72f6a6c98b94a2cde37febf4a6f5ebc5a (patch) | |
| tree | 7239ac6728d0c5cde8fb1273e03f10e6037e23e9 | |
| parent | ed2b5e669f4a5365d948a2ff08a2da49660c0d37 (diff) | |
| download | buildstream-b3ef5fb72f6a6c98b94a2cde37febf4a6f5ebc5a.tar.gz | |
doc/source/hacking/writing_plugins.rst: Remove some docs about format-version
This will be done differently in BuildStream 2, as explained
in this email:
https://mail.gnome.org/archives/buildstream-list/2020-April/msg00017.html
| -rw-r--r-- | doc/source/hacking/writing_plugins.rst | 15 |
1 files changed, 0 insertions, 15 deletions
diff --git a/doc/source/hacking/writing_plugins.rst b/doc/source/hacking/writing_plugins.rst index cecd79053..8425425bf 100644 --- a/doc/source/hacking/writing_plugins.rst +++ b/doc/source/hacking/writing_plugins.rst @@ -17,21 +17,6 @@ documentation of your plugin automatically. Whenever adding a new plugin, you must add an entry for it in ``doc/source/core_plugins.rst``. -Bump format version -~~~~~~~~~~~~~~~~~~~ -In order for projects to assert that they have a new enough version -of BuildStream to use the new plugin, the ``BST_FORMAT_VERSION`` must -be incremented in the ``_versions.py`` file. - -Remember to include in your plugin's main documentation, the format -version in which the plugin was introduced, using the standard annotation -which we use throughout the documentation, e.g.:: - - .. note:: - - The ``foo`` plugin is available since :ref:`format version 16 <project_format_version>` - - Add tests ~~~~~~~~~ Needless to say, all new feature additions need to be tested. For ``Element`` |