Stream: git-wasmtime

Topic: wasmtime / PR #7862 Update and add lots of docs, mostly f...

Wasmtime GitHub notifications bot (Feb 02 2024 at 18:38):

alexcrichton requested fitzgen for a review on PR #7862.

Wasmtime GitHub notifications bot (Feb 02 2024 at 18:38):

alexcrichton requested wasmtime-core-reviewers for a review on PR #7862.

Wasmtime GitHub notifications bot (Feb 02 2024 at 18:38):

alexcrichton opened PR #7862 from alexcrichton:component-docs to bytecodealliance:main:

When I originally implemented the embedding API for the component model I left a lot of // TODO: say more here style comments assuming I'd come back around before stabilization. While I didn't quite make it in time for Wasmtime 17 this is my attempt to improve things for the future. This should add substantive documentation for all component-model related things and flesh out some more details here and there. Nowhere near comprehensive but, hey, Rome wasn't built in a day either.

<!--
Please make sure you include the following information:

• If this work has been discussed elsewhere, please include a link to that
  conversation. If it was discussed in an issue, just mention "issue #...".

• Explain why this change is needed. If the details are in an issue already,
  this can be brief.

Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.html

Please ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->

Wasmtime GitHub notifications bot (Feb 02 2024 at 19:44):

github-actions[bot] commented on PR #7862:

Subscribe to Label Action

cc @peterhuene

<details>
This issue or pull request has been labeled: "wasmtime:api", "wasmtime:config"

Thus the following users have been cc'd because of the following labels:

• peterhuene: wasmtime:api

To subscribe or unsubscribe from this label, edit the <code>.github/subscribe-to-label.json</code> configuration file.

Learn more.
</details>

Wasmtime GitHub notifications bot (Feb 02 2024 at 19:45):

github-actions[bot] commented on PR #7862:

Label Messager: wasmtime:config

It looks like you are changing Wasmtime's configuration options. Make sure to
complete this check list:

• [ ] If you added a new Config method, you wrote extensive documentation for
  it.

  <details>

  Our documentation should be of the following form:

  ```text
  Short, simple summary sentence.

  More details. These details can be multiple paragraphs. There should be
  information about not just the method, but its parameters and results as
  well.

  Is this method fallible? If so, when can it return an error?

  Can this method panic? If so, when does it panic?

  Example

  Optional example here.
  ```

  </details>

• [ ] If you added a new Config method, or modified an existing one, you
  ensured that this configuration is exercised by the fuzz targets.

  <details>

  For example, if you expose a new strategy for allocating the next instance
  slot inside the pooling allocator, you should ensure that at least one of our
  fuzz targets exercises that new strategy.

  Often, all that is required of you is to ensure that there is a knob for this
  configuration option in [wasmtime_fuzzing::Config][fuzzing-config] (or one
  of its nested structs).

  Rarely, this may require authoring a new fuzz target to specifically test this
  configuration. See [our docs on fuzzing][fuzzing-docs] for more details.

  </details>

• [ ] If you are enabling a configuration option by default, make sure that it
  has been fuzzed for at least two weeks before turning it on by default.

[fuzzing-config]: https://github.com/bytecodealliance/wasmtime/blob/ca0e8d0a1d8cefc0496dba2f77a670571d8fdcab/crates/fuzzing/src/generators.rs#L182-L194
[fuzzing-docs]: https://docs.wasmtime.dev/contributing-fuzzing.html

---

<details>

To modify this label's message, edit the <code>.github/label-messager/wasmtime-config.md</code> file.

To add new label messages or remove existing label messages, edit the
<code>.github/label-messager.json</code> configuration file.

Learn more.

</details>

Wasmtime GitHub notifications bot (Feb 05 2024 at 04:47):

jeffparsons submitted PR review.

Wasmtime GitHub notifications bot (Feb 05 2024 at 04:47):

jeffparsons created PR review comment:

I initially read this as (what I assume is) the opposite of what it means. How about:

/// * No compilation happens at runtime for a component — everything is done
///   by the time [`Component::new`] returns.

Wasmtime GitHub notifications bot (Feb 05 2024 at 04:47):

jeffparsons created PR review comment:

Nit:

    /// etc., found within the provided bytes.

Wasmtime GitHub notifications bot (Feb 05 2024 at 04:47):

jeffparsons submitted PR review.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:06):

fitzgen updated PR #7862.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:07):

fitzgen updated PR #7862.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:11):

fitzgen submitted PR review.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:11):

fitzgen created PR review comment:

Why this change? Seems nice to have only one cfg.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:11):

fitzgen submitted PR review.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:55):

alexcrichton submitted PR review.

Wasmtime GitHub notifications bot (Feb 05 2024 at 17:55):

alexcrichton created PR review comment:

While I was browsing documentation I realized that the mpk module was reexported to the crate root (e.g. wasmtime::mpk) as opposed to just MpkEnabled. Only the MpkEnabled type should be exported and the mpk module is intended to be private to the crate, hence the split. (I found it a bit unfortunate as well...)

Wasmtime GitHub notifications bot (Feb 05 2024 at 18:38):

alexcrichton merged PR #7862.

Last updated: Oct 23 2024 at 20:03 UTC