# HG changeset patch
# User osimons
# Date 1285243038 0
# Node ID 630b48a53fc68a5a0b444e54ba81cb1c322eda3b
# Parent  77c3de8f5c46c6706209bd6ae248b744f66400c6
Add missing docs for 'dir' argument to core shell commands. Closes #618.

diff --git a/bitten/build/shtools.py b/bitten/build/shtools.py
--- a/bitten/build/shtools.py
+++ b/bitten/build/shtools.py
@@ -34,6 +34,7 @@
     :param output: name of the file to which the output of the script should be
                    written
     :param args: command-line arguments to pass to the script
+    :param dir\_: directory to change to before executing the command
     :param timeout: the number of seconds before the external process should
                     be aborted (has same constraints as CommandLine)
     """
@@ -61,6 +62,7 @@
     :param output: name of the file to which the output of the script should be
                    written
     :param args: command-line arguments to pass to the script
+    :param dir\_: directory to change to before executing the command
     """
     assert executable or file_, \
         'Either "executable" or "file" attribute required'
@@ -89,6 +91,7 @@
     :param output: name of the file to which the output of the script should be
                    written
     :param args: command-line arguments to pass to the script
+    :param dir\_: directory to change to before executing the command
     :param filter\_: function to filter out messages from the executable stdout
     :param timeout: the number of seconds before the external process should
                     be aborted (has same constraints as CommandLine)
diff --git a/doc/commands.txt b/doc/commands.txt
--- a/doc/commands.txt
+++ b/doc/commands.txt
@@ -106,11 +106,12 @@
 +----------------+-----------------------------------------------------------+
 | ``args``       | Any arguments to pass to the executable or script         |
 +----------------+-----------------------------------------------------------+
-| `timeout`      | Limits the runtime of this command to the specified       |
+| ``dir``        | Directory to change to before executing the command       |
++----------------+-----------------------------------------------------------+
+| ``timeout``    | Limits the runtime of this command to the specified       |
 |                | number of seconds, after which it will be terminated.     |
 +----------------+-----------------------------------------------------------+
 
-
 Either ``executable`` or ``file`` must be specified.
 
 Examples
@@ -142,6 +143,8 @@
 +----------------+-----------------------------------------------------------+
 | ``args``       | Any arguments to pass to the executable or script         |
 +----------------+-----------------------------------------------------------+
+| ``dir``        | Directory to change to before executing the command       |
++----------------+-----------------------------------------------------------+
 
 Either ``executable`` or ``file`` must be specified.