From aeceb1d5104554e399a559f8609288b46ca98fd1 Mon Sep 17 00:00:00 2001 From: Alberto Planas Date: Wed, 27 Feb 2019 16:23:33 +0100 Subject: [PATCH] cmdmod: unify parameters documentation for run_chroot --- salt/modules/cmdmod.py | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/salt/modules/cmdmod.py b/salt/modules/cmdmod.py index 86a39404d9f6..d31cd62376de 100644 --- a/salt/modules/cmdmod.py +++ b/salt/modules/cmdmod.py @@ -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`` @@ -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.