mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +00:00
Merge pull request #46640 from terminalmage/file.copy-docs
Clarify the docs for the file.copy state
This commit is contained in:
commit
d329e7af78
@ -5218,9 +5218,14 @@ def copy(
|
|||||||
subdir=False,
|
subdir=False,
|
||||||
**kwargs):
|
**kwargs):
|
||||||
'''
|
'''
|
||||||
If the source file exists on the system, copy it to the named file. The
|
If the file defined by the ``source`` option exists on the minion, copy it
|
||||||
named file will not be overwritten if it already exists unless the force
|
to the named path. The file will not be overwritten if it already exists,
|
||||||
option is set to True.
|
unless the ``force`` option is set to ``True``.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
This state only copies files from one location on a minion to another
|
||||||
|
location on the same minion. For copying files from the master, use a
|
||||||
|
:py:func:`file.managed <salt.states.file.managed>` state.
|
||||||
|
|
||||||
name
|
name
|
||||||
The location of the file to copy to
|
The location of the file to copy to
|
||||||
|
Loading…
Reference in New Issue
Block a user