Skip to content

Commit

Permalink
Add deprecation warnings to wasm-compose and wasm-tools compose (#1564)
Browse files Browse the repository at this point in the history
  • Loading branch information
rylev authored May 17, 2024
1 parent cff3c9a commit c034aaf
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ that can be use programmatically as well:
| `wasm-tools objdump` | | Print debugging information about section headers |
| `wasm-tools strip` | | Remove custom sections from a WebAssembly file |
| `wasm-tools demangle` | | Demangle Rust and C++ symbol names in the `name` section |
| `wasm-tools compose` | [wasm-compose] | Compose wasm components together |
| `wasm-tools compose` | [wasm-compose] | Compose wasm components together (*deprecated*) |
| `wasm-tools component new` | [wit-component] | Create a component from a core wasm binary |
| `wasm-tools component wit` | | Extract a `*.wit` interface from a component |
| `wasm-tools component embed` | | Embed a `component-type` custom section in a core wasm binary |
Expand Down
2 changes: 2 additions & 0 deletions crates/wasm-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

## Overview

**IMPORTANT**: `wasm-compose` has been been deprecated in favor of [`wac`](https://github.com/bytecodealliance/wac).

`wasm-compose` is a library for composing [WebAssembly components](https://github.com/webassembly/component-model)
from other WebAssembly components.

Expand Down
3 changes: 3 additions & 0 deletions src/bin/wasm-tools/compose.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ impl Opts {
}

pub fn run(self) -> Result<()> {
eprintln!("WARNING: `wasm-tools compose` has been deprecated.");
eprintln!("");
eprintln!("Please use `wac` instead. You can find more information about `wac` at https://github.com/bytecodealliance/wac.");
let config = self.create_config()?;
log::debug!("configuration:\n{:#?}", config);

Expand Down

0 comments on commit c034aaf

Please sign in to comment.