@@ -7,16 +7,16 @@ To specify the configuration file to use, pass the `--config` option to
7
7
8
8
The configuration file has the following top-level fields:
9
9
10
- * ` search-paths ` : ` list<string> ` (optional) - a list of paths to search for
11
- dependencies.
12
- * ` skip-validation ` : ` bool ` (optional) - a boolean indicating whether to skip
13
- validation of the resulting composed component.
14
- * ` dependencies ` : ` map<string, dependency> ` (optional) - a map specifying the
15
- explicit locations of transitive dependencies.
16
- * ` instantiations ` : ` map<string, instantiation> ` (optional) - a map specifying
17
- the explicit instantiations of transitive dependencies.
18
- * ` definitions ` : ` list<string> ` (optional) - a list of paths to _ definition_
19
- components.
10
+ - ` search-paths ` : ` list<string> ` (optional) - a list of paths to search for
11
+ dependencies.
12
+ - ` skip-validation ` : ` bool ` (optional) - a boolean indicating whether to skip
13
+ validation of the resulting composed component.
14
+ - ` dependencies ` : ` map<string, dependency> ` (optional) - a map specifying the
15
+ explicit locations of transitive dependencies.
16
+ - ` instantiations ` : ` map<string, instantiation> ` (optional) - a map specifying
17
+ the explicit instantiations of transitive dependencies.
18
+ - ` definitions ` : ` list<string> ` (optional) - a list of paths to _ definition_
19
+ components.
20
20
21
21
## Dependencies
22
22
@@ -25,10 +25,10 @@ dependency, rather than searching the configured search paths.
25
25
26
26
A dependency has the following fields:
27
27
28
- * ` path ` : ` string ` - the path to the WebAssembly component file; the path is
28
+ - ` path ` : ` string ` - the path to the WebAssembly component file; the path is
29
29
relative to the configuration file.
30
30
31
- * ` import ` : ` string ` (optional) - the name to use for importing the component.
31
+ - ` import ` : ` string ` (optional) - the name to use for importing the component.
32
32
If not present, the component at the given path will be defined directly in
33
33
the composed component.
34
34
@@ -49,11 +49,11 @@ dependencies:
49
49
50
50
In the above example, two dependencies are defined in the configuration:
51
51
52
- * ` a` - the contents of `a.wasm` will be defined directly in the composed
53
- component.
54
- * `b` - a component of the same type as `b.wasm` will be imported in the
55
- composed component with name `b`; the original file will not be embedded in the
56
- composed component.
52
+ - ` a` - the contents of `a.wasm` will be defined directly in the composed
53
+ component.
54
+ - ` b` - a component of the same type as `b.wasm` will be imported in the
55
+ composed component with name `b`; the original file will not be embedded in the
56
+ composed component.
57
57
58
58
_Note : importing components from a composed component is not currently
59
59
supported in [Wasmtime](https://github.com/bytecodealliance/wasmtime)._
@@ -68,19 +68,19 @@ instantiated, even allowing a dependency to be instantiated multiple times.
68
68
69
69
An instantiation has the following fields :
70
70
71
- * `dependency` : `string` (optional) - the name of the dependency to
71
+ - `dependency` : ` string` (optional) - the name of the dependency to
72
72
instantiate.
73
73
74
74
If unspecified, the instantiation will be for a dependency of the same name
75
75
as the instantiation itself.
76
76
77
- * `arguments` : `map<string, argument>` (optional) - a mapping of argument
77
+ - `arguments` : ` map<string, argument>` (optional) - a mapping of argument
78
78
names to arguments.
79
79
80
80
Argument names match the names of the imports of the dependency being
81
81
instantiated.
82
82
83
- Note that the instantiation name `$input ` is special and signifies how the input
83
+ Note that the instantiation name `root ` is special and signifies how the input
84
84
component is to be instantiated.
85
85
86
86
# ## Instantiation arguments
@@ -90,9 +90,9 @@ to the instantiation of a dependency.
90
90
91
91
An argument has the following fields :
92
92
93
- * `instance` : `string` - the name of the instance to pass as the argument.
93
+ - `instance` : ` string` - the name of the instance to pass as the argument.
94
94
95
- * `export` : `string` (optional) - the name of the exported instance on
95
+ - `export` : ` string` (optional) - the name of the exported instance on
96
96
` instance` to use as the argument.
97
97
98
98
If not present, the instance specified by `instance` will be passed directly.
@@ -106,7 +106,7 @@ A slightly complex example of configuring instantiations:
106
106
107
107
` ` ` yaml
108
108
instantiations:
109
- $input :
109
+ root :
110
110
arguments:
111
111
a: b
112
112
b:
@@ -118,7 +118,7 @@ instantiations:
118
118
dependency: f
119
119
` ` `
120
120
121
- In the above example, the `$input ` instantiation (i.e. the root instantiation)
121
+ In the above example, the `root ` instantiation (i.e. the root instantiation)
122
122
has explicitly specified that the argument named `a` is to be provided instance
123
123
` b` .
124
124
0 commit comments