erik/kobalt-exec
erik/kobalt-exec
1
0
Fork 0
Code Issues Pull requests Releases Activity

fixup! More documentation.

Browse source
This commit is contained in:
Erik C. Thauvin 2016-07-13 01:32:43 -07:00
parent 6ab9efe714
commit 796343ee7b
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -15,15 +15,15 @@ var p = project {
} }
} }
``` ```
To invoke the `exex` task: To invoke the `exec` task:
```sh ```sh
./kobaltw exec ./kobaltw exec
``` ```
## commandLine Directive ## `commandLine` Directive
The `commandLine` directive will execute command line(s) during the build process: The `commandLine` directive is used to execute command line(s) during the build process:
```kotlin ```kotlin
exec { exec {
@ -63,7 +63,7 @@ List of operating systems on which the command may be executed. If the current O
The following predefined values are available: The following predefined values are available:
Name | Operating System Name | Operating System
--------------|-------------------------------------------------------------------- --------------|-----------------------
`Os.FREEBSD` | FreeBSD `Os.FREEBSD` | FreeBSD
`Os.LINUX` | Linux `Os.LINUX` | Linux
`Os.MAC` | Apple Macintosh / OS X `Os.MAC` | Apple Macintosh / OS X
@ -88,9 +88,9 @@ List of error options to specify whether data returned to the standard streams a
The following predefined values are available: The following predefined values are available:
Name | Failure When Name | Failure When
--------------|-------------------------------------------------------------------- --------------|-----------------------------------------------------------------
`Fail.EXIT` | Exit value > 0 `Fail.EXIT` | Exit value > 0
`Fail.NORMAL` | Exit value > 0 or any data to the standard error stream (stderr). `Fail.NORMAL` | Exit value > 0 or any data to the standard error stream (stderr)
`Fail.OUTPUT` | Any data to the standard output stream (stdout) or stderr. `Fail.OUTPUT` | Any data to the standard output stream (stdout) or stderr.
`Fail.STDERR` | Any data to stderr. `Fail.STDERR` | Any data to stderr.
`Fail.STDOUT` | Any data to stdout. `Fail.STDOUT` | Any data to stdout.