Skip to content

v2 dev docs: an explicit cache directory from the binding's own option also gets the v2-dev subroot, not only CHTYPES_CACHE #527

Description

@EricAndrechek

Reported by a downstream consumer trying Go v2.0.0-dev.0 (measured by them; the behaviour is deliberate, per spec rule r5).

The dev SDK puts its layout under <dir>/v2-dev/ for EVERY explicit cache directory: CHTYPES_CACHE, and also the binding's own option (Go FetchOptions.CacheDir, and its counterparts in the other bindings once they convert). A 1.x consumer treats that option as the layout directory itself, so code that inspects or pre-populates it will look in the wrong place.

Fix (docs only):

  • spec/abi-v2/docs.md r5 should say "any explicit cache directory, from the environment or the binding's option", where today it names only `CHTYPES_CACHE".
  • Each converted binding's README (the 2.0.0-dev banner section) and the v2 fetch docs should say it in one sentence, with the resulting path.

Lands on the v2 branch.

Activity

  1. added a commit that references this issue on Oct 7, 2026
  2. EricAndrechek commented on Oct 7, 2026

    @EricAndrechek
    MemberAuthor

    Landed on v2 in #546 (merge deee6f2), and ships in the next 2.0.0-dev pre-release.

    r5's "explicit cache" rule in spec/abi-v2/docs.md now says the v2-dev subroot applies to any explicit cache directory, not only CHTYPES_CACHE. That covers CHTYPES_CACHE and the binding's own cache-directory option (Go FetchOptions.CacheDir and its counterparts) alike. All four bindings do this, and the shared cache-roots fixture holds them to it. The cache-roots API ported in the same PR (#530) returns the path with the subroot. The ABI fingerprint is unchanged.

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

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions