Repository navigation
Fix stale and inaccessible rustdoc links - #1616
Merged
Merged
Conversation
This PR updates Rust intra-doc references for the current SDK and backend module layout. It corrects link destinations and keeps references to private or conditionally absent items readable without creating broken links. Details * Qualify SDK, backend, and FFI paths, enum variants, and metadata fields. * Render private and platform- or test-specific identifiers as inline code. * Remove redundant explicit targets and obsolete link definitions. Tests * Builds, validation, and tests were not run, as requested. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 48f22631-7a55-432b-9cd7-1ce978f7dcaa Copilot-Session: 779f991f-da5f-4283-92c6-24a43bc63880 Generated-with: gpt-6.1-sol
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the documentation-reference updates, though builds, rustdoc validation, and tests were not run.
No open issues 🎉
What changed in this PR
Updates Rust documentation references to match MXC’s current SDK and backend layout. All changes are confined to comments; runtime behavior and public APIs remain unchanged.
Changes:
- Correct link targets for SDK types, backend modules, enum variants, metadata fields, and FFI references.
- Render private, platform-specific, and test-only identifiers as inline code to avoid inaccessible links.
- Remove redundant link targets and obsolete link definitions.
Builds, rustdoc validation, and tests were not run.
| File | Description |
|---|---|
src/tools/wxc/src/audit/config.rs |
Renders the private capability constant as inline code. |
src/mxc-sdk/tests/support/wxc_e2e_tests.rs |
Removes the platform-specific Bubblewrap version link. |
src/mxc-sdk/src/policy.rs |
Corrects the documented request type to ContainerRequest. |
src/mxc-sdk/src/core/mxc_telemetry/mod.rs |
Points the panic-hook link to emit_panic. |
src/mxc-sdk/src/core/mxc_common/telemetry/mod.rs |
Renders the private error classifier as inline code. |
src/mxc-sdk/src/core/mxc_common/telemetry/correlation_vector.rs |
Removes links to test-only and private helpers. |
src/mxc-sdk/src/core/mxc_common/models.rs |
Qualifies failure-phase variant links. |
src/mxc-sdk/src/core/mxc_common/logger.rs |
Renders the conditional diagnostics method as inline code. |
src/mxc-sdk/src/core/mxc_common/filesystem_object.rs |
Removes the link to the private normalization helper. |
src/mxc-sdk/src/core/mxc_common/filesystem_canonical.rs |
Renders the Windows API name as inline code. |
src/mxc-sdk/src/core/mxc_common/exec_stream.rs |
Removes a Windows-only link and targets the timeout variant. |
src/mxc-sdk/src/core/mxc_common/diagnostic.rs |
Removes links to private redaction helpers and constants. |
src/mxc-sdk/src/core/learning_mode_windows/extractors.rs |
Renders the private event decoder path as inline code. |
src/mxc-sdk/src/configs/process_container.rs |
Targets the capture_denials metadata field directly. |
src/mxc-sdk/src/bin/wslc_daemon/main.rs |
Renders conditional daemon module names as inline code. |
src/mxc-sdk/src/bin/windows_sandbox_daemon/control_server.rs |
Qualifies the ExecStart link through ipc_exec. |
src/mxc-sdk/src/backends/wslc/common/wslc_bindings.rs |
Removes links to private COM and symbol-validation helpers. |
src/mxc-sdk/src/backends/wslc/common/wsl_container_runner.rs |
Corrects sandbox module links and removes private-item links. |
src/mxc-sdk/src/backends/wslc/common/state_aware.rs |
Qualifies the daemon protocol module link. |
src/mxc-sdk/src/backends/wslc/common/sandbox.rs |
Renders the private stream-buffer module as inline code. |
src/mxc-sdk/src/backends/wslc/common/mod.rs |
Removes the redundant runner link target. |
src/mxc-sdk/src/backends/wslc/common/image.rs |
Renders private timeout and tracking constants as inline code. |
src/mxc-sdk/src/backends/wslc/common/daemon_protocol.rs |
Removes the link to the private encoding helper. |
src/mxc-sdk/src/backends/windows_sandbox/common/sandbox_protocol.rs |
Qualifies the ControlMessage::Exit variant link. |
src/mxc-sdk/src/backends/seatbelt/common/mod.rs |
Removes the macOS-only runner link. |
src/mxc-sdk/src/backends/seatbelt/common/default_env.rs |
Removes links to platform-specific and private helpers. |
src/mxc-sdk/src/backends/process_container/common/job_object.rs |
Renders the private drain-timeout constant as inline code. |
src/mxc-sdk/src/backends/bubblewrap/common/proxy_network.rs |
Corrects the runner path and removes a private constant link. |
src/mxc-sdk/src/backends/bubblewrap/common/mod.rs |
Removes the Linux-only runner link. |
src/mxc-sdk/src/backends/bubblewrap/common/bwrap_command.rs |
Qualifies the backend network-support method link. |
src/ffi/mxc_ffi/src/state_aware.rs |
Qualifies the engine reference through mxc_sdk. |
Review effort: Balanced
Soham Das (SohamDas2021)
approved these changes
Oct 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates Rust intra-doc references for the current SDK and backend
module layout. It corrects link destinations and keeps references to private
or conditionally absent items readable without creating broken links.
Details
Microsoft Reviewers: Open in CodeFlow