summaryrefslogtreecommitdiff
path: root/src/buildstream/element.py
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2020-04-20 16:35:53 +0900
committerbst-marge-bot <marge-bot@buildstream.build>2020-04-21 08:54:20 +0000
commit668c9c00d84137cc4709ba50f485f3a54da58409 (patch)
tree37a6d826f638b9c854c3623364451a242b2456a3 /src/buildstream/element.py
parentfc39f81a2573b08f77391b21f38271858906a9ed (diff)
downloadbuildstream-668c9c00d84137cc4709ba50f485f3a54da58409.tar.gz
src: Removing all pre 2.x "Since" documentation annotations.
This does not make sense to keep in the public API surface documentation. As we are heading towards a release of 2.0, this represents a "reset" in public API, and older annotations only serve to clutter the documentation with information that is not relevant to the reader. Everything which is public at the time of the 2.0 release can be considered available "Since: 2.0" implicitly (as this is going to be the starting point of this new stable API). It will make sense to start adding these annotations again for any added API in 2.2 and forward.
Diffstat (limited to 'src/buildstream/element.py')
-rw-r--r--src/buildstream/element.py16
1 files changed, 1 insertions, 15 deletions
diff --git a/src/buildstream/element.py b/src/buildstream/element.py
index a7ee40051..6cce9b93f 100644
--- a/src/buildstream/element.py
+++ b/src/buildstream/element.py
@@ -133,7 +133,7 @@ class ElementError(BstError):
detail: A possibly multiline, more detailed error message
reason: An optional machine readable reason string, used for test cases
collect: An optional directory containing partial install contents
- temporary: An indicator to whether the error may occur if the operation was run again. (*Since: 1.2*)
+ temporary: An indicator to whether the error may occur if the operation was run again.
"""
def __init__(
@@ -177,39 +177,27 @@ class Element(Plugin):
BST_FORBID_RDEPENDS = False
"""Whether to raise exceptions if an element has runtime dependencies.
-
- *Since: 1.2*
"""
BST_FORBID_BDEPENDS = False
"""Whether to raise exceptions if an element has build dependencies.
-
- *Since: 1.2*
"""
BST_FORBID_SOURCES = False
"""Whether to raise exceptions if an element has sources.
-
- *Since: 1.2*
"""
BST_VIRTUAL_DIRECTORY = False
"""Whether to raise exceptions if an element uses Sandbox.get_directory
instead of Sandbox.get_virtual_directory.
-
- *Since: 1.4*
"""
BST_RUN_COMMANDS = True
"""Whether the element may run commands using Sandbox.run.
-
- *Since: 1.4*
"""
BST_ELEMENT_HAS_ARTIFACT = True
"""Whether the element produces an artifact when built.
-
- *Since: 1.90*
"""
def __init__(self, context: "Context", project: "Project", meta: "MetaElement", plugin_conf: Dict[str, Any]):
@@ -380,8 +368,6 @@ class Element(Plugin):
By default, this method does nothing, but may be overriden to
allow configure-like commands.
-
- *Since: 1.2*
"""
def assemble(self, sandbox: "Sandbox") -> str: