Repository navigation
docs: add Alpine/CI container guidance, clarify tree-sitter limitations, and improve backend error message - #78
Merged
Conversation
…ns, and improve backend error message
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.
Resolves #77.
Overview
Following investigation of #77 (where
autopxdfailed inside an Alpine Linux /musllinuxcibuildwheel container because neitherlibclang.sonor theautopxd2[treesitter]extra was available in the isolated build environment), this PR provides clearer guidance, explicit documentation of backend limitations, and a more actionable error message.Changes
CLI Error Message (
autopxd/__init__.py):libclangis requested or resolved but unavailable, the error message now lists package managers for common Linux distributions (including Alpineapk add clang-dev).tree-sitteralternative (pip install "autopxd2[treesitter]"+autopxd --backend tree-sitter) while explicitly noting that it is more limited (single file only, no#includerecursion, no#definemacros).test/test_cli.pyto verify this guidance.System Package Managers (
README.md,docs/getting-started/installation.md):apk add clang-dev.Headless CI & Build Containers Guide (
README.md,docs/getting-started/installation.md):libclang(e.g.before-all = "apk add clang-dev") or by declaringautopxd2[treesitter]inbuild-system.requires.Tree-sitter Limitations & Trade-offs (
README.md,docs/user-guide/backends.md):libclang(no#includeexpansion, no#definemacro extraction, no system include detection, rejects--std/--clang-arg).Changelog (
CHANGELOG.md):[Unreleased].