Skip to content

docs(#167): align ext-gmp wording and refresh stale comments - #190

Merged
s2x merged 1 commit into
masterfrom
docs/issue-167-info-align-ext-gmp-requirement-wording-a
Nov 6, 2026
Merged

s2x merged 1 commit into
masterfrom
docs/issue-167-info-align-ext-gmp-requirement-wording-a

Conversation

@s2x

@s2x s2x commented Nov 6, 2026

Copy link
Copy Markdown
Member

What changed

The docs disagreed about ext-gmp: AGENTS.md listed it as required, while
README/composer describe it as optional for arbitrary-precision tuple integers,
and the README development prerequisites omitted it. A stale test comment also
claimed CI never has a real libfdb_c.

  • AGENTS.md: PHP 8.2+ with ext-ffi and optional ext-gmp (required for
    arbitrary-precision integers in the tuple layer), keeping the libfdb_c note.
  • README.md: same wording in Requirements and Development prerequisites.
  • composer.json: suggest.ext-gmp now says optional, required for
    arbitrary-precision tuple integers.
  • tests/Unit/NativeClientPartialInitTest.php: the stub comment now explains
    that the stub keeps the singleton lookup independent of a real library, not
    that CI has none.
  • CHANGELOG.md records the change under [Unreleased]/Changed.

Closes #167

How it was tested

  • grep -RIn "ext-gmp" over AGENTS, README, composer.json, TupleCompareTest
    and NativeClientPartialInitTest: wording consistent.
  • PATH=/tmp/opencode/bin:$PATH bin/lint.sh passes; git diff --check clean.
  • Docs reusable workflow could not run as a workflow; its three checks
    (Unreleased section, English-only, relative links) were reproduced manually.
  • PHP 8.2 container Unit suite: 617 tests, 1267 assertions, OK. Host PHP 8.5
    lacks ext-gmp, which reproduces the pre-existing 23 GMP test errors (not a
    regression; tracked separately).

Checklist

  • Tests added or updated, and all checks pass
  • CHANGELOG.md updated under [Unreleased]
  • Documentation updated
  • Everything is written in English
  • The PR title is a Conventional Commit (docs: ...)

@s2x
s2x merged commit 62088a6 into master Nov 6, 2026
8 checks passed
@s2x
s2x deleted the docs/issue-167-info-align-ext-gmp-requirement-wording-a branch November 6, 2026 22:06
s2x added a commit that referenced this pull request Nov 6, 2026
## What changed

Release v1.2.1. `CHANGELOG.md` renames `[Unreleased]` to
`## [1.2.1] - 2026-11-06` and keeps a fresh empty `[Unreleased]`
section.

This release contains the v1.2.1 batch: compose reliability (blob store,
reboot
restart, host-user php), lint bootstrap hardening (checksums,
portability), PHPStan
at the PHP 8.2 floor, macOS platform libraries, compose
deduplication/Compose v2,
and the `ext-gmp` documentation alignment. The macOS runtime check for
#165
remains open/blocked and is not part of this release's verification.

No source file carries a version number: `composer.json` has no
`version`, and
Packagist reads the git tag, so the CHANGELOG section is the only
change.

## How it was tested

- `ci-ok` on this PR (documentation-only change).
- `master` at the merge commit already has a green `ci-ok` from #190.
- After merge: annotated tag `v1.2.1`, release workflow creates the
GitHub
Release from the `[1.2.1]` section, milestone closed, v1.2.2 created and
the
  blocked #165 moved there.

## Checklist

- [x] Tests added or updated, and all checks pass
- [x] `CHANGELOG.md` updated
- [x] Documentation updated
- [x] Everything is written in English
- [x] The PR title is a Conventional Commit (`chore: ...`)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Info] Align ext-gmp requirement wording and refresh stale CI comments

1 participant