Repository navigation
docs: bring documentation in line with the code - #110
Merged
Merged
Conversation
kolkov
added
type: docs
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
README: CGO_ENABLED=1 link limitation on Linux/FreeBSD with other cgo code (#72) and its workarounds instead of recommending that setup; FreeBSD -gcflags for CGO_ENABLED=0; Windows calls via syscall.SyscallN; a callback example that works on Windows; avalue reuse for 0 allocs. ARCHITECTURE, PERFORMANCE: real file names, Win64 struct and callback rules, current e2e test coverage, allocation figures re-measured, default builds are dynamic, not static. CONTRIBUTING: GitHub Flow (no develop branch), SPDX headers, lint on every target, golangci-lint v2 install path. SECURITY: supported versions, pointer rules, current CI. ROADMAP: v0.6.8 and v0.7.0 plans, libvips stress-test target (#71), current status. Package docs: compiling ffi example, prepared CallInterface may be shared by goroutines, callback file comments no longer become the package comment, types package comment added.
kolkov
force-pushed
the
docs/actualize-2026-10-18
branch
from
October 24, 2026 09:19
5aaa7a8 to
eda2484
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The public docs had drifted from the code. Some of it was harmless (old file names), but some sent people the wrong way: README recommended
CGO_ENABLED=1for mixing goffi with other cgo code, which is exactly the setup that fails to link on Linux/FreeBSD (#72), and the README callback example panicked on Windows.What changed:
CGO_ENABLED=1link limitation with other cgo code on Linux/FreeBSD and its workarounds; the-gcflagsFreeBSD needs withCGO_ENABLED=0; Windows amd64 calls go throughsyscall.SyscallN, not goffi assembly; a callback example that works on Windows; reusing theavalueslice keeps calls at 0 allocs.developbranch), SPDX license headers, lint on every target, golangci-lint v2 install path.ffiexample compiles again (CallFunctionreturns the errno first);CallInterfacemay be shared by goroutines;// Package fficomments, sogo doc ./ffishows theffi.gopackage comment;typesgets a package comment.CHANGELOG has an
[Unreleased]entry.go build ./...andgo test ./...pass locally (Windows amd64). The README has no goffi version numbers, and no public file links to private paths.