sarman/tftsr-devops_investigation
1
1
Fork 0
Code Issues 4 Pull Requests Actions 34 Packages Projects 3 Releases 6 Wiki Activity

docs: document pkg-config environment variable strategy
Some checks failed
Test / frontend-tests (pull_request) Successful in 1m42s
Details
Test / frontend-typecheck (pull_request) Successful in 1m50s
Details
PR Review Automation / review (pull_request) Successful in 3m42s
Details
Test / rust-fmt-check (pull_request) Successful in 11m37s
Details
Test / rust-clippy (pull_request) Has been cancelled
Details
Test / rust-tests (pull_request) Has been cancelled
Details

Browse Source 
Explain the SODIUM_USE_PKG_CONFIG settings for each platform:
- Linux: Force pkg-config detection (libsodium-dev installed)
- Windows: Disable pkg-config (explicit SODIUM_LIB_DIR)
- ARM64: Force pkg-config detection (cross-compile)

Include rationale for libsodium-sys-stable's env var precedence order.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Shaun Arman 2026-06-14 02:42:32 -05:00
parent e29db718d2
commit 8570491f91
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
LIBSODIUM_BUILD_FIX.md
View File

@ -36,8 +36,26 @@ This fix resolves build failures across all CI/CD build targets (Linux amd64/arm
### 2. CI/CD Pipeline Fix ### 2. CI/CD Pipeline Fix
**`.gitea/workflows/auto-tag.yml`** **`.gitea/workflows/auto-tag.yml`**
- Added `SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib` to Windows build environment
**Linux amd64 build:**
- Added `SODIUM_USE_PKG_CONFIG: "1"` to force pkg-config detection of libsodium
**Linux arm64 build:**
- Added `SODIUM_USE_PKG_CONFIG: "1"` to force pkg-config detection for cross-compiled libsodium
**Windows cross-compile build:**
- Added `SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib` to point to pre-built libsodium
- Added `SODIUM_STATIC: "1"` to ensure static linking of pre-built libsodium - Added `SODIUM_STATIC: "1"` to ensure static linking of pre-built libsodium
- Added `SODIUM_USE_PKG_CONFIG: "no"` to prevent conflict with explicit SODIUM_LIB_DIR
**Rationale:**
`libsodium-sys-stable`'s build.rs checks environment variables in this order:
1. If `SODIUM_LIB_DIR` is set → use explicit path (incompatible with `SODIUM_USE_PKG_CONFIG`)
2. If `SODIUM_USE_PKG_CONFIG` is not "no" → try pkg-config detection
3. Fall back to vcpkg or fail
Linux builds have `libsodium-dev` + `pkg-config` installed, so we force pkg-config mode.
Windows has pre-compiled libsodium at a known path, so we use explicit path mode and disable pkg-config.
### 3. Test Coverage ### 3. Test Coverage