From: Yuri Astrakhan <yurik@wikimedia.org>
Date: Wed, 8 Oct 2014 18:12:11 +0000 (-0400)
Subject: Minor doc fix for wfShellExecWithStderr()
X-Git-Tag: 1.31.0-rc.0~13656
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/banques/%7B%7B%20url_for%28%27admin_users%27%29%20%7D%7D?a=commitdiff_plain;h=df43a26e0a3cff7d6d353e137b49dc70cadb024e;p=lhc%2Fweb%2Fwiklou.git

Minor doc fix for wfShellExecWithStderr()

Change-Id: I9d5fe442c6e85d61c1cdec8c42caab06b37856b1
---

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index 03bdd767c2..2c26fef69d 100644
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -2986,7 +2986,9 @@ function wfShellExec( $cmd, &$retval = null, $environ = array(),
  * function, as all the arguments to wfShellExec can become unwieldy.
  *
  * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
- * @param string $cmd Command line, properly escaped for shell.
+ * @param string|string[] $cmd If string, a properly shell-escaped command line,
+ *   or an array of unescaped arguments, in which case each value will be escaped
+ *   Example:   [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
  * @param null|mixed &$retval Optional, will receive the program's exit code.
  *   (non-zero is usually failure)
  * @param array $environ Optional environment variables which should be