diff options
author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-09-19 11:01:54 +0900 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-09-19 11:01:54 +0900 |
commit | 4813c828b77233b83442662353c7ad0498f408b2 (patch) | |
tree | 0fae1d15c381c6aae72731bc4b464fe92d4042de | |
parent | e62e71a6867cf5652d8c5afda43fba2c8df3dee3 (diff) | |
download | buildstream-4813c828b77233b83442662353c7ad0498f408b2.tar.gz |
plugin.py: Add note on plugin extension support
Note: original patch by Tristan Maat on MR !92, wording modified.
-rw-r--r-- | buildstream/plugin.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/buildstream/plugin.py b/buildstream/plugin.py index 402ec7761..592089c63 100644 --- a/buildstream/plugin.py +++ b/buildstream/plugin.py @@ -90,6 +90,13 @@ class Plugin(): Some common features to both Sources and Elements are found in this class. + .. note:: + + Derivation of plugins is not supported. Plugins may only + derive from the base :mod:`Source <buildstream.source>` and + :mod:`Element <buildstream.element>` types, and any convenience + subclasses (like :mod:`BuildElement <buildstream.buildelement>`) + which are included in the buildstream namespace. """ BST_REQUIRED_VERSION_MAJOR = 0 |