From 328ac59cea7fee8f0d8c624a96cca767cf572bc5 Mon Sep 17 00:00:00 2001 From: Mike Date: Mon, 29 Jul 2024 09:51:53 -0700 Subject: [PATCH] Clarify version query syntax usage in treefile doc 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. --- docs/treefile.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/treefile.md b/docs/treefile.md index 7d47fb1c59..9839589ebd 100644 --- a/docs/treefile.md +++ b/docs/treefile.md @@ -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.