Added warning against using glob patterns on Windows

We have found issues regarding the use of glob patterns on Windows (see tickets below). However, we will not fix these issues before the next minor release. Therefore, we added a warning in the documentation advising to safeguard against any use on the Windows platforms. Ticket: ENT-10250, ENT-10490 Changelog: None Signed-off-by: Lars Erik Wik <[email protected]>
cfengine · Sep 20, 2023 · a0d56c7 · a0d56c7
1 parent f47f6b5
commit a0d56c7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/reference/functions/findfiles.markdown b/reference/functions/findfiles.markdown
@@ -22,6 +22,13 @@ deep.
 This function, used together with the `bundlesmatching` function,
 allows you to do dynamic inputs and a dynamic bundle call chain.
 
+**WARNING:**
+- The current implementation of glob patterns on Windows contains bugs.
+  Therefore, we strongly advise using the `!windows::` class guard expression to
+  safeguard against any use of the function on Windows platforms. Rest assured,
+  we are actively working on resolving these issues and improving its
+  functionality.
+
 **Notes:**
 
 - Brace expansion is not currently supported, `{x,y,anything}` will not match `x` or `y` or `anything`.

diff --git a/reference/functions/findfiles_up.markdown b/reference/functions/findfiles_up.markdown
@@ -24,6 +24,13 @@ shells:
 * `?` matches a single letter
 * `[a-z]` matches any letter from `a` to `z`
 
+**WARNING:**
+- The current implementation of glob patterns on Windows contains bugs.
+  Therefore, we strongly advise using the `!windows::` class guard expression to
+  safeguard against any use of the function on Windows platforms. Rest assured,
+  we are actively working on resolving these issues and improving its
+  functionality.
+
 **Notes:**
 
 - Brace expansion is not currently supported, `{x,y,anything}` will not match `x` or `y` or `anything`.