File tree Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Original file line number Diff line number Diff line change @@ -72,14 +72,24 @@ struct Common {
72
72
#[ clap( long = "out-dir" ) ]
73
73
out_dir : Option < PathBuf > ,
74
74
75
- /// WIT document to generate bindings for.
76
- #[ clap( value_name = "DOCUMENT" , index = 1 ) ]
75
+ /// Location of WIT file(s) to generate bindings for.
76
+ ///
77
+ /// This path can be either a directory containing `*.wit` files, a `*.wit`
78
+ /// file itself, or a `*.wasm` file which is a wasm-encoded WIT package.
79
+ /// Most of the time it's likely to be a directory containing `*.wit` files
80
+ /// with an optional `deps` folder inside of it.
81
+ #[ clap( value_name = "WIT" , index = 1 ) ]
77
82
wit : PathBuf ,
78
83
79
- /// World within the WIT document specified to generate bindings for.
84
+ /// Optionally specified world that bindings are generated for.
80
85
///
81
- /// This can either be `foo` which is the default world in document `foo` or
82
- /// it's `foo.bar` which is the world named `bar` within document `foo`.
86
+ /// Bindings are always generated for a world but this option can be omitted
87
+ /// when the WIT package pointed to by the `WIT` option only has a single
88
+ /// world. If there's more than one world in the package then this option
89
+ /// must be specified to name the world that bindings are generated for.
90
+ /// This option can also use the fully qualified syntax such as
91
+ /// `wasi:http/proxy` to select a world from a dependency of the main WIT
92
+ /// package.
83
93
#[ clap( short, long) ]
84
94
world : Option < String > ,
85
95
You can’t perform that action at this time.
0 commit comments