summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorChris Jerdonek <chris.jerdonek@gmail.com>2012-10-11 05:52:22 (GMT)
committerChris Jerdonek <chris.jerdonek@gmail.com>2012-10-11 05:52:22 (GMT)
commitcc32a68216238d72913794cf83fc0eaf54abe0db (patch)
tree58dc9f01155bf41b46742e208b1d80a7cc47ee69 /Doc
parent4a4a02bbc84ec0d7080281957a354c3c02ee0def (diff)
downloadcpython-cc32a68216238d72913794cf83fc0eaf54abe0db.zip
cpython-cc32a68216238d72913794cf83fc0eaf54abe0db.tar.gz
cpython-cc32a68216238d72913794cf83fc0eaf54abe0db.tar.bz2
Fix placement of shell=True warning in subprocess.Popen() docs.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/subprocess.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 5d689e6..e260a1f 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -260,8 +260,8 @@ default values. The arguments that are most commonly needed are:
untrusted source makes a program vulnerable to `shell injection
<http://en.wikipedia.org/wiki/Shell_injection#Shell_injection>`_,
a serious security flaw which can result in arbitrary command execution.
- For this reason, the use of *shell=True* is **strongly discouraged** in cases
- where the command string is constructed from external input::
+ For this reason, the use of ``shell=True`` is **strongly discouraged**
+ in cases where the command string is constructed from external input::
>>> from subprocess import call
>>> filename = input("What file would you like to display?\n")
@@ -346,18 +346,18 @@ functions.
Popen(['/bin/sh', '-c', args[0], args[1], ...])
- .. warning::
-
- Enabling this option can be a security hazard if combined with untrusted
- input. See the warning under :ref:`frequently-used-arguments`
- for details.
-
On Windows with ``shell=True``, the :envvar:`COMSPEC` environment variable
specifies the default shell. The only time you need to specify
``shell=True`` on Windows is when the command you wish to execute is built
into the shell (e.g. :command:`dir` or :command:`copy`). You do not need
``shell=True`` to run a batch file or console-based executable.
+ .. warning::
+
+ Passing ``shell=True`` can be a security hazard if combined with
+ untrusted input. See the warning under :ref:`frequently-used-arguments`
+ for details.
+
*bufsize*, if given, has the same meaning as the corresponding argument to the
built-in open() function: :const:`0` means unbuffered, :const:`1` means line
buffered, any other positive value means use a buffer of (approximately) that