summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/buildstream/element.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/buildstream/element.py b/src/buildstream/element.py
index 5ba759dfe..3316d8adb 100644
--- a/src/buildstream/element.py
+++ b/src/buildstream/element.py
@@ -213,6 +213,16 @@ class Element(Plugin):
project.ensure_fully_loaded()
self.project_name = self._get_project().name
+ """The :ref:`name <project_format_name>` of the owning project
+
+ .. attention::
+
+ Combining this attribute with :attr:`Plugin.name <buildstream.plugin.Plugin.name>`
+ does not provide a unique identifier for an element within a project, this is because
+ multiple :mod:`junction <elements.junction>` elements can be used specify the same
+ project as a subproject.
+ """
+
self.normal_name = _get_normal_name(self.name)
"""A normalized element name