Skip to content

runtime-adapter: rustdoc fails on private-item links in src/worker/mapping.rs #1003

Closed

Description

In tests/runtime-adapter, RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --features guest --target x86_64-unknown-linux-musl fails: the module documentation of src/worker/mapping.rs (line 14) links the private items WRITTEN_FILE and WRITTEN (rustdoc::private_intra_doc_links). The links have been on dev since 47f8bcd.

#999 covers only the Runner links of the protocol-only and host configurations.

To fix: reword the links, or link to public items. Consider also building the adapter's documentation in each configuration with -D warnings in CI.

Found while validating #963. Related to #833.

Activity

  1. ppenna commented on Oct 29, 2026

    @ppenna
    Contributor

    #1002, the fix for #999, already fixes this, so it now says Fixes #1003 too:

    • e91b8fc rewords the documentation of worker::mapping to state the map probe's file and contents, written and runtime-adapter, instead of linking to the private WRITTEN_FILE and WRITTEN.
    • 9de0965 makes check-nvx-rs build the adapter's documentation with RUSTDOCFLAGS="-D warnings" in each of its three configurations, the guest-only one with --features guest --target x86_64-unknown-linux-musl included.

    Your command fails at dev 24c0370 with the two src/worker/mapping.rs:14 errors, and passes at #1002's head 9de0965. CI run 40836542861 on that head built the guest-only documentation without a warning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions