docs: Add an example application that embeds Wasmtime in order to use plugins (#11848)

* docs: Add an example application that embeds Wasmtime in order to use plugins

* Add exact version to clap de

docs: Add an example application that embeds Wasmtime in order to use plugins (#11848)

* docs: Add an example application that embeds Wasmtime in order to use plugins

* Add exact version to clap dependency

* Re-generate Cargo.lock

* Address review feedback

* Refactor args structs

* Address further review comments

* Exclude calculator example from `cargo doc` in CI

show more ...

Reorganize example documentation (#11757)

* Reorganize example documentation

This commit reorganizes example documentation in our online
documentation. The main changes here are:

* Chapter-per-lan

Reorganize example documentation (#11757)

* Reorganize example documentation

This commit reorganizes example documentation in our online
documentation. The main changes here are:

* Chapter-per-language is now removed in favor of tabs-in-a-page for
avoiding having the book be so large. Tabs are made with [mdbook-langtabs].
* Language-specific pages are all consolidated into a single page.
* Language-specific documentation now only mentions where to find docs
instead of trying to document an intro for each language here.
* "Further examples" was folded into the main API section, meaning we
just have one chapter of a lot of examples.

The main goal is to make the book less overwhelming from an example
perspective and ideally make it a bit easier to discover things. The
langtabs plugin is nice but not perfect, e.g. it doesn't support
`#`-anchors nor remembers which language you were looking at. Overall
though I feel this is still better than before.

[mdbook-langtabs]: https://github.com/nx10/mdbook-langtabs

* Fix typos

* Remove testing of mdbook from CI

show more ...

[docs] Add C++ chapter and missing examples (#11569)

* [docs] Add C++ chapter and missing examples

This adds a chapter for C++ embedding. The chapter intro is rudimentary, but there are a bunch mor

[docs] Add C++ chapter and missing examples (#11569)

* [docs] Add C++ chapter and missing examples

This adds a chapter for C++ embedding. The chapter intro is rudimentary, but there are a bunch more examples now: I added C++ ports for everything that already had both a Rust and a C version available, matching the Rust version's behavior where applicable.

* [example] Fix paths in `examples/wasip1/main.c`

* [docs] Add entries for additional Rust and C embedding examples

These examples already existed, but didn't have entries in the docs.

It'll probably make sense to restructure all of this at some point and move the examples into language-specific folders.

* [docs] Remove references to Conan packages from README.md

These packages haven't been updated since Wasmtime 18, so we shouldn't link to them for now.

* Format cpp files

* Format even more cpp files

* Fix some warnings in C++ headers

* Simplify threads.cc example

* Update docs/examples-c-serialize.md

Co-authored-by: Nick Fitzgerald <[email protected]>

* [example] Don't try, do.

* [docs] Restore CMake link in README

* [docs] Improve examples/README.md

* [docs] Address review feedback

---------

Co-authored-by: Alex Crichton <[email protected]>
Co-authored-by: Nick Fitzgerald <[email protected]>

show more ...

Add contributor docs about our RFC process (#11349)

We have some off-hand links to particular RFCs in our docs, but did not have any
general information about our usage of the RFC process. I've adde

Add contributor docs about our RFC process (#11349)

We have some off-hand links to particular RFCs in our docs, but did not have any
general information about our usage of the RFC process. I've added that
information in this commit.

show more ...

Add a bunch of cookbook-style "how do I do X?" examples to the book (#10630)

This tries to cover things that we repeatedly get questions about on Zulip.

Add a style guideline for conditional compilation (#10144)

* Add a style guideline for conditional compilation

I've been doing a fair amount of work recently that's touched on
`#[cfg]` in many ways

Add a style guideline for conditional compilation (#10144)

* Add a style guideline for conditional compilation

I've been doing a fair amount of work recently that's touched on
`#[cfg]` in many ways throughout Wasmtime. I've personally got opinions
about how to structure everything as well, and these opinions are not
always obvious to others or discerned from just reading snippets. To
assist with this I figured it would be nice to have a style guideline
for Wasmtime's conditionally compiled code explaining at least at a high
level what's going on and some rough basic principles.

I've attempted to give this a stab and have added a page to the
contributing documentation about the style guidelines for conditional
compilation. I'm sure I've forgotten something here but my hope is that
we can evolve this over time.

* Fix typo

* Fix code examples

show more ...

Add book-level documentation for Pulley (#10095)

* Add book-level documentation for Pulley

This commit adds some longer form documentation about Pulley in
Wasmtime's online documentation book. This

Add book-level documentation for Pulley (#10095)

* Add book-level documentation for Pulley

This commit adds some longer form documentation about Pulley in
Wasmtime's online documentation book. This covers topics such as:

* What is Pulley?
* How to enable Pulley?
* What happens when using Pulley.
* Advantages/disadvantages of Pulley.
* High-level design of Pulley.
* Decompiling `*.cwasm` Pulley opcodes.
* Profiling Pulley.

* Update docs/examples-pulley.md

Co-authored-by: Joel Dice <[email protected]>

* Don't test examples

---------

Co-authored-by: Joel Dice <[email protected]>

show more ...

Update docs/stabilization of wasm proposals (#9434)

* Update docs/stabilization of wasm proposals

This commit updates our documentation and documented status of various
WebAssembly proposals. The g

Update docs/stabilization of wasm proposals (#9434)

* Update docs/stabilization of wasm proposals

This commit updates our documentation and documented status of various
WebAssembly proposals. The goal of this commit it to explicitly list all
requirements for each WebAssembly proposal in a way such that enabling a
feature requires actively checking this table and performing effort to
fill in. This is intended to mitigate GHSA-q8hx-mm92-4wvg where it was
found that we were accidentally not fuzzing tail calls but had enabled
it by default.

This shuffles around some documentation, modernizes a bit, and notably
tries to list out a green checkbox or red X for the status of various
proposals. Notes for "holes" in the "on by default matrix" are also
added.

* Add a link to the GC tracking issue

* Tweak the list of supported targets

Android is listed in Tier 3 now

show more ...

Document a Wasmtime-specific vulnerability runbook (#9433)

This commit codifies the process [documented
here](https://github.com/bytecodealliance/rfcs/blob/main/accepted/vulnerability-response-runbo

Document a Wasmtime-specific vulnerability runbook (#9433)

This commit codifies the process [documented
here](https://github.com/bytecodealliance/rfcs/blob/main/accepted/vulnerability-response-runbook.md)
in the Wasmtime repository as it relates to Wasmtime itself. There's
also a few minor changes from recent advisories such as:

* We'll no longer use the publish-the-changes-from-the-advisory feature
from GitHub. That basically just doesn't work any more.
* PRs will instead be manually created to have CI run on them to weed
out any issues.
* Details about preparing the `main` branch ahead of the release are
interleaved with the rest of the runbook.

The intention is to supplement the official runbook with
Wasmtime-specific information and flesh out a few minor steps we're
following that are "extra" here too.

show more ...

Reorder book-based documentation (#8130)

On a high level, this is what this PR changed:

1. Move the CLI chapter before the API chapter.
I think this makes sense because the CLI is more high-lev

Reorder book-based documentation (#8130)

On a high level, this is what this PR changed:

1. Move the CLI chapter before the API chapter.
I think this makes sense because the CLI is more high-level.
The same change was proposed in
https://github.com/bytecodealliance/wasmtime/pull/7987.
1. Move some Rust and C examples from the "Examples" chapter into the API chapter.
1. Remove the original main C and Rust chapter introduction files.
They contained mostly outdated or duplicate information.
1. Rename the "Examples" chapter to "Further Examples".
(For lack of a better name.)
1. Rename "Embedding" to "API" at some places since API is a more generally known term.
The term "embedding" is also slightly more confusing, I think,
because the term nowadays also used a lot in LLM-related communication.
1. Read through the entire document and fix some outdated links and information.
1. Fix a missing subheading for Elixir (it was mentioned on the lang page, but not in the menu).

show more ...

Add "what is a security vulnerability?" page to docs (#7963)

Taken from the recently merged RFC:
https://github.com/bytecodealliance/rfcs/blob/main/accepted/what-is-considered-a-security-bug.md

docs: Add a page about test case reduction (#7780)

Gate many CLI/Wasmtime features behind Cargo features (#7282)

* Move `wasmtime explore` behind a Cargo feature

Enable this Cargo feature by default, but enable building the CLI
without the `explore

Gate many CLI/Wasmtime features behind Cargo features (#7282)

* Move `wasmtime explore` behind a Cargo feature

Enable this Cargo feature by default, but enable building the CLI
without the `explore` subcommand.

* Move the `wast` subcommand behind a Cargo feature

* Move support for `wat` behind a CLI feature

This was already conditional in crates such as `wasmtime` and this makes
it an optional dependency of the CLI as well.

* Move CLI cache support behind a Cargo feature

Additionally refactor `wasmtime-cli-flags` to not unconditionally pull
in caching support by removing its `default` feature and appropriately
enabling it from the CLI.

* Move `rayon` behind an optional feature

* Move `http-body-util` dependency behind `serve` feature

* Add a Cargo feature for compiling out log statements

This sets the static features of `log` and `tracing` to statically
remove all log statements from the binary to cut down on binary size.

* Move logging support behind a Cargo feature

Enables statically removing logging support in addition to the previous
compiling out log statements themselves.

* Move demangling support behind a Cargo feature

* Enable building the CLI without cranelift

Compile out the `compile` subcommand for example.

* Gate all profiling support behind one feature flag

This commit moves vtune/jitdump support behind a single `profiling`
feature flag that additionally includes the guest profiler dependencies
now too.

* Move support for core dumps behind a feature flag

* Move addr2line behind a feature

* Fix rebase

* Document cargo features and a minimal build

* Tidy up the source a bit

* Rename compile-out-logging

* Document disabling logging

* Note the host architecture as well

* Fix tests

* Fix tests

* Mention debuginfo stripping

* Fix CI configuration for checking features

* Fix book tests

* Update lock file after rebase

* Enable coredump feature by default

show more ...

Add docs and example for debugging with core dumps (#7087)

* Add docs for debugging with core dumps

* Fix reference to old style CLI flag

* Add `no_run` to example that is only there to trap

Bring some of Wasmtime's documentation more up-to-date (#6994)

* Remove tutorial/wasm-writing documentation

This commit removes the tutorial and "Writing WebAssembly" documentation
sections from Wa

Bring some of Wasmtime's documentation more up-to-date (#6994)

* Remove tutorial/wasm-writing documentation

This commit removes the tutorial and "Writing WebAssembly" documentation
sections from Wasmtime's documentation. These sections are quite dated
at this point (they still recommend `cargo wasi`!) and haven't been
updated much since their inception, especially in the arena of
components. Today it seems best to leave this sort of documentation to
[other resources] which are more tailored towards documentation of
writing wasm.

[other resources]: https://component-model.bytecodealliance.org/

* Remove markdown example from docs

Like the previous commit this is quite dated and recommends
effectively-deprecated tooling and doesn't take into account components.

* Update our intro docs a bit

* Link security blog post from docs

* Fold docs of wasm proposals into tier docs

This was already a bit duplicated so consolidate into one location.
Additionally add some proposals that weren't previously documented and
move some around based on their implementation status.

* Document unsupported features

In an effort to head off questions about platform support I figure it
might be a good idea to start documenting what's not supported at this
time. This is intended to mirror the current state, not future, of
Wasmtime. In other words this should answer the question of "Does
Wasmtime support X?" as opposed to "Does Wasmtime want to support X?"
since we want to eventually support all of these features in the limit.

* Fold WASI docs into tier docs

Similar to the previous commit but for WASI proposals.

show more ...

wmemcheck: update docs. (#6856)

* wmemcheck: update docs.

This PR expands the documentation for the Wasm memchecker (`wmemcheck`)
feature significantly, and also links it from the top-level
documen

wmemcheck: update docs. (#6856)

* wmemcheck: update docs.

This PR expands the documentation for the Wasm memchecker (`wmemcheck`)
feature significantly, and also links it from the top-level
documentation hierarchy.

* Add syntax/language annotations to quotation sections to keep mdbook happy.

show more ...

Add docs on how to profile with samply and perfmaps (#6720)

* Add docs on how to profile with samply and perfmaps

* add summary entry for samply and specify building from source

Add `cli-logging.md` to summary (#6688)

This should fix the broken link reported in #6679; closes #6679.

Basic guest-profiler documentation for the book (#6393)

* Basic guest-profiler documentation for the book

* Review comments

Document our PR reviewer auto-assignment expectations (#6346)

doc: add a page listing supported proposals (#5781)

* doc: add a page listing supported proposals

This adds a table showing Wasmtime's support for various WASI proposals,
much like the one availabl

doc: add a page listing supported proposals (#5781)

* doc: add a page listing supported proposals

This adds a table showing Wasmtime's support for various WASI proposals,
much like the one available for WebAssembly proposals. This change is
related to [#2423], which provides guidelines for implementing WASI
proposals but was never merged.

[#2423]: https://github.com/bytecodealliance/wasmtime/pull/2423

* review: remove phase-gating sentence

show more ...

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.

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.

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

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

show more ...

Improve the `wasmtime` crate's README (#4174)

* Improve the `wasmtime` crate's README

This commit is me finally getting back to #2688 and improving the README
of the `wasmtime` crate. Currently

Improve the `wasmtime` crate's README (#4174)

* Improve the `wasmtime` crate's README

This commit is me finally getting back to #2688 and improving the README
of the `wasmtime` crate. Currently we have a [pretty drab README][drab]
that doesn't really convey what we want about Wasmtime.

While I was doing this I opted to update the feature list of Wasmtime as
well in the main README (which is mirrored into the crate readme),
namely adding a bullet point for "secure" which I felt was missing
relative to how we think about Wasmtime.

Naturally there's a lot of ways to paint this shed, so feedback is of
course welcome on this! (I'm not the best writer myself)

[drab]: https://crates.io/crates/wasmtime/0.37.0

* Expand the "Fast" bullet a bit more

* Reference the book from the wasmtime crate

* Update more security docs

Also merge the sandboxing security page with the main security page to
avoid the empty security page.

show more ...