diff options
| author | Phil Dawson <phil.dawson@codethink.co.uk> | 2018-08-03 12:54:08 +0100 |
|---|---|---|
| committer | Phil Dawson <phil.dawson@codethink.co.uk> | 2018-09-12 16:06:54 +0100 |
| commit | a4a87a98472043b2fdf2ca97d60eb53621f154f0 (patch) | |
| tree | 452cd389b45ffd8c36afe90b8828bf9efdd0ea87 | |
| parent | b3ffcdc8fcc8d150cf6d75acbc660379b3fc0fcb (diff) | |
| download | buildstream-a4a87a98472043b2fdf2ca97d60eb53621f154f0.tar.gz | |
filter.py: Cross reference docstring with split-rules
| -rw-r--r-- | buildstream/plugins/elements/filter.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/buildstream/plugins/elements/filter.py b/buildstream/plugins/elements/filter.py index 22fddd14f..9e6527564 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 |