[BUG] API trait summaries omit the implementing type and conversion direction #6
Closed
opened 2026-09-12 16:58:53 +02:00 by erikinkinen
·
0 comments
No Branch/Tag specified
main
feature/retained-filesystem-canonical-5d1d4ab
feature/docs-native-terminal-provisioning
feature/retained-filesystem-main-9d01b92
feature/retained-filesystem-runtime-16042db
feature/manual-build-reconciled-6decdef
feature/docs-native-filesystem-authority
feature/c-runtime-terminal-flush-reconciled-6d6bdde
feature/docs-native-c-runtime-abi
feature/owned-stream-invocation-custody
feature/docs-manual-build-admission
feature/retained-filesystem-reconciled-d4753d0
feature/terminal-flush-reconciled-3caea7d
feature/c-runtime-manual-reconciled-a418e24
feature/extended-release-payload-fd3054a
feature/docs-viewport-surviving-18b837c
feature/owned-directory-streams
feature/manual-owner-driven-viewport
feature/manual-api-references-main-fe6362f
feature/docs-98-surviving-merge-e97053f
feature/docs-76-surviving-merge-127c5f7
feature/source-event-clock-authority
feature/owned-directory-streams-merge-ready-89b9aee6
feature/docs-manual-build-admission-merge-ready-c46180e3
feature/x86-startup-resource-contract
feature/docs-pci-platform-resource-handoff-merge-ready-b1223b4a
feature/docs-manual-api-reference-generation
feature/docs-owned-native-invocations-merge-ready-df7a5cf1
feature/manual-persistent-acl-metadata
feature/docs-terminal-flush
feature/docs-private-memory-merge-ready-7f085bf6
feature/docs-manual-build-admission-merge-ready-59adc08c
feature/manual-native-heap-producer-merge-ready-729076ef
feature/docs-native-socket-contracts-merge-ready-54a5cc4c
feature/docs-native-terminal-provisioning-merge-ready-9c530f76
feature/docs-native-pipe-contracts-merge-ready-b1ae68ed
feature/docs-native-signal-contracts-merge-ready-a9c49230
feature/docs-owned-native-invocations
feature/docs-native-loader-contracts-merge-ready-faeb9429
feature/docs-native-hash-command-contracts-merge-ready-a6d46b2d
feature/docs-native-build-source-closure-merge-ready-e108438d
feature/docs-cryptographic-runtime-contracts-merge-ready-114f1b37
feature/docs-uart-modem-and-receiver-merge-ready-c17fdcae
feature/docs-timed-uart-break-merge-ready-f9516f6d
feature/docs-uart-line-configuration-merge-ready-b9ed3b3a
feature/docs-uart-manual-control-merge-ready-feca8857
feature/docs-terminal-read-timing-merge-ready-ed3a0672
feature/docs-terminal-software-flow-merge-ready-d9831a28
feature/docs-terminal-drain-and-deferred-settings-merge-ready-62038abe
feature/docs-terminal-output-boundaries-merge-ready-74a377b1
feature/docs-uart-transmit-completion-merge-ready-3c502ddb
feature/docs-terminal-attributes-merge-ready-af9f1905
feature/docs-native-boot-images-merge-ready-77dd7909
feature/docs-native-clock-and-sleep-merge-ready-33a25bd8
feature/docs-extended-offline-toolchain-images-merge-ready-4923aa23
feature/native-allocation-contracts-merge-ready-6ab1d075
feature/owned-directory-streams-merge-ready-f757843c
feature/compatibility-1-33-contract-merge-ready-81959c10
feature/docs-terminal-peer-flow-merge-ready-05d4af59
feature/docs-native-command-streams-merge-ready-8556c616
feature/docs-native-command-workloads-merge-ready-4368b0d8
feature/docs-native-startup-and-tcg-profiling-merge-ready-b8b3caa1
feature/docs-native-syscall-cpu-context-merge-ready-aa9bbd17
feature/docs-vm-scenario-runner-merge-ready-82d27c73
feature/docs-native-offline-manuals-merge-ready-fd657cf6
feature/docs-roadmap-history-archive-merge-ready-0e05f824
feature/docs-native-threads-and-tls-merge-ready-6e0bcf55
feature/docs-rootless-process-staging-merge-ready-32937416
feature/docs-manual-https-publication-merge-ready-385939bb
feature/docs-posix-implementation-index-merge-ready-3d53b51f
feature/docs-native-current-directory-merge-ready-c070f624
feature/docs-native-realm-workloads-merge-ready-dfa93cad
feature/docs-cryptographic-runtime-contracts
feature/docs-native-hash-command-contracts
feature/compatibility-1-33-contract
feature/pci-platform-resource-handoff
feature/work-branch-fixup-policy
feature/kernel-runtime-image-sources
feature/explicit-kernel-runtime-exports
feature/loaded-runtime-images
feature/counted-processor-topology
feature/docs-cbc-cs3
feature/docs-owned-private-vspaces
feature/release-payload-selection-policy
feature/native-allocation-contracts
feature/locale-byte-string-comparisons
feature/memory-string-family
feature/standard-multibyte-headers
feature/current-locale-multibyte
feature/counted-boot-object-names
feature/manual-native-heap-producer
feature/manual-compatibility-artifact-contract
feature/docs-native-realm-workloads
feature/docs-rootless-process-staging
feature/docs-native-threads-and-tls
feature/docs-native-current-directory
feature/docs-posix-implementation-index
feature/docs-roadmap-history-archive
feature/docs-native-offline-manuals
feature/docs-vm-scenario-runner
feature/docs-native-syscall-cpu-context
feature/docs-native-startup-and-tcg-profiling
feature/docs-native-command-streams
feature/docs-native-command-workloads
feature/docs-extended-offline-toolchain-images
feature/docs-native-clock-and-sleep
feature/docs-native-boot-images
feature/docs-terminal-attributes
feature/docs-uart-transmit-completion
feature/docs-terminal-output-boundaries
feature/docs-terminal-drain-and-deferred-settings
feature/docs-terminal-software-flow
feature/docs-terminal-read-timing
feature/docs-uart-manual-control
feature/docs-timed-uart-break
feature/docs-uart-line-configuration
feature/docs-uart-modem-and-receiver
feature/docs-native-build-source-closure
feature/docs-native-loader-contracts
feature/docs-native-pipe-contracts
feature/docs-native-signal-contracts
feature/docs-native-socket-contracts
feature/docs-manual-https-publication
feature/docs-terminal-peer-flow
feature/manual-compiler-library-variants
feature/manual-owned-framebuffer-renderer
feature/manual-ext-special-inode-contract
feature/manual-product-launch-records
feature/manual-native-c-root-builds
feature/manual-cpu-local-execution-fixture
feature/manual-default-acl-inheritance
feature/manual-owned-serial-invocations
feature/manual-typed-ext4-images
feature/manual-owned-log-output
feature/docs-documentation-governance
feature/ci-source-acquisition
feature/posix-compat
feature/native-cli
feature/phase-4-audit
feature/dynlink
feature/program-loader
feature/e2fs-fat
feature/block-devices
feature/vfs
feature/centralized-process-authority
nightly
ci-feature-retained-filesystem-canonical-5d1d4ab
ci-feature-retained-filesystem-main-9d01b92
ci-feature-retained-filesystem-runtime-16042db
ci-feature-manual-build-reconciled-6decdef
ci-feature-docs-native-filesystem-authority
ci-feature-c-runtime-terminal-flush-reconciled-6d6bdde
ci-feature-docs-native-c-runtime-abi
ci-feature-docs-manual-build-admission
ci-feature-retained-filesystem-reconciled-d4753d0
ci-feature-terminal-flush-reconciled-3caea7d
ci-feature-c-runtime-manual-reconciled-a418e24
ci-feature-extended-release-payload-fd3054a
ci-feature-docs-viewport-surviving-18b837c
ci-feature-owned-directory-streams
ci-feature-manual-owner-driven-viewport
ci-feature-manual-api-references-main-fe6362f
ci-feature-docs-98-surviving-merge-e97053f
ci-feature-docs-76-surviving-merge-127c5f7
ci-feature-source-event-clock-authority
ci-feature-owned-directory-streams-merge-ready-89b9aee6
ci-feature-docs-manual-build-admission-merge-ready-c46180e3
ci-feature-x86-startup-resource-contract
ci-feature-docs-terminal-flush
ci-feature-docs-pci-platform-resource-handoff-merge-ready-b1223b4a
ci-feature-docs-manual-api-reference-generation
ci-feature-docs-owned-native-invocations-merge-ready-df7a5cf1
ci-feature-manual-persistent-acl-metadata
ci-feature-docs-private-memory-merge-ready-7f085bf6
ci-feature-docs-manual-build-admission-merge-ready-59adc08c
ci-feature-manual-native-heap-producer-merge-ready-729076ef
ci-feature-docs-native-terminal-provisioning-merge-ready-9c530f76
ci-feature-docs-native-socket-contracts-merge-ready-54a5cc4c
ci-feature-docs-native-signal-contracts-merge-ready-a9c49230
ci-feature-docs-native-pipe-contracts-merge-ready-b1ae68ed
ci-feature-docs-native-loader-contracts-merge-ready-faeb9429
ci-feature-docs-native-hash-command-contracts-merge-ready-a6d46b2d
ci-feature-docs-native-build-source-closure-merge-ready-e108438d
ci-feature-docs-cryptographic-runtime-contracts-merge-ready-114f1b37
ci-feature-docs-uart-modem-and-receiver-merge-ready-c17fdcae
ci-feature-docs-uart-line-configuration-merge-ready-b9ed3b3a
ci-feature-docs-timed-uart-break-merge-ready-f9516f6d
ci-feature-docs-uart-manual-control-merge-ready-feca8857
ci-feature-docs-terminal-read-timing-merge-ready-ed3a0672
ci-feature-docs-terminal-software-flow-merge-ready-d9831a28
ci-feature-docs-terminal-drain-and-deferred-settings-merge-ready-62038abe
ci-feature-docs-terminal-output-boundaries-merge-ready-74a377b1
ci-feature-docs-uart-transmit-completion-merge-ready-3c502ddb
ci-feature-docs-terminal-attributes-merge-ready-af9f1905
ci-feature-docs-native-boot-images-merge-ready-77dd7909
ci-feature-docs-native-clock-and-sleep-merge-ready-33a25bd8
ci-feature-docs-extended-offline-toolchain-images-merge-ready-4923aa23
ci-feature-docs-owned-native-invocations
ci-feature-native-allocation-contracts-merge-ready-6ab1d075
ci-feature-owned-directory-streams-merge-ready-f757843c
ci-feature-compatibility-1-33-contract-merge-ready-81959c10
ci-feature-docs-terminal-peer-flow-merge-ready-05d4af59
ci-feature-docs-manual-https-publication-merge-ready-385939bb
ci-feature-docs-native-command-workloads-merge-ready-4368b0d8
ci-feature-docs-native-command-streams-merge-ready-8556c616
ci-feature-docs-native-startup-and-tcg-profiling-merge-ready-b8b3caa1
ci-feature-docs-native-syscall-cpu-context-merge-ready-aa9bbd17
ci-feature-docs-vm-scenario-runner-merge-ready-82d27c73
ci-feature-docs-native-offline-manuals-merge-ready-fd657cf6
ci-feature-docs-roadmap-history-archive-merge-ready-0e05f824
ci-feature-docs-posix-implementation-index-merge-ready-3d53b51f
ci-feature-docs-native-current-directory-merge-ready-c070f624
ci-feature-docs-native-threads-and-tls-merge-ready-6e0bcf55
ci-feature-docs-rootless-process-staging-merge-ready-32937416
ci-feature-docs-native-realm-workloads-merge-ready-dfa93cad
ci-feature-docs-cryptographic-runtime-contracts
ci-feature-docs-native-hash-command-contracts
ci-feature-compatibility-1-33-contract
ci-feature-pci-platform-resource-handoff
ci-feature-work-branch-fixup-policy
ci-feature-kernel-runtime-image-sources
ci-feature-explicit-kernel-runtime-exports
ci-feature-loaded-runtime-images
ci-feature-counted-processor-topology
ci-feature-docs-cbc-cs3
ci-feature-docs-owned-private-vspaces
ci-feature-counted-boot-object-names
ci-feature-native-allocation-contracts
ci-feature-release-payload-selection-policy
ci-feature-locale-byte-string-comparisons
ci-feature-standard-multibyte-headers
ci-feature-current-locale-multibyte
ci-feature-memory-string-family
ci-feature-manual-native-heap-producer
ci-feature-owned-stream-invocation-custody
ci-feature-manual-compatibility-artifact-contract
ci-feature-docs-native-realm-workloads
ci-feature-docs-rootless-process-staging
ci-feature-docs-native-threads-and-tls
ci-feature-docs-native-current-directory
ci-feature-docs-posix-implementation-index
ci-feature-docs-roadmap-history-archive
ci-feature-docs-native-offline-manuals
ci-feature-docs-vm-scenario-runner
ci-feature-docs-native-syscall-cpu-context
ci-feature-docs-native-startup-and-tcg-profiling
ci-feature-docs-native-command-streams
ci-feature-docs-native-command-workloads
ci-feature-docs-extended-offline-toolchain-images
ci-feature-docs-native-clock-and-sleep
ci-feature-docs-terminal-attributes
ci-feature-docs-native-boot-images
ci-feature-docs-terminal-output-boundaries
ci-feature-docs-uart-transmit-completion
ci-feature-docs-uart-modem-and-receiver
ci-feature-docs-terminal-drain-and-deferred-settings
ci-feature-docs-terminal-software-flow
ci-feature-docs-terminal-read-timing
ci-feature-docs-uart-manual-control
ci-feature-docs-uart-line-configuration
ci-feature-docs-timed-uart-break
ci-feature-docs-native-build-source-closure
ci-feature-docs-native-loader-contracts
ci-feature-docs-native-pipe-contracts
ci-feature-docs-native-signal-contracts
ci-feature-docs-native-socket-contracts
ci-feature-docs-native-terminal-provisioning
ci-feature-docs-manual-https-publication
ci-feature-docs-terminal-peer-flow
ci-feature-manual-compiler-library-variants
ci-feature-manual-owned-framebuffer-renderer
ci-feature-manual-ext-special-inode-contract
ci-feature-manual-product-launch-records
ci-feature-manual-native-c-root-builds
ci-feature-manual-cpu-local-execution-fixture
ci-feature-manual-default-acl-inheritance
ci-feature-manual-owned-serial-invocations
ci-feature-manual-typed-ext4-images
ci-feature-manual-owned-log-output
ci-feature-docs-documentation-governance
ci-feature-ci-source-acquisition
ci-feature-posix-compat
ci/ZmVhdHVyZS9wb3NpeC1jb21wYXQ
ci-feature-native-cli
ci-feature-phase-4-audit
ci-feature-dynlink
ci-feature-program-loader
ci-feature-e2fs-fat
Labels
Clear labels
alpha-1
EriX Alpha 1 release acceptance
bug
Something is not working
ci
docs
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
performance
Measured performance profiling, bottleneck analysis, and regression budgets.
phase-6
Phase 6: POSIX compatibility, full EriX self-hosting, and its required audits and validation.
question
More information is needed
refactor
Code cleanup, removal of obsolete paths, and structural improvements preserving behavior.
security
wontfix
This won't be fixed
No labels
alpha-1
bug
ci
docs
duplicate
enhancement
help wanted
invalid
performance
phase-6
question
refactor
security
wontfix
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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/docs#6
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Generated library references list only trait names and arguments, omitting the type that implements each trait. Rustdoc can associate a conversion implementation with both its source and destination types. The current renderer consequently presents an outgoing conversion as though it were implemented by the type whose section is being read, and distinct implementations can collapse into one summary.
Reproduction
At docs
fe6f8f7dd8438c4a9e8566ad8293a54edc323d9e, inspectexplicit_trait_implsinscripts/generate-library-api-reference.py. It takes each non-synthetic, non-blanket implementation from a public type's Rustdocimplslist, renders onlytrait, and deduplicates that text. The implementingfortype is ignored.Generate the selected lib-posixabi reference from its original Rustdoc JSON. For example, these distinct conversion directions must retain their implementing type:
The freshly generated arithmetic reference from lib-posixabi
2ce268816eb6f083348d6d8cf5dc5362e4098071lists both abbreviated traits under both types. The already published checked/raw identity references have the same problem. No runtime execution is needed to reproduce this rendering defect.Expected and actual behavior
Expected: a reader can identify the implementing type, conversion direction and applicable generic constraints from each explicit implementation summary. Related implementations must not be mistaken for traits implemented by the section's type. Distinct headers must remain distinct.
Actual: the checked and raw timespec sections both display
From<TimespecV1>andTryFrom<RawTimespecV1>without their different implementing types. The source JSON preserves that distinction; the renderer discards it. Successful generation and typesetting do not establish semantic accuracy.Environment and identity
fe6f8f7dd8438c4a9e8566ad8293a54edc323d9e.79a3b02cacc5e56eb53e2d5adbdc24efdeaa21cd; expanded arithmetic source:2ce268816eb6f083348d6d8cf5dc5362e4098071.430d6eddfc6a455ca4a0137c0822a982cccd3b2b.Evidence and prior checks
The original field-level JSON and generated TeX are retained. The new arithmetic inventory has 137 public routes, twenty additions and no removed routes; its generator/check passes, demonstrating that existing freshness checks do not detect this semantic loss. Current Rust implementation and CI pass independently; they do not validate the prose's attribution.
The renderer currently filters synthetic and blanket implementations. The correction must preserve that selection policy unless separately reviewed, retain implementing types and generic constraints, and test checked/raw conversion directions independently. Review the affected retained snapshots against their exact JSON digests before regenerating them; historical source labels must not become fresh-source claims.
The correction is signed and pushed as Docs
3fd9a53548a45967948c0000fa9465c96330ee95in WIP PR #4. Full implementation headers preserve direction, implementing type, arguments, generic constraints, safety and polarity. Repeated references to one Rustdoc ID are deduplicated; distinct implementation identities remain separate. Colliding source spellings receive defining-type identity comments, explicitly distinguished from public access routes. Enum summaries are a separate documentation expansion.All 44 warning-denied documentation tests and all 34 selected reference checks pass. Twelve original implementation cases fail against the preceding renderer and pass with the correction. Thirty-two references change and two remain byte-identical; the 33 historical catalog rows/JSON digests stay unchanged, while the compatibility entry selects its 137-route original arithmetic snapshot. The revised complete manual passes in 169.96 seconds: 2,313 pages, 416,124 finite word boxes, no final warnings or out-of-page text, with independent visual checks. PDF SHA-256 is
a44c7263ae601584c85ccfe089db48ae1484a1fa3c9000c9db09f124160e7056. Exact-head push CI 817 and PR CI 818 now both pass all jobs, including 44 tests and the complete 2,313-page manual. Provisional cross-reference warnings resolve before the clean final TeX pass and enforced final-log gate. The implementing-type/direction defect is corrected in the selected references; the separate audit of historical JSON provenance remains open and is not claimed by this fix.Tracking
Documentation stream: docs #1; related declaration-shape defect: docs #5; implementation: docs PR #4; ABI contract: lib-posixabi #1.
Add independent literal fixtures for implementation direction and generic identity, regenerate affected references from verified original inputs, and pass documentation unit/freshness checks plus the complete manual's final warning gate. Do not publish the misleading arithmetic candidate as accepted documentation or alter Rust API behavior to fit the renderer.
erikinkinen referenced this issue from erix/lib-posixabi2026-09-12 16:59:59 +02:00
erikinkinen referenced this issue2026-09-12 18:19:44 +02:00