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 2

Add docs for new escape kwarg

Browse source
This commit is contained in:
Ch3LL 2018-08-02 10:37:25 -04:00
parent 391bb8a411
commit 3be11e06fe
No known key found for this signature in database
GPG key ID: 132B55A7C13EFA73
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
salt/utils/win_functions.py
View file

@ -177,6 +177,11 @@ def escape_argument(arg, escape=True):
Args:
arg (str): a single command line argument to escape for the cmd.exe shell
Kwargs:
escape (bool): True will call the escape_for_cmd_exe() function
which escapes the characters '()%!^"<>&|'. False
will not call the function and only quotes the cmd
Returns:
str: an escaped string suitable to be passed as a program argument to the cmd.exe shell
'''