saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Fix documentation of file.prepend

Browse source
This commit is contained in:
James Howe 2023-09-15 09:43:30 +01:00 • committed by Daniel Wozniak
parent 2a484f522f
commit dbebd92626
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
salt/states/file.py
View file

@ -6719,10 +6719,10 @@ def prepend(
may specify a single line of text or a list of lines to append.
name
The location of the file to append to.
The location of the file to prepend to.
text
The text to be appended, which can be a single string or a list
The text to be prepended, which can be a single string or a list
of strings.
makedirs
@ -6732,7 +6732,7 @@ def prepend(
creation of the named file. Defaults to False.
source
A single source file to append. This source file can be hosted on either
A single source file to prepend. This source file can be hosted on either
the salt master server, or on an HTTP or FTP server. Both HTTPS and
HTTP are supported as well as downloading directly from Amazon S3
compatible URLs with both pre-configured and automatic IAM credentials
@ -6771,7 +6771,7 @@ def prepend(
<salt.states.file.managed>` function for more details and examples.
template
The named templating engine will be used to render the appended-to file.
The named templating engine will be used to render the source file(s).
Defaults to ``jinja``. The following templates are supported:
- :mod:`cheetah<salt.renderers.cheetah>`
@ -6782,7 +6782,7 @@ def prepend(
- :mod:`wempy<salt.renderers.wempy>`
sources
A list of source files to append. If the files are hosted on an HTTP or
A list of source files to prepend. If the files are hosted on an HTTP or
FTP server, the source_hashes argument is also required.
source_hashes
@ -6802,6 +6802,10 @@ def prepend(
appending content, one space or multiple tabs are the same for salt.
Set this option to ``False`` if you want to change this behavior.
header
Forces the text to be prepended if it exists in the file but not at
the beginning.
Multi-line example:
.. code-block:: yaml