docs(readme): call out C toolchain prerequisite for source builds#92
Merged
docs(readme): call out C toolchain prerequisite for source builds#92
Conversation
Without gcc/clang on PATH, CGO is silently disabled and `go build` / `go install` fails at the call site with `undefined: sqlitevec.LoadInto` rather than a clear toolchain error, because `internal/sqlitevec/load.go` is gated by `//go:build cgo`. The README's "Build from source" section already assumed CGO_ENABLED=1 in the command but never said how to make that actually work — leaving the next from-source builder to chase a misleading "undefined symbol" error. Add a short prerequisites paragraph above the build commands, pointing at the existing comprehensive list in docs/getting-started.md.
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
1 participant
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.
Summary
undefined: sqlitevec.LoadInto) so anyone hitting it via search lands on the fix.docs/getting-started.md.Why
internal/sqlitevec/load.gois gated by//go:build cgo. WithoutgcconPATH, CGO is silently disabled and the build fails at the call site (cmd/serve.go:102) withundefined: sqlitevec.LoadIntoinstead of a clear toolchain error. Hit this in practice today on a fresh box.Test plan
git diffis README-only, additive