cp.cache_file: add note re: return for nonexistant salt:// path

saltstack · Jan 23, 2017 · 2e443d7 · 2e443d7
1 parent ac8008d
commit 2e443d7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/salt/modules/cp.py b/salt/modules/cp.py
@@ -419,6 +419,9 @@ def cache_file(path, saltenv='base', env=None):
         salt '*' cp.cache_file salt://foo/bar.conf saltenv=config
         salt '*' cp.cache_file salt://foo/bar.conf?saltenv=config
 
+    If the path being cached is a ``salt://`` URI, and the path does not exist,
+    then ``False`` will be returned.
+
     .. note::
         It may be necessary to quote the URL when using the querystring method,
         depending on the shell being used to run the command.