From dd7ba0b7fb1b52e8eb6f36142f48890aace02481 Mon Sep 17 00:00:00 2001 From: Ole Herman Schumacher Elgesem Date: Fri, 20 Mar 2026 14:18:15 +0100 Subject: [PATCH] Deprecated guest_environments and defaults CFEngine is not compiled with guest_environments by default, so this promise type is not available in most installations. It also hasn't been updated in a long time, so we decided it's better to mark it as deprecated. The defaults promise type is still possible to use, but seems to not be widely used, nor encouraged. You can achieve similar functionality through the use of conditionally setting variables, often by using isvariable() function, and also by having default values in augments files (def.json). Thus, since we don't use defaults ourselves, and encourage users to use normal variables and/or augments instead, it makes sense to mark it as deprecated in docs to discourage its use. Signed-off-by: Ole Herman Schumacher Elgesem --- content/reference/promise-types/defaults.markdown | 2 +- content/reference/promise-types/guest_environments.markdown | 2 +- generator/_references.md | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/reference/promise-types/defaults.markdown b/content/reference/promise-types/defaults.markdown index d133ad130..afdcaa44f 100644 --- a/content/reference/promise-types/defaults.markdown +++ b/content/reference/promise-types/defaults.markdown @@ -1,6 +1,6 @@ --- layout: default -title: defaults +title: defaults (deprecated) aliases: - "/reference-promise-types-defaults.html" --- diff --git a/content/reference/promise-types/guest_environments.markdown b/content/reference/promise-types/guest_environments.markdown index 7a73687e8..9939a38a9 100644 --- a/content/reference/promise-types/guest_environments.markdown +++ b/content/reference/promise-types/guest_environments.markdown @@ -1,6 +1,6 @@ --- layout: default -title: guest_environments +title: guest_environments (deprecated) sorting: 9999 aliases: - "/reference-promise-types-guest_environments.html" diff --git a/generator/_references.md b/generator/_references.md index 9d281b28f..316bad21d 100644 --- a/generator/_references.md +++ b/generator/_references.md @@ -64,3 +64,5 @@ [mpf-services-autorun]: reference-masterfiles-policy-framework-services-autorun.html [package-modules-the-api]: reference-language-concepts-modules-package-module-api.html#the-api [Functions#collecting functions]: /reference/functions/#collecting-functions +[guest_environments]: /reference/promise-types/guest_environments.html +[defaults]: /reference/promise-types/defaults.html