Skip to content

Commit e9359b9

Browse files
authored
Touch up documentation of --world (#1594)
The documentation of this option for the `wasm-tools component embed` subcommand have become a bit dated so this updates the docs.
1 parent 2728f93 commit e9359b9

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/bin/wasm-tools/component.rs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -233,19 +233,21 @@ pub struct EmbedOpts {
233233
/// The expected string encoding format for the component.
234234
///
235235
/// Supported values are: `utf8` (default), `utf16`, and `compact-utf16`.
236-
/// This is only applicable to the `--wit` argument to describe the string
236+
/// This is only applicable to the `wit` argument to describe the string
237237
/// encoding of the functions in that world.
238238
#[clap(long, value_name = "ENCODING")]
239239
encoding: Option<StringEncoding>,
240240

241241
/// The world that the component uses.
242242
///
243-
/// This is the path, within the `WIT` source provided as a positional argument, to the `world`
244-
/// that the core wasm module works with. This can either be a bare string which is a document
245-
/// name that has a `default world`, or it can be a `foo/bar` name where `foo` names a document
246-
/// and `bar` names a world within that document. If the `WIT` source provided contains multiple
247-
/// packages, this option must be set, and must be of the fully-qualified form (ex:
248-
/// "wasi:http/proxy")
243+
/// This is the path, within the `WIT` source provided as a positional
244+
/// argument, to the `world` that the core wasm module works with. If this
245+
/// option is omitted then the "main package" pointed to by `WIT` must have
246+
/// a single world and that's what is used to embed. Otherwise this could be
247+
/// a bare string `foo` to point to the `world foo` within the main
248+
/// package of WIT. Finally this can be a fully qualified name too such as
249+
/// `wasi:http/proxy` which can select a world from a WIT dependency as
250+
/// well.
249251
#[clap(short, long)]
250252
world: Option<String>,
251253

0 commit comments

Comments
 (0)