aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2022-03-14 15:08:19 +0100
committerDylan Baker <dylan@pnwbakers.com>2022-03-14 10:27:38 -0700
commit94be5b8b48866d22d398326d45935ce2eff63beb (patch)
tree9ad116d9177e113f9ed8cf1347a6251528aceebc
parent6dd04ce57cae20694d9e1410b201164d980454f1 (diff)
downloadmeson-94be5b8b48866d22d398326d45935ce2eff63beb.zip
meson-94be5b8b48866d22d398326d45935ce2eff63beb.tar.gz
meson-94be5b8b48866d22d398326d45935ce2eff63beb.tar.bz2
sourceset: document fields of SourceSetRule
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
-rw-r--r--mesonbuild/modules/sourceset.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/mesonbuild/modules/sourceset.py b/mesonbuild/modules/sourceset.py
index 3c15749..e6ba9ff 100644
--- a/mesonbuild/modules/sourceset.py
+++ b/mesonbuild/modules/sourceset.py
@@ -59,11 +59,23 @@ _WHEN_KW: KwargInfo[T.List[T.Union[str, dependencies.Dependency]]] = KwargInfo(
class SourceSetRule(T.NamedTuple):
keys: T.List[str]
+ """Configuration keys that enable this rule if true"""
+
sources: T.List[T.Union[mesonlib.FileOrString, build.GeneratedTypes]]
+ """Source files added when this rule's conditions are true"""
+
if_false: T.List[T.Union[mesonlib.FileOrString, build.GeneratedTypes]]
+ """Source files added when this rule's conditons are false"""
+
sourcesets: T.List[SourceSetImpl]
+ """Other sourcesets added when this rule's conditions are true"""
+
deps: T.List[dependencies.Dependency]
+ """Dependencies that enable this rule if true"""
+
extra_deps: T.List[dependencies.Dependency]
+ """Dependencies added when this rule's conditions are true, but
+ that do not make the condition false if they're absent."""
class SourceFiles(T.NamedTuple):