You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by gi...@apache.org on 2020/12/29 13:19:06 UTC
[buildstream] branch phil/filter-docs created (now 59e4b2b)
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a change to branch phil/filter-docs
in repository https://gitbox.apache.org/repos/asf/buildstream.git.
at 59e4b2b fixup! WIP: doc/examples/: Add toy filter example
This branch includes the following new commits:
new a4a87a9 filter.py: Cross reference docstring with split-rules
new 7ff31d1 WIP: doc/examples/: Add toy filter example
new 59e4b2b fixup! WIP: doc/examples/: Add toy filter example
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[buildstream] 02/03: WIP: doc/examples/: Add toy filter example
Posted by gi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch phil/filter-docs
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 7ff31d16c84317622d0b1d102d8873afece35f6f
Author: Phil Dawson <ph...@codethink.co.uk>
AuthorDate: Mon Aug 6 08:59:49 2018 +0100
WIP: doc/examples/: Add toy filter example
---
doc/examples/filters/elements/.foo.bst.swp | Bin 0 -> 12288 bytes
doc/examples/filters/elements/foo.bst | 15 +++++++++++++++
doc/examples/filters/files/foo/bar1 | 0
doc/examples/filters/files/foo/bar2 | 0
doc/examples/filters/files/foo/baz1 | 0
doc/examples/filters/files/foo/baz2 | 0
doc/examples/filters/files/foo/baz3 | 0
doc/examples/filters/project.conf | 8 ++++++++
8 files changed, 23 insertions(+)
diff --git a/doc/examples/filters/elements/.foo.bst.swp b/doc/examples/filters/elements/.foo.bst.swp
new file mode 100644
index 0000000..7c1cf5f
Binary files /dev/null and b/doc/examples/filters/elements/.foo.bst.swp differ
diff --git a/doc/examples/filters/elements/foo.bst b/doc/examples/filters/elements/foo.bst
new file mode 100644
index 0000000..72422d0
--- /dev/null
+++ b/doc/examples/filters/elements/foo.bst
@@ -0,0 +1,15 @@
+kind: local
+
+config:
+ source:
+ - kind: local
+ path: files/foo/
+
+public:
+ bst:
+ split-rules:
+ bar:
+ - "foo/bar/*"
+ baz:
+ - "foo/baz/*"
+
diff --git a/doc/examples/filters/files/foo/bar1 b/doc/examples/filters/files/foo/bar1
new file mode 100644
index 0000000..e69de29
diff --git a/doc/examples/filters/files/foo/bar2 b/doc/examples/filters/files/foo/bar2
new file mode 100644
index 0000000..e69de29
diff --git a/doc/examples/filters/files/foo/baz1 b/doc/examples/filters/files/foo/baz1
new file mode 100644
index 0000000..e69de29
diff --git a/doc/examples/filters/files/foo/baz2 b/doc/examples/filters/files/foo/baz2
new file mode 100644
index 0000000..e69de29
diff --git a/doc/examples/filters/files/foo/baz3 b/doc/examples/filters/files/foo/baz3
new file mode 100644
index 0000000..e69de29
diff --git a/doc/examples/filters/project.conf b/doc/examples/filters/project.conf
new file mode 100644
index 0000000..5ca9c0c
--- /dev/null
+++ b/doc/examples/filters/project.conf
@@ -0,0 +1,8 @@
+# Unique project name
+name: filters
+
+# Required BuildStream format version
+format-version: 12
+
+# Subdirectory where elements are stored
+element-path: elements
[buildstream] 03/03: fixup! WIP: doc/examples/: Add toy filter
example
Posted by gi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch phil/filter-docs
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 59e4b2bd3a7813321737aec48aa4d1a65d9a2c76
Author: Phil Dawson <ph...@codethink.co.uk>
AuthorDate: Mon Aug 6 11:44:22 2018 +0100
fixup! WIP: doc/examples/: Add toy filter example
---
doc/examples/filters/elements/.foo.bst.swp | Bin 12288 -> 0 bytes
doc/examples/filters/elements/foo-filter.bst | 12 ++++++++++++
doc/examples/filters/elements/foo.bst | 16 +++++++++-------
3 files changed, 21 insertions(+), 7 deletions(-)
diff --git a/doc/examples/filters/elements/.foo.bst.swp b/doc/examples/filters/elements/.foo.bst.swp
deleted file mode 100644
index 7c1cf5f..0000000
Binary files a/doc/examples/filters/elements/.foo.bst.swp and /dev/null differ
diff --git a/doc/examples/filters/elements/foo-filter.bst b/doc/examples/filters/elements/foo-filter.bst
new file mode 100644
index 0000000..590aa2d
--- /dev/null
+++ b/doc/examples/filters/elements/foo-filter.bst
@@ -0,0 +1,12 @@
+kind: filter
+
+depends:
+- filename: foo.bst
+ type: build
+
+config:
+ include:
+ - bar
+
+ exclude:
+ - baz
diff --git a/doc/examples/filters/elements/foo.bst b/doc/examples/filters/elements/foo.bst
index 72422d0..5f77fd1 100644
--- a/doc/examples/filters/elements/foo.bst
+++ b/doc/examples/filters/elements/foo.bst
@@ -1,15 +1,17 @@
-kind: local
+kind: import
-config:
- source:
- - kind: local
- path: files/foo/
+sources:
+- kind: local
+ path: files/foo/
+
+config:
+ target: /
public:
bst:
split-rules:
bar:
- - "foo/bar/*"
+ - "bar*"
baz:
- - "foo/baz/*"
+ - "baz*"
[buildstream] 01/03: filter.py: Cross reference docstring with
split-rules
Posted by gi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch phil/filter-docs
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit a4a87a98472043b2fdf2ca97d60eb53621f154f0
Author: Phil Dawson <ph...@codethink.co.uk>
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