Skip to content

memory: remove stale documentation after shared-memory migration #586

Description

@4og

Part of #522. Follow-up to #371, which moved score/memory/shared to eclipse-score/communication.

The score/memory documentation still presents Baselibs as the owner of the shared-memory IPC implementation. Its component overview, architecture, and 13 component requirements describe capabilities such as shared-memory management, OffsetPtr allocation, shared containers, inter-process locking, bounds checking, sealed and typed shared memory, and memory-resource registries. Those implementations were removed from this repository during the migration, leaving the documentation to make unsupported ownership and fulfilment claims.

Update the score/memory documentation to describe only the APIs that remain owned by Baselibs. Remove or appropriately retire documentation, architecture elements, and requirement links for functionality now owned by eclipse-score/communication. Reconcile the retained documentation with the actual remaining public APIs and their requirement-to-test traceability, without creating speculative requirements for deprecated forwarding shims.

Acceptance criteria

  • score/memory/docs/ no longer claims that Baselibs implements shared-memory functionality relocated by Relocate score/memory to eclipse-score/communication and clean up remaining baselibs dependencies #371.
  • Obsolete Memory component requirements, architecture elements, and cross-references for relocated functionality are removed or retired consistently.
  • Documentation for the remaining Baselibs-owned Memory APIs accurately reflects their current implementation and ownership.
  • Requirement-to-test links under score/memory/ refer only to retained, valid component requirements that the tests genuinely verify.
  • The documentation build completes without broken need references or metamodel errors caused by the cleanup.

Activity

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

    comp-memoryRelated to score/memory component

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions