Skip to content

Commit 11cca23

Browse files
committed
Packaging: Clarify correct Boolean values for package.yaml
Only `true` and `false` should be used going forward Signed-off-by: Thomas Staudinger <Staudi.Kaos@gmail.com>
1 parent 761ad67 commit 11cca23

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

docs/packaging/package.yml.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ Not all fields in `package.yml` are mandatory, but a small selection are. Below
8787

8888
| Key Name | Type | Description |
8989
| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
90-
| **clang** | `bool` | Set to `yes` if this package benefits from being built with Clang. |
91-
| **extract** | `bool` | Set to `no` to disable automatic source extraction. |
92-
| **autodep** | `bool` | Set to `no` to disable automatic binary dependency resolution at build time. |
93-
| **emul32** | `bool` | Set to `yes` to enable an `-m32` build (32-bit libs). |
94-
| **libsplit** | `bool` | Set to `no` to disable splitting of libraries into `devel` sub-packages. |
90+
| **clang** | `bool` | Set to `true` if this package benefits from being built with Clang. |
91+
| **extract** | `bool` | Set to `false` to disable automatic source extraction. |
92+
| **autodep** | `bool` | Set to `false` to disable automatic binary dependency resolution at build time. |
93+
| **emul32** | `bool` | Set to `true` to enable an `-m32` build (32-bit libs). |
94+
| **libsplit** | `bool` | Set to `false` to disable splitting of libraries into `devel` sub-packages. |
9595
| **conflicts** | `string(s)` | Specify packages that cannot be installed together with this one. |
9696
| **optimize** | `list` | Specify preset keys to modify compiler and linker flags during build. You can learn more [here](/docs/packaging/package.yml#optimize-values). |
9797
| **builddeps** | `list` | Specify build dependencies for the package. You can learn more [here](/docs/packaging/packaging-practices#build-dependencies). |
@@ -100,7 +100,7 @@ Not all fields in `package.yml` are mandatory, but a small selection are. Below
100100
| **replaces** | `dict(s)` | Replace one package with another, used when renaming or deprecating packages for clean upgrade paths. |
101101
| **patterns** | `dict(s)` | Allows fine grained control over file placement within the package or sub-packages. Useful for packages that are development only (i.e. `/usr/bin` files). You can learn more [here](/docs/packaging/packaging-practices#patterns). |
102102
| **environment** | `unicode` | Specify code that will be exported to all packaging steps of the build (i.e. exporting variables for the entire build). |
103-
| **networking** | `bool` | Set to `yes` to enable networking within solbuild. |
103+
| **networking** | `bool` | Set to `true` to enable networking within solbuild. |
104104

105105
### Packaging step keys, optional
106106

docs/packaging/packaging-changes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ This page is meant to serve as a changelog of sorts for the Solus packaging envi
2020
- Like the `go-task update` command, but automatic
2121
- If a package has a completed `monitoring.yaml` file, and a new version is available, the `go-task autoupdate` command tries to guess the new tarball link and update the `package.yml` file
2222

23+
#### Disallowed other Boolean values than `true` or `false` in `package.yml`
24+
25+
- To enable JSON schema work for package.yml files and increased compatibility with YAML 1.2 Booleans must now only be set to `true` or `false`.
26+
- `yes`, `no`, `on`, `off` and all other variations are no longer allowed
27+
2328
### July
2429

2530
#### Changed behaviour on several `go-task` taskfile commands

0 commit comments

Comments
 (0)