Skip to content

Document disabling debug-builtins a bit more#7736

Merged
alexcrichton merged 1 commit into
bytecodealliance:mainfrom
alexcrichton:document-debug-builtins
Jan 2, 2024
Merged

Document disabling debug-builtins a bit more#7736
alexcrichton merged 1 commit into
bytecodealliance:mainfrom
alexcrichton:document-debug-builtins

Conversation

@alexcrichton
Copy link
Copy Markdown
Member

Closes #7720

@alexcrichton alexcrichton requested review from a team as code owners January 2, 2024 15:44
@alexcrichton alexcrichton requested review from fitzgen and removed request for a team January 2, 2024 15:44
@github-actions github-actions Bot added wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime wasmtime:docs Issues related to Wasmtime's documentation labels Jan 2, 2024
@fitzgen fitzgen added this pull request to the merge queue Jan 2, 2024
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 2, 2024

Subscribe to Label Action

cc @peterhuene

Details This issue or pull request has been labeled: "wasmtime:api", "wasmtime:config", "wasmtime:docs"

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 .github/subscribe-to-label.json configuration file.

Learn more.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 2, 2024

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:

    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.
    
  • 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 (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 for more 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.


Details

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

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

Learn more.

@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jan 2, 2024
@alexcrichton alexcrichton added this pull request to the merge queue Jan 2, 2024
Merged via the queue into bytecodealliance:main with commit c263f56 Jan 2, 2024
@alexcrichton alexcrichton deleted the document-debug-builtins branch January 2, 2024 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime wasmtime:docs Issues related to Wasmtime's documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Can't use LLDB to attach to wasmtime 16 anymore

2 participants