aboutsummaryrefslogtreecommitdiff
path: root/docs/yaml/objects/subproject.yaml
blob: d84e3f066ded4ef1d5c8136bd99c0a5665a361cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
name: subproject
long_name: Subproject object
description: This object is returned by [[subproject]] and is an opaque object representing it.

methods:
- name: found
  returns: bool
  since: 0.48.0
  description: Returns whether the subproject was successfully setup.

- name: get_variable
  returns: any
  description: |
    fetches the specified variable from inside the subproject.
    This is useful to, for instance, get a
    [[declare_dependency]] from the [subproject](Subprojects.md).

    If the variable does not exist, the variable `fallback` is returned.
    If a fallback is not specified, then attempting to read a non-existing
    variable will cause a fatal error.

  posargs:
    var_name:
      type: str
      description: The name of the variable to query

  optargs:
    fallback:
      type: any
      description: The fallback value to return if `var_name` does not exist.