Skip to content

Commit c2c9770

Browse files
committed
desktops: document repo.suite and repo.components fields
Schema table gains rows for the two optional fields introduced by configng, with a bianbu-flavored explainer for when they apply (frozen per-release snapshots, non-default component set).
1 parent 15506c6 commit c2c9770

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

docs/Developer-Guide_Desktops.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,10 +159,14 @@ Use the per-arch layer for permanent arch-wide holes (e.g. `blender` always miss
159159

160160
| Field | Type | Description |
161161
|---|---|---|
162-
| `url` | string | Base URL for `deb [signed-by=...] <url> <release> main`. |
162+
| `url` | string | Base URL for `deb [signed-by=...] <url> <suite> <components>`. |
163163
| `key_url` | string | URL to the GPG key (ASCII-armored). |
164164
| `keyring` | string | Path to the dearmored keyring file, e.g. `/usr/share/keyrings/neon.gpg`. |
165-
| `preferences` | list (optional) | APT pin preferences written to `/etc/apt/preferences.d/<de_name>`. Each entry needs `origin`, `suite`, and `priority` (integer). Removed on uninstall. |
165+
| `suite` | string (optional) | Suite path that follows the URL in the source line. Defaults to the release codename (e.g. `noble`). Regex-validated to `^[A-Za-z0-9._/-]+$`. Per-release override: `releases.<release>.repo_suite`. |
166+
| `components` | list (optional) | Components that follow the suite. Defaults to `[main]`. Each entry regex-validated to `^[A-Za-z0-9._-]+$`; invalid entries are dropped with a warning. Per-release override: `releases.<release>.repo_components`. |
167+
| `preferences` | list (optional) | APT pin preferences written to `/etc/apt/preferences.d/<de_name>`. Each entry needs `origin`, `suite`, and `priority` (positive integer). Removed on uninstall. |
168+
169+
`suite` and `components` exist for vendor archives whose layout doesn't match the default `<codename> main` convention. For example, SpacemiT's K1 RISC-V archive pins a frozen snapshot per Ubuntu release (`noble/snapshots/v2.2`, `resolute/snapshots/v3.0`) and mirrors all four Ubuntu components, so `bianbu.yaml` sets `components: [main, universe, restricted, multiverse]` at the `repo:` level and overrides `repo_suite` in each release block.
166170

167171
`preferences` is rarely needed — only when a vendor archive must outrank the distro for a given `(origin, suite)` pair. Each list entry becomes one stanza:
168172

0 commit comments

Comments
 (0)