github
/
cranelift
mirror of https://github.com/bytecodealliance/wasmtime.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10689 Commits
49 Branches
140 Tags
128 MiB
Tree: d1920f5a2d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd1920f5a2d'
${ noResults }
cranelift/docs/SUMMARY.md

66 lines
2.8 KiB
Raw Normal View History

Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
# Summary
- [Introduction](./introduction.md)
- [Tutorial](./tutorial.md)
- [Creating `hello-world.wasm`](./tutorial-create-hello-world.md)
- [Running `hello-world.wasm`](./tutorial-run-hello-world.md)
- [Examples](./examples.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Markdown Parser](./examples-markdown.md)
[doc] Add some documentation for debugging The previous documentation only covers how to enable debug info when embedding Wasmtime. This change should cover the commonly-asked question: how do I debug in Wasmtime?
3 years ago
- [Debugging WebAssembly](./examples-debugging.md)
Enable jitdump profiling support by default (#1310) * Enable jitdump profiling support by default This the result of some of the investigation I was doing for #1017. I've done a number of refactorings here which culminated in a number of changes that all amount to what I think should result in jitdump support being enabled by default: * Pass in a list of finished functions instead of just a range to ensure that we're emitting jit dump data for a specific module rather than a whole `CodeMemory` which may have other modules. * Define `ProfilingStrategy` in the `wasmtime` crate to have everything locally-defined * Add support to the C API to enable profiling * Documentation added for profiling with jitdump to the book * Split out supported/unsupported files in `jitdump.rs` to avoid having lots of `#[cfg]`. * Make dependencies optional that are only used for `jitdump`. * Move initialization up-front to `JitDumpAgent::new()` instead of deferring it to the first module. * Pass around `Arc<dyn ProfilingAgent>` instead of `Option<Arc<Mutex<Box<dyn ProfilingAgent>>>>` The `jitdump` Cargo feature is now enabled by default which means that our published binaries, C API artifacts, and crates will support profiling at runtime by default. The support I don't think is fully fleshed out and working but I think it's probably in a good enough spot we can get users playing around with it!
5 years ago
- [Profiling WebAssembly](./examples-profiling.md)
Adds JIT profiling support for VTune (#819) This patch adds initial support for ittapi which is an open source profiling api for instrumentation and tracing and profiling of jitted code. Result files can be read by VTune for analysis Build: cargo build --features=vtune Profile: // Using amplxe-cl from VTune amplxe-cl -v -collect hostpost target/debug/wasmtime --vtune test.wasm
5 years ago
- [Profiling with Perf](./examples-profiling-perf.md)
- [Profiling with VTune](./examples-profiling-vtune.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [Embedding in Rust](./examples-rust-embed.md)
- [Hello, world!](./examples-rust-hello-world.md)
- [Calculating the GCD](./examples-rust-gcd.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Using Linear Memory](./examples-rust-memory.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [WASI](./examples-rust-wasi.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Linking Modules](./examples-rust-linking.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [Debugging](./examples-rust-debugging.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Using Multi-Value](./examples-rust-multi-value.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [Embedding in C](./examples-c-embed.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Hello, World!](./examples-c-hello-world.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [Calculating the GCD](./examples-c-gcd.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Using Linear Memory](./examples-c-memory.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [WASI](./examples-c-wasi.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Linking Modules](./examples-c-linking.md)
Add examples of linking and WASI (#1369) * Add examples of linking and WASI This commit adds two example programs, one for linking two modules together and one for instantiating WASI. The linkage example additionally uses WASI to get some meaningful output at this time. cc #1272 * Add examples to the book as well * More links! * Ignore examples from rustdoc testsing * More example updates * More ignored
5 years ago
- [Debugging](./examples-c-debugging.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Using Multi-Value](./examples-c-multi-value.md)
wasmtime: fix typo in summary
4 years ago
- [Using WebAssembly from your language](./lang.md)
Add Go as an embedding to the book (#1481) * Add Go as an embedding to the book Also take this time to list out all embeddings in the README of wasmtime itself.
5 years ago
- [Rust](./lang-rust.md)
- [C](./lang-c.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Python](./lang-python.md)
- [.NET](./lang-dotnet.md)
Add Go as an embedding to the book (#1481) * Add Go as an embedding to the book Also take this time to list out all embeddings in the README of wasmtime itself.
5 years ago
- [Go](./lang-go.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Bash](./lang-bash.md)
Add more links to Ruby bindings (#5486) PR #5485 added doc pages for the Ruby bindings, but didn't link to it from the sidebar nor lang page. This commit fixes that.
2 years ago
- [Ruby](./lang-ruby.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Using the `wasmtime` CLI](./cli.md)
- [Installation](./cli-install.md)
- [CLI Options](./cli-options.md)
- [Cache Configuration](./cli-cache.md)
- [Writing WebAssembly](./wasm.md)
- [Rust](./wasm-rust.md)
- [C/C++](./wasm-c.md)
Add documentation for building programs using AssemblyScript. (#1782) * Add documentation for building programs using AssemblyScript. * Add the assemblyscript hello world as an example and display it inline. * Move the AssemblyScript hello world into the docs directory. That way Cargo doesn't try to run it like a Rust example.
5 years ago
- [AssemblyScript](./wasm-assemblyscript.md)
Spice up the project README, fill out more docs (#1010) * Spice up the project README, fill out more docs This is an attempt to spruce up wasmtime's README.md file as well as fill out more of the missing documentation in the `docs/` folder. There's still a long way to go but I hoped here to mostly move around existing information and add new information. As always happy to have feedback! * Tweak CLI wording * Remove no-longer relevant clause * Update sandboxing docs * Handle comments
5 years ago
- [WebAssembly Text Format (`*.wat`)](./wasm-wat.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Stability](stability.md)
- [Release Process](./stability-release.md)
Add definitions of tiers-of-support for Wasmtime (#4479) * Add definitions of tiers-of-support for Wasmtime This commit adds documentation of a Tiers-based system for classifying how supported a component is within Wasmtime. This was somewhat pioneered in the [Wasmtime 1.0 RFC][rfc] but the documentation here is expanded to include more than just API stability but additionally other components. Inspiration for this is drawn from Rust's definition of [support tiers][rust] as well. The motivation for this is to help clarify what exactly it means to live at each tier and what is expected. For example one thing this document clarifies is the requirements necessary for landing new major changes in Wasmtime at all. Additionally this helps clarify what it means to have the highest level of support vs "otherwise well supported". [rfc]: https://github.com/bytecodealliance/rfcs/blob/main/accepted/wasmtime-one-dot-oh.md#tier-1---api-stable-production-quality [rust]: https://doc.rust-lang.org/rustc/target-tier-policy.html * Review comments * Review comments
2 years ago
- [Tiers of support](./stability-tiers.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Platform Support](./stability-platform-support.md)
docs: Document and advertise our support for various Wasm proposals
4 years ago
- [Wasm Proposals Support](./stability-wasm-proposals-support.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Security](security.md)
- [Disclosure Policy](./security-disclosure.md)
- [Contributing](contributing.md)
Start a high-level architecture document for Wasmtime (#3019) * Start a high-level architecture document for Wasmtime This commit cleands up some existing documentation by removing a number of "noop README files" and starting a high-level overview of the architecture of Wasmtime. I've placed this documentation under the contributing section of the book since it seems most useful for possible contributors. I've surely left some things out in this pass, and am happy to add more! * Review comments * More rewording * typos
3 years ago
- [Architecture](./contributing-architecture.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Building](./contributing-building.md)
docs: Add a section about how to test Wasmtime
5 years ago
- [Testing](./contributing-testing.md)
docs: Add a section about how to fuzz Wasmtime
5 years ago
- [Fuzzing](./contributing-fuzzing.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [CI](./contributing-ci.md)
Docs: Expand cross compiling section into its own page (#5284) And fill out everything needed for all non-x64 targets supported by Wasmtime and Cranelift.
2 years ago
- [Cross Compiling](./contributing-cross-compiling.md)
docs: Use Title Case for the Table of Contents
4 years ago
- [Coding Guidelines](./contributing-coding-guidelines.md)
- [Development Process](./contributing-development-process.md)
Document and codify the release process The `wasmtime` release procees seems like it's been a bit ad-hoc up to this point, so I figured it'd be good to try to document what we do today and codify what should be done as well as a form of release checklist. I've noticed that we have a number of releases (like v0.11.0) but the `Cargo.toml` files in the repository don't reflect the current version of `wasmtime`. Additionally I've noticed that the [most recent release] ended up having failed tests because `Cargo.toml` was modified but `Cargo.lock` wasn't updated. I'm hoping that by having a checklist we can avoid these sorts of accidental issues in the future! [release]: https://github.com/bytecodealliance/wasmtime/runs/434690272
5 years ago
- [Release Process](./contributing-release-process.md)
docs: Add contributor docs for implementing and enabling new Wasm proposals
4 years ago
- [Implementing Wasm Proposals](./contributing-implementing-wasm-proposals.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook
5 years ago
- [Governance](./contributing-governance.md)
- [Code of Conduct](./contributing-coc.md)