diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-07-01 20:28:52 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-07-01 20:28:52 +0900 |
| commit | b838bcf8be6f997c7f81d9d93e3542d8b5de2000 (patch) | |
| tree | c7494609d2229595647bf45a875bc874698b9ef9 | |
| parent | 68b375664fa3556389ea44c7f446be97bb4196cb (diff) | |
| download | buildstream-b838bcf8be6f997c7f81d9d93e3542d8b5de2000.tar.gz | |
script.py: Added documentation
Added note that script elements may only depend on other elements
as build dependencies.
| -rw-r--r-- | buildstream/plugins/elements/script.py | 6 | ||||
| -rw-r--r-- | doc/source/format.rst | 2 |
2 files changed, 8 insertions, 0 deletions
diff --git a/buildstream/plugins/elements/script.py b/buildstream/plugins/elements/script.py index f34aff7b8..7198af8aa 100644 --- a/buildstream/plugins/elements/script.py +++ b/buildstream/plugins/elements/script.py @@ -24,6 +24,12 @@ This element allows one to run some commands to mutate the input and create some output. +.. note:: + + Script elements may only specify build dependencies. See + :ref:`the format documentation <format_dependencies>` for more + detail on specifying dependencies. + The default configuration and possible options are as such: .. literalinclude:: ../../../buildstream/plugins/elements/script.yaml :language: yaml diff --git a/doc/source/format.rst b/doc/source/format.rst index 9af733e41..f77f3a368 100644 --- a/doc/source/format.rst +++ b/doc/source/format.rst @@ -289,6 +289,8 @@ may specify additional domains to be understood and processed by their own eleme plugins. +.. _format_dependencies: + Dependencies ------------ The dependency model in BuildStream is simplified by treating software distribution |