docs: clarify planned header sync workflow
- commit
- b35cd9feda87adc9d45f1db91b82846809f7df80
- author
- brice · · 2026-04-09 07:55 UTC
- parent
- 5ce5026
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
4 files · +12 -3
M README.md +2 -0
| @@ -32,6 +32,8 @@ Maintainers can refresh the model from local PipeWire and SPA headers with: | |||
| 32 | 32 | ./scripts/sync-headers.sh | |
| 33 | 33 | go generate ./... | |
| 34 | 34 | ||
| 35 | + | The sync script is currently a placeholder for the planned header-import workflow. | |
| 36 | + | ||
| 35 | 37 | ## Requirements | |
| 36 | 38 | ||
| 37 | 39 | - Go 1.23+ | |
| @@ -32,6 +32,8 @@ Maintainers can refresh the model from local PipeWire and SPA headers with: | |||||
| 32 | ./scripts/sync-headers.sh | 32 | ./scripts/sync-headers.sh | ||
| 33 | go generate ./... | 33 | go generate ./... | ||
| 34 | 34 | ||||
| 35 | + | The sync script is currently a placeholder for the planned header-import workflow. | |||
| 36 | + | ||||
| 35 | ## Requirements | 37 | ## Requirements | ||
| 36 | 38 | ||||
| 37 | - Go 1.23+ | 39 | - Go 1.23+ | ||
M cmd/pipewiregen/README.md +5 -2
| @@ -8,15 +8,18 @@ The `pipewiregen` tool generates Go bindings for PipeWire and SPA libraries from | |||
| 8 | 8 | ||
| 9 | 9 | go run ./cmd/pipewiregen | |
| 10 | 10 | ||
| 11 | - | This reads `gen/pipewire.json` and `gen/spa.json`, then emits: | |
| 11 | + | This currently reads `gen/pipewire.json` and emits: | |
| 12 | 12 | - `internal/capi/*_gen.go` — raw function types and registration helpers | |
| 13 | 13 | - `internal/ports/out/*_gen.go` — outbound port interfaces | |
| 14 | 14 | ||
| 15 | 15 | ### Sync headers from system includes (maintainers) | |
| 16 | 16 | ||
| 17 | + | This workflow is planned but not implemented yet in `cmd/pipewiregen`. | |
| 18 | + | The helper script exists as a placeholder so the intended maintainer flow is documented. | |
| 19 | + | ||
| 17 | 20 | ./scripts/sync-headers.sh | |
| 18 | 21 | ||
| 19 | - | Or run directly: | |
| 22 | + | Planned direct invocation: | |
| 20 | 23 | ||
| 21 | 24 | go run ./cmd/pipewiregen --sync-headers \ | |
| 22 | 25 | --pipewire-include /usr/include/pipewire-0.3 \ | |
| @@ -8,15 +8,18 @@ The `pipewiregen` tool generates Go bindings for PipeWire and SPA libraries from | |||||
| 8 | 8 | ||||
| 9 | go run ./cmd/pipewiregen | 9 | go run ./cmd/pipewiregen | ||
| 10 | 10 | ||||
| 11 | - | This reads `gen/pipewire.json` and `gen/spa.json`, then emits: | 11 | + | This currently reads `gen/pipewire.json` and emits: |
| 12 | - `internal/capi/*_gen.go` — raw function types and registration helpers | 12 | - `internal/capi/*_gen.go` — raw function types and registration helpers | ||
| 13 | - `internal/ports/out/*_gen.go` — outbound port interfaces | 13 | - `internal/ports/out/*_gen.go` — outbound port interfaces | ||
| 14 | 14 | ||||
| 15 | ### Sync headers from system includes (maintainers) | 15 | ### Sync headers from system includes (maintainers) | ||
| 16 | 16 | ||||
| 17 | + | This workflow is planned but not implemented yet in `cmd/pipewiregen`. | |||
| 18 | + | The helper script exists as a placeholder so the intended maintainer flow is documented. | |||
| 19 | + | ||||
| 17 | ./scripts/sync-headers.sh | 20 | ./scripts/sync-headers.sh | ||
| 18 | 21 | ||||
| 19 | - | Or run directly: | 22 | + | Planned direct invocation: |
| 20 | 23 | ||||
| 21 | go run ./cmd/pipewiregen --sync-headers \ | 24 | go run ./cmd/pipewiregen --sync-headers \ | ||
| 22 | --pipewire-include /usr/include/pipewire-0.3 \ | 25 | --pipewire-include /usr/include/pipewire-0.3 \ | ||
M pipewire/readme_test.go +1 -1
| @@ -1,4 +1,4 @@ | |||
| 1 | - | package pipewire | |
| 1 | + | package pipewire_test | |
| 2 | 2 | ||
| 3 | 3 | import ( | |
| 4 | 4 | "os" | |
| @@ -1,4 +1,4 @@ | |||||
| 1 | - | package pipewire | 1 | + | package pipewire_test |
| 2 | 2 | ||||
| 3 | import ( | 3 | import ( | ||
| 4 | "os" | 4 | "os" | ||
M scripts/sync-headers.sh +4 -0
| @@ -1,6 +1,10 @@ | |||
| 1 | 1 | #!/usr/bin/env bash | |
| 2 | 2 | set -euo pipefail | |
| 3 | 3 | ||
| 4 | + | printf '%s\n' 'sync-headers is not implemented yet in cmd/pipewiregen.' >&2 | |
| 5 | + | printf '%s\n' 'This script is a maintainer placeholder for the planned header-sync workflow.' >&2 | |
| 6 | + | exit 1 | |
| 7 | + | ||
| 4 | 8 | go run ./cmd/pipewiregen --sync-headers \ | |
| 5 | 9 | --pipewire-include "${PIPEWIRE_INCLUDE_DIR:-/usr/include/pipewire-0.3}" \ | |
| 6 | 10 | --spa-include "${SPA_INCLUDE_DIR:-/usr/include/spa-0.2}" \ | |
| @@ -1,6 +1,10 @@ | |||||
| 1 | #!/usr/bin/env bash | 1 | #!/usr/bin/env bash | ||
| 2 | set -euo pipefail | 2 | set -euo pipefail | ||
| 3 | 3 | ||||
| 4 | + | printf '%s\n' 'sync-headers is not implemented yet in cmd/pipewiregen.' >&2 | |||
| 5 | + | printf '%s\n' 'This script is a maintainer placeholder for the planned header-sync workflow.' >&2 | |||
| 6 | + | exit 1 | |||
| 7 | + | ||||
| 4 | go run ./cmd/pipewiregen --sync-headers \ | 8 | go run ./cmd/pipewiregen --sync-headers \ | ||
| 5 | --pipewire-include "${PIPEWIRE_INCLUDE_DIR:-/usr/include/pipewire-0.3}" \ | 9 | --pipewire-include "${PIPEWIRE_INCLUDE_DIR:-/usr/include/pipewire-0.3}" \ | ||
| 6 | --spa-include "${SPA_INCLUDE_DIR:-/usr/include/spa-0.2}" \ | 10 | --spa-include "${SPA_INCLUDE_DIR:-/usr/include/spa-0.2}" \ | ||