Skip to content

Commit dd7ba0b

Browse files
committed
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 <ole@northern.tech>
1 parent b229848 commit dd7ba0b

3 files changed

Lines changed: 4 additions & 2 deletions

File tree

content/reference/promise-types/defaults.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: defaults
3+
title: defaults (deprecated)
44
aliases:
55
- "/reference-promise-types-defaults.html"
66
---

content/reference/promise-types/guest_environments.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: guest_environments
3+
title: guest_environments (deprecated)
44
sorting: 9999
55
aliases:
66
- "/reference-promise-types-guest_environments.html"

generator/_references.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,5 @@
6464
[mpf-services-autorun]: reference-masterfiles-policy-framework-services-autorun.html
6565
[package-modules-the-api]: reference-language-concepts-modules-package-module-api.html#the-api
6666
[Functions#collecting functions]: /reference/functions/#collecting-functions
67+
[guest_environments]: /reference/promise-types/guest_environments.html
68+
[defaults]: /reference/promise-types/defaults.html

0 commit comments

Comments
 (0)