[BUG] Read-response test crate omits its documentation lint #10

Closed
opened 2026-10-15 00:52:20 +02:00 by erikinkinen · 1 comment
Owner

Summary

The read-response integration test is a separate Rust crate but does not enable the required missing_docs lint. The complete source-policy gate rejects it, preventing documentation acceptance of the selected graph.

Reproduction

Use LibIPC 61b43723 and the workflow’s pinned Integration helper 8184ef4b6443384222266be7d40a312b55d2c17e. Prepare the declared dependencies and both Cargo manifests in LibIPC, then run the checker from the pinned Integration worktree:

python3 scripts/check-rustdoc-policy.py /path/to/lib-ipc \
  --git /usr/bin/git --cargo /path/to/cargo

Expected and actual behavior

Every authored Cargo target must enable deny(missing_docs) or forbid(missing_docs) at its crate root.

The checker exits with status 1 and reports:

lib-ipc: tests/read_response_prefix.rs: crate root requires unconditional #![deny(missing_docs)] or forbid

The file has module and test documentation, but lacks the crate-level lint attribute.

Environment and identity

  • Affected source: LibIPC 61b43723e9b6c434c4dc51eaa9709625c1a2d475.
  • Checker: Integration 8184ef4b6443384222266be7d40a312b55d2c17e, with actual Cargo metadata and maintained Git files defining coverage.
  • Host source check; no image, firmware or guest execution is involved.
  • The read-response test crate was introduced with the affected change. A preceding passing result for this new crate is unavailable.

Evidence and prior checks

The complete selected graph scan reports this as its only documentation-policy error. LibIPC’s component workflow previously ran its tests without checking that every discovered crate root enabled the lint. Keep the existing policy strict and include integration test targets in component CI.

Tracking

Related: repository audit, implementation PR, phase completion.

  • Enable the required lint in the read-response test crate.
  • Check all authored Cargo target roots in LibIPC’s component workflow.
  • Complete the original source-policy gate and current component CI with the fix.
## Summary The read-response integration test is a separate Rust crate but does not enable the required `missing_docs` lint. The complete source-policy gate rejects it, preventing documentation acceptance of the selected graph. ## Reproduction Use [LibIPC `61b43723`](https://git.erikinkinen.fi/erix/lib-ipc/commit/61b43723e9b6c434c4dc51eaa9709625c1a2d475) and the workflow’s pinned Integration helper `8184ef4b6443384222266be7d40a312b55d2c17e`. Prepare the declared dependencies and both Cargo manifests in LibIPC, then run the checker from the pinned Integration worktree: ```sh python3 scripts/check-rustdoc-policy.py /path/to/lib-ipc \ --git /usr/bin/git --cargo /path/to/cargo ``` ## Expected and actual behavior Every authored Cargo target must enable `deny(missing_docs)` or `forbid(missing_docs)` at its crate root. The checker exits with status 1 and reports: ```text lib-ipc: tests/read_response_prefix.rs: crate root requires unconditional #![deny(missing_docs)] or forbid ``` The file has module and test documentation, but lacks the crate-level lint attribute. ## Environment and identity - Affected source: LibIPC `61b43723e9b6c434c4dc51eaa9709625c1a2d475`. - Checker: Integration `8184ef4b6443384222266be7d40a312b55d2c17e`, with actual Cargo metadata and maintained Git files defining coverage. - Host source check; no image, firmware or guest execution is involved. - The read-response test crate was introduced with the affected change. A preceding passing result for this new crate is unavailable. ## Evidence and prior checks The complete selected graph scan reports this as its only documentation-policy error. LibIPC’s component workflow previously ran its tests without checking that every discovered crate root enabled the lint. Keep the existing policy strict and include integration test targets in component CI. ## Tracking Related: [repository audit](https://git.erikinkinen.fi/erix/lib-ipc/issues/1), [implementation PR](https://git.erikinkinen.fi/erix/lib-ipc/pulls/2), [phase completion](https://git.erikinkinen.fi/erix/integration/issues/65). - [x] Enable the required lint in the read-response test crate. - [x] Check all authored Cargo target roots in LibIPC’s component workflow. - [x] Complete the original source-policy gate and current component CI with the fix.
Author
Owner

647f5394 enables the test-crate lint and adds the complete Cargo-target documentation check to CI. The source gate covers both manifests and all 113 crate roots. The original workflow passes both jobs with no warnings. This closes the lint defect; consumer adoption continues separately.

[647f5394](https://git.erikinkinen.fi/erix/lib-ipc/commit/647f53943eea9c2a55c1fb1d1532f895a4c5370a) enables the test-crate lint and adds the complete Cargo-target documentation check to CI. The source gate covers both manifests and all 113 crate roots. [The original workflow](https://git.erikinkinen.fi/erix/lib-ipc/actions/runs/616) passes both jobs with no warnings. This closes the lint defect; consumer adoption continues separately.
erikinkinen added this to the Alpha 1 milestone 2026-10-30 09:34:47 +01:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
erix/lib-ipc#10
No description provided.