Stream: git-wasmtime

Topic: wasmtime / PR #8532 Use rustdoc's `doc_auto_cfg` feature ...

Wasmtime GitHub notifications bot (May 03 2024 at 00:45):

alexcrichton requested fitzgen for a review on PR #8532.

Wasmtime GitHub notifications bot (May 03 2024 at 00:45):

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

Wasmtime GitHub notifications bot (May 03 2024 at 00:45):

alexcrichton opened PR #8532 from alexcrichton:doc-auto-cfg to bytecodealliance:main:

This commit removes all our #[cfg_attr(..., doc(cfg(...)))] annotations throughout Wasmtime and wasmtime-wasi. These are all replaced with feature(doc_auto_cfg) which automatically infers the attribute to show rather than requiring us to duplicate it. Spot-checking the docs this looks just-as-readable while being much easier to maintain over time.

<!--
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 (May 03 2024 at 02:00):

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

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 (May 03 2024 at 16:01):

fitzgen submitted PR review:

Nice!

Wasmtime GitHub notifications bot (May 03 2024 at 16:23):

fitzgen merged PR #8532.

Last updated: Dec 23 2024 at 13:07 UTC