Skip to content

Commit

Permalink
cmdmod: unify parameters documentation for run_chroot
Browse files Browse the repository at this point in the history
  • Loading branch information
aplanas committed Feb 27, 2019
1 parent 4cd0680 commit aeceb1d
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions salt/modules/cmdmod.py
Original file line number Diff line number Diff line change
Expand Up @@ -3096,19 +3096,17 @@ def run_chroot(root,
:param str root: Path to the root of the jail to use.
stdin
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.:
:param str stdin: A string of standard input can be specified for
the command to be run using the ``stdin`` parameter. This can
be useful in cases where sensitive information must be read
from standard input.:
runas
User to run script as.
:param str runas: User to run script as.
group
Group to run script as.
:param str group: Group to run script as.
shell
Shell to execute under. Defaults to the system default shell.
:param str shell: Shell to execute under. Defaults to the system
default shell.
:param str cmd: The command to run. ex: ``ls -lart /home``
Expand Down Expand Up @@ -3150,11 +3148,11 @@ def run_chroot(root,
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip:
Strip all whitespace off the end of output before it is returned.
:param bool rstrip: Strip all whitespace off the end of output
before it is returned.
:param str umask:
The umask (in octal) to use when running the command.
:param str umask: The umask (in octal) to use when running the
command.
:param str output_encoding: Control the encoding used to decode the
command's output.
Expand Down

0 comments on commit aeceb1d

Please sign in to comment.