Commit 1a6928dd authored by Valentin Reis's avatar Valentin Reis

Readme update.

parent fbd84589
Pipeline #4719 passed with stage
in 31 seconds
...@@ -121,20 +121,6 @@ argotk.hs helloworld --help ...@@ -121,20 +121,6 @@ argotk.hs helloworld --help
root/argotk/argotk.hs helloworld --help root/argotk/argotk.hs helloworld --help
``` ```
```{.bash}
argotk.hs application --help
```
```{.txt pipe="sh"}
root/argotk/argotk.hs application --help
```
```{.bash}
argotk.hs daemon --help
```
```{.txt pipe="sh"}
root/argotk/argotk.hs daemon --help
```
### Hacking ### Hacking
- edit `.README.md` in place of README.md. - edit `.README.md` in place of README.md.
......
...@@ -120,19 +120,23 @@ Output: ...@@ -120,19 +120,23 @@ Output:
Usage: argotk.hs COMMAND Usage: argotk.hs COMMAND
Available options: Available options:
COMMAND Type of action to run COMMAND Type of test to run. There are extensive options
under each action, but be careful, these do not all
have the same defaults. The default values are
printed when you call --help on these actions.
-h,--help Show this help text -h,--help Show this help text
Available commands: Available commands:
clean Clean sockets, logfiles. clean Clean sockets, logfiles.
daemon Set up and launch the daemon in synchronous mode, daemon Set up and launch the daemon in synchronous mode,
with properly cleaned sockets, logfiles. with properly cleaned sockets, logfiles.
application Setup stack and run an arbitrary command in a stack Setup stack and run a command in a container.
container. grep Setup stack and look for a message in the daemon's
standard output.
helloworld Test 1: Setup stack and check that a hello world app helloworld Test 1: Setup stack and check that a hello world app
sends message back to cmd. sends message back to cmd.
perfwrapper Test 2: Setup stack and check that a hello world app perfwrapper Test 2: Setup stack and check that argo-perf-wrapper
sends message back to cmd. Uses argo-perf-wrapper. sends at least one progress message up.
``` ```
``` {.bash} ``` {.bash}
...@@ -140,37 +144,37 @@ argotk.hs helloworld --help ...@@ -140,37 +144,37 @@ argotk.hs helloworld --help
``` ```
``` {.txt} ``` {.txt}
Usage: argotk.hs helloworld Usage: argotk.hs helloworld [--application APP]
[--container_name ARGO_CONTAINER_UUID]
[--output FILE] [--manifest_directory FILE]
[--manifest_name FILE] [--cmd_out FILE]
[--cmd_err FILE] [--daemon_out FILE]
[--daemon_err FILE] [--nrm_log FILE]
[--time_file FILE]
Test 1: Setup stack and check that a hello world app sends message back to Test 1: Setup stack and check that a hello world app sends message back to
cmd. cmd.
Available options: Available options:
-h,--help Show this help text --application APP Target application call, sh+path
``` valid (default: "echo helloworld")
--container_name ARGO_CONTAINER_UUID
``` {.bash} Container name (default: "testContainer")
argotk.hs application --help --output FILE Working directory. (default: FilePath "_output")
``` --manifest_directory FILE
Manifest lookup
``` {.txt} directory (default: FilePath "/nix/store/9hbj77178wrp2pv8qs6d063afhdymgk2-manifests")
Usage: argotk.hs application COMMAND --manifest_name FILE Manifest basename (default: FilePath "basic.json")
Setup stack and run an arbitrary command in a container. --cmd_out FILE Output file, application
stdout (default: FilePath "cmd_out.log")
Available options: --cmd_err FILE Output file, application
COMMAND Application to run inside the container stderr (default: FilePath "cmd_err.log")
-h,--help Show this help text --daemon_out FILE Output file, daemon
``` stdout (default: FilePath "daemon_out.log")
--daemon_err FILE Output file, daemon
``` {.bash} stderr (default: FilePath "daemon_err.log")
argotk.hs daemon --help --nrm_log FILE Output file, daemon log (default: FilePath "nrm.log")
``` --time_file FILE Output file, application
runtime (default: FilePath "time.log")
``` {.txt}
Usage: argotk.hs daemon
Set up and launch the daemon in synchronous mode, with properly cleaned
sockets, logfiles.
Available options:
-h,--help Show this help text -h,--help Show this help text
``` ```
......
...@@ -16,7 +16,7 @@ main = shakeArgs shakeOptions $ do ...@@ -16,7 +16,7 @@ main = shakeArgs shakeOptions $ do
"README.md" %> \out -> do "README.md" %> \out -> do
let template = ".README.md" let template = ".README.md"
need [template] need [template , "argotk/argotk.hs" , "argo/src/Argo/Stack.hs"]
(Stdout panpipe) <- cmd "which panpipe" (Stdout panpipe) <- cmd "which panpipe"
cmd_ "pandoc --filter" cmd_ "pandoc --filter"
[take (length panpipe - 1) panpipe, template, "-o", out] [take (length panpipe - 1) panpipe, template, "-o", out]
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment