bytecodealliance / bytecodealliance/cargo-component

Document `package.metadata.component` configuration

Open
#194 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
Rust
Stars
593
Forks
68
PR merge metrics
No merged PRs in 30d

Description

I'm looking for documentation on `package.metadata.component` configurations that can be specified in `Cargo.toml`.

Currently, [cargo-component-bindings](https://docs.rs/cargo-component-bindings/0.4.1/cargo_component_bindings/macro.generate.html#settings-1) only documents the `[package.metadata.component.bindings]` table.

The default `Cargo.toml` added with `cargo component new --reactor foo` contains these tables.

```toml
[package.metadata.component]
package = "component:foo"
# ...

[package.metadata.component.target]
path = "wit"
# ...

[package.metadata.component.dependencies]
# ...
```

It seems the complete set of options are documented in the [code](https://github.com/bytecodealliance/cargo-component/blob/8cfa63f72dc177916d226157ac4247709ee2b19e/src/metadata.rs#L267).

Can the documentation for all `package.metadata.component` configurations be made accessible somewhere?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.