diff options
| author | Anish Athalye <me@anishathalye.com> | 2015-02-03 18:09:25 -0500 |
|---|---|---|
| committer | Anish Athalye <me@anishathalye.com> | 2015-02-03 18:09:25 -0500 |
| commit | f7a291c780c3fb5df8e738e0ee34bf7560857ddd (patch) | |
| tree | 32213d9c55ad1e607e2aa364346020981dd7b271 /README.md | |
| parent | 38c0f65801534a58daceeed3c0fa4482b7421642 (diff) | |
Update README
Add note on array syntax for shell commands being deprecated.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 7 insertions, 4 deletions
@@ -160,13 +160,16 @@ base directory (that is specified when running the installer). #### Format Shell commands can be specified in several different ways. The simplest way is -just to specify a command as a string containing the command to be run. Another -way is to specify a two element array where the first element is the shell -command and the second is an optional human-readable description. Shell +just to specify a command as a string containing the command to be run. Shell commands support an extended syntax as well, which provides more fine-grained control. A command can be specified as a dictionary that contains the command to be run, a description, and whether stdin, stdout, and stderr are enabled. In -this syntax, all keys are optional except for the command itself. +this syntax, all keys are optional except for the command itself, and all +streams are disabled by default. + +Another way is to specify a two element array where the first element is the +shell command and the second is an optional human-readable description. **This +syntax is deprecated.** ##### Example (YAML) |