summaryrefslogtreecommitdiff
path: root/doc/source/format.rst
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-01-25 23:20:09 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-01-25 23:20:09 +0900
commit5526788e164f18cc5a62a19c12aede6f46308733 (patch)
treed744e273cc8dedee18ff1649c9b293cdfe62c7bb /doc/source/format.rst
parent3830316f2e6765cfbd929fe7e2f3bdcdab7bc62b (diff)
downloadbuildstream-5526788e164f18cc5a62a19c12aede6f46308733.tar.gz
format.rst documentation: Corrected "public" attribute documentation.
Now that it's implemented, it was done as a simple dict and not as a list.
Diffstat (limited to 'doc/source/format.rst')
-rw-r--r--doc/source/format.rst28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/source/format.rst b/doc/source/format.rst
index a74397b16..d28f0fe85 100644
--- a/doc/source/format.rst
+++ b/doc/source/format.rst
@@ -128,11 +128,11 @@ Here is a rather complete example using the autotools element kind and git sourc
configure-commands:
- "%{configure} --enable-fancy-feature"
- # Specify public domain visible to other elements.
+ # Specify public domain data, visible to other elements.
public:
- - domain: integration
- commands:
- - /usr/bin/update-fancy-feature-cache
+ bst:
+ integration-commands:
+ - /usr/bin/update-fancy-feature-cache
For most use cases you would not need to specify this much detail, we've provided
details here in order to have a more complete initial example.
@@ -271,21 +271,21 @@ Public
.. code:: yaml
- # Specify public domain visible to other elements.
+ # Specify public domain data, visible to other elements.
public:
- - domain: integration
- commands:
- - /usr/bin/update-fancy-feature-cache
+ bst:
+ integration-commands:
+ - /usr/bin/update-fancy-feature-cache
Metadata declared in the ``public`` section of an element is visible to
any other element which depends on the declaring element in a given pipeline.
-BuildStream itself supports some built-in domains, for instance the ``integration``
-domain demonstrated above describes commands which should be run in an environment
-where the given element is installed.
+BuildStream itself consumes public data from the ``bst`` domain. The ``integration-commands``
+demonstrated above for example, describe commands which should be run in an
+environment where the given element is installed but before anything should be run.
-That said, users may add their own domain names which are understood by their
-own element plugins. This allows one to use custom domain data on their project
-to provide additional context for any custom element plugins one wants to use.
+An element is allowed to read domain data from any element it depends on, and users
+may specify additional domains to be understood and processed by their own element
+plugins.
Dependencies