Skip to content

Commit

Permalink
Tried making local(shell) docstring clearer/more explicit
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Sep 12, 2012
1 parent 25e3fed commit 8c6ddcf
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions fabric/operations.py
Original file line number Diff line number Diff line change
Expand Up @@ -1038,8 +1038,11 @@ def local(command, capture=False, shell=None):
Python ``subprocess`` module with ``shell=True`` activated. If you need to
do anything special, consider using the ``subprocess`` module directly.
`shell` specifies the shell to use (e.g. /bin/bash), otherwise it
defaults in the ``subprocess`` module.
``shell`` is passed directly to `subprocess.Popen
<http://docs.python.org/library/subprocess.html#subprocess.Popen>`_'s
``execute`` argument (which determines the local shell to use.) As per the
linked documentation, on Unix the default behavior is to use ``/bin/sh``,
so this option is useful for setting that value to e.g. ``/bin/bash``.
`local` is not currently capable of simultaneously printing and
capturing output, as `~fabric.operations.run`/`~fabric.operations.sudo`
Expand Down

0 comments on commit 8c6ddcf

Please sign in to comment.