This is an automated email from the ASF dual-hosted git repository. tvb pushed a commit to branch phil/filter-docs in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit a4a87a98472043b2fdf2ca97d60eb53621f154f0 Author: Phil Dawson <[email protected]> AuthorDate: Fri Aug 3 12:54:08 2018 +0100 filter.py: Cross reference docstring with split-rules --- buildstream/plugins/elements/filter.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/buildstream/plugins/elements/filter.py b/buildstream/plugins/elements/filter.py index 22fddd1..9e65275 100644 --- a/buildstream/plugins/elements/filter.py +++ b/buildstream/plugins/elements/filter.py @@ -21,12 +21,16 @@ filter - Extract a subset of files from another element ======================================================= This filters another element by producing an output that is a subset of -the filtered element. +the filtered element. To specify the element to filter, specify it as the one and only build dependency to filter. See :ref:`Dependencies <format_dependencies>` for what dependencies are and how to specify them. +The output of a filter element is defined by including/excluding +domains specified by the :ref:`split rules <public_split_rules>` of the +filter's build dependency. + Dependencies aside from the filtered element may be specified, but they must be runtime dependencies only. This can be useful to propagate runtime dependencies forward from this filter element onto its reverse
