Skip to content

Commit

Permalink
Clarify version query syntax usage in treefile doc
Browse files Browse the repository at this point in the history
Clarify with example how to use the 'packages' keyword in treefile syntax reference doc, especially the version query syntax that requires special non-obvious quoting.
mtalexan authored Jul 29, 2024
1 parent 6987471 commit 328ac59
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/treefile.md
Original file line number Diff line number Diff line change
@@ -73,8 +73,18 @@ It supports the following parameters:
however, virtual provides are also supported.
For convenience when writing YAML/JSON, entries in this list will also be split by
whitespace. Finally, another syntax special case is that surrounding the entry
with quotes `'` will suppress this whitespace split, and that in turn makes it possible to use version query
syntax such as `'podman >= 4.1'`.
with single quotes (`'`) as part of the string will suppress this whitespace split, and that in turn makes it possible
to use version query syntax (`podman >= 4.1`).

Example:

```yaml
packages:
- ca-certificates
- efitools pesign sbsigntools
- "'podman >= 4.1'"
- kernel-6.9.11-100.fc39
```
* `packages-$basearch`: Array of strings, optional: Set of installed packages, used
only if $basearch matches the target architecture name.

0 comments on commit 328ac59

Please sign in to comment.