summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Maw <jonathan.maw@codethink.co.uk>2017-06-30 13:23:53 +0100
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-07-01 20:20:28 +0900
commit68b375664fa3556389ea44c7f446be97bb4196cb (patch)
treeff567bbb8071531bd3f69f602e9facc556ca6407
parent2c71dfda293f49b1f56ffab3d9d8136b884c8cf5 (diff)
downloadbuildstream-68b375664fa3556389ea44c7f446be97bb4196cb.tar.gz
plugin.py: Document that logging is normally suppressed during configure
-rw-r--r--buildstream/plugin.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/buildstream/plugin.py b/buildstream/plugin.py
index c86d88d42..5f0d7bf07 100644
--- a/buildstream/plugin.py
+++ b/buildstream/plugin.py
@@ -218,6 +218,11 @@ class Plugin():
whenever the YAML input configuration is faulty.
Implementations may raise :class:`.SourceError` or :class:`.ElementError` for other errors.
+
+ .. note::
+
+ During configure, logging is suppressed unless buildstream is run with
+ debugging output enabled.
"""
raise ImplError("{tag} plugin '{kind}' does not implement configure()".format(
tag=self.__type_tag, kind=self.get_kind()))