From 0b84e2e99b4613603f76930d99406e6cf844352c Mon Sep 17 00:00:00 2001 From: Stephen Sherratt Date: Mon, 11 Sep 2023 17:13:17 +1000 Subject: [PATCH 1/3] Clarify documentation for `enable` pseudo-variable The documentation for variables says that for boolean variables the form `name1+name2+name3:var` is equivalent to `name1:var & name2:var & name3:var` but it's possible to write `name1+name2:enable` despite `enable` being the string "enable" or "disable". This change clarifies that `enable` isn't really a variable but syntactic sugar instead. --- doc/pages/Manual.md | 8 +++++--- master_changes.md | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/pages/Manual.md b/doc/pages/Manual.md index 062aaecf749..e4b3079672a 100644 --- a/doc/pages/Manual.md +++ b/doc/pages/Manual.md @@ -492,9 +492,11 @@ the package being defined. resolved direct dependencies of the package - `installed`: whether the package is installed -- `enable`: - takes the value "enable" or "disable" depending on whether the package is - installed +- `enable`: is not a variable. + `pkg1+pkg2+...+pkgN:enable` is syntactic sugar for + `pkg1+pkg2+...+pkgN:installed?enable:disable`. That is, it behaves like a + variable that takes the value "enable" or "disable" depending on whether the + package(s) are installed - `pinned`: whether the package is pinned - `bin`, `sbin`, `lib`, `man`, `doc`, `share`, `etc`: the corresponding directories for this package (similar to diff --git a/master_changes.md b/master_changes.md index 87e54d5acee..5c93227796c 100644 --- a/master_changes.md +++ b/master_changes.md @@ -113,6 +113,8 @@ users) ## Doc + * Clarify documentation for `enable` pseudo-variable + ## Security fixes # API updates From d5e92ccebf68a513b5422e194167f46d03fb5782 Mon Sep 17 00:00:00 2001 From: Kate Date: Wed, 25 Sep 2024 11:16:28 +0100 Subject: [PATCH 2/3] Update doc/pages/Manual.md Co-authored-by: R. Boujbel --- doc/pages/Manual.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/pages/Manual.md b/doc/pages/Manual.md index e4b3079672a..e63c77a65eb 100644 --- a/doc/pages/Manual.md +++ b/doc/pages/Manual.md @@ -492,11 +492,11 @@ the package being defined. resolved direct dependencies of the package - `installed`: whether the package is installed -- `enable`: is not a variable. - `pkg1+pkg2+...+pkgN:enable` is syntactic sugar for - `pkg1+pkg2+...+pkgN:installed?enable:disable`. That is, it behaves like a - variable that takes the value "enable" or "disable" depending on whether the - package(s) are installed +- `enable`: + takes the value "enable" or "disable" depending on whether the package is + installed. Used with the combination operator `+`, + `name1+name2+name3:enable` is syntactic sugar for + `name1+name2+name3:installed?enable:disable`. - `pinned`: whether the package is pinned - `bin`, `sbin`, `lib`, `man`, `doc`, `share`, `etc`: the corresponding directories for this package (similar to From bdf7511a91d5966d5a47e8fd3603e37964538ae4 Mon Sep 17 00:00:00 2001 From: Kate Date: Mon, 30 Sep 2024 12:27:03 +0100 Subject: [PATCH 3/3] Update doc/pages/Manual.md --- doc/pages/Manual.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/pages/Manual.md b/doc/pages/Manual.md index e63c77a65eb..d7a27ee6c9b 100644 --- a/doc/pages/Manual.md +++ b/doc/pages/Manual.md @@ -492,8 +492,8 @@ the package being defined. resolved direct dependencies of the package - `installed`: whether the package is installed -- `enable`: - takes the value "enable" or "disable" depending on whether the package is +- `enable`: is not a variable. + It takes the value "enable" or "disable" depending on whether the package is installed. Used with the combination operator `+`, `name1+name2+name3:enable` is syntactic sugar for `name1+name2+name3:installed?enable:disable`.