From 2877b0c49f9fdd2ba24b74f64a918cdcb9ff2238 Mon Sep 17 00:00:00 2001 From: Mark McCaskey Date: Thu, 24 Sep 2020 17:53:02 -0700 Subject: [PATCH] Begin listing specific things we want to cover in the migration docs --- docs/migration_to_1.0.0.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/migration_to_1.0.0.md b/docs/migration_to_1.0.0.md index 09fa851d071..c05f903697a 100644 --- a/docs/migration_to_1.0.0.md +++ b/docs/migration_to_1.0.0.md @@ -30,7 +30,11 @@ Install the latest versions of wasmer with [wasmer-nightly]. ### Using Wasmer 1.0.0 -The CLI interface for Wasmer 1.0.0 is the same as it was in Wasmer 0.X. +The CLI interface for Wasmer 1.0.0 is mostly the same as it was in Wasmer 0.X. + +One difference is that rather than specifying the compiler with `--backend=cranelift`, +in Wasmer 1.0.0 we prefer using the name of the backend as a flag directly, +for example: `--cranelift`. The top level crates that users will usually interface with are: @@ -61,6 +65,31 @@ provided ABIs such as [wasmer-wasi]. However for users that need finer grained c the behavior of wasmer, other crates such as [wasmer-compiler] and [wasmer-engine] may be used to implement custom compilers and engines respectively. +## Differences + +### Instantiating modules + +TODO: link to example, etc. + +### Passing host functions + +TODO: link to example showing advanced uses of the import object, show some example code inline and compare it to old wasmer + +### Accessing the environment as a host function + +TODO: link to example showing host functions accessing VM internals such as memory, calling other functions, etc., show some example code inline and compare it to old wasmer + +### Error handling + +TODO: link to example doing error handling, show inline what it looks like and compare it to old wasmer + +### Caching modules + +TODO: link to example, etc. + +### Metering + +TODO: link to example, etc. [examples]: https://github.com/wasmerio/wasmer/tree/master/examples [wasmer]: https://crates.io/crates/wasmer/1.0.0-alpha3