diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-06-30 20:07:32 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-06-30 20:07:32 +0900 |
| commit | 426bbcbc744be8097a8324d7ca111336e8427801 (patch) | |
| tree | 4ab6ae5246d39a00476666fd5c7c37703eddbe56 /doc | |
| parent | e0d9af6237408681d39ddff7d1fac415749112b7 (diff) | |
| download | buildstream-426bbcbc744be8097a8324d7ca111336e8427801.tar.gz | |
Enhanced documentation for split-rules public data
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/format.rst | 1 | ||||
| -rw-r--r-- | doc/source/public.rst | 12 |
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/source/format.rst b/doc/source/format.rst index ef4b2cb5b..9af733e41 100644 --- a/doc/source/format.rst +++ b/doc/source/format.rst @@ -356,6 +356,7 @@ required both at build time and runtime. ``runtime`` dependencies will also be staged for the purpose of building. +.. _format_variables: Using Variables --------------- diff --git a/doc/source/public.rst b/doc/source/public.rst index 7bedfaafa..298fc6158 100644 --- a/doc/source/public.rst +++ b/doc/source/public.rst @@ -68,7 +68,11 @@ The ``split-rules`` domains are used by the :func:`Element.stage_artifact() <buildstream.element.Element.stage_artifact>` method when deciding what domains of an artifact should be staged. -This is used for creating compositions with the -:mod:`compose <elements.compose>` element and can be used by other deployment -related elements for the purpose of splitting element artifacts into separate -packages. +The strings listed in each domain are first substituted with the +:ref:`variables <format_variables>` in context of the given element, and +then applied as a glob style match, as understood by +:func:`utils.glob() <buildstream.utils.glob>` + +This is used for creating compositions with the :mod:`compose <elements.compose>` +element and can be used by other deployment related elements for the purpose of +splitting element artifacts into separate packages. |