From 94be5b8b48866d22d398326d45935ce2eff63beb Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Mon, 14 Mar 2022 15:08:19 +0100 Subject: [PATCH] sourceset: document fields of SourceSetRule Signed-off-by: Paolo Bonzini --- mesonbuild/modules/sourceset.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/mesonbuild/modules/sourceset.py b/mesonbuild/modules/sourceset.py index 3c157495a..e6ba9ffd5 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):