From 3bef55069dadc7de8a19b662f6f23f4eeea673be Mon Sep 17 00:00:00 2001 From: Andrus Adamchik Date: Sat, 4 May 2024 12:40:48 -0400 Subject: [PATCH] docs --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a8969df..deef4d1f 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ runnable job definition with metadata and parameters, a job scheduler. It contai run individual jobs, and schedule periodic job execution. Also includes a Zookeeper-based cluster locking facility for jobs that should not be allowed to run concurrently. -See usage example [bootique-jobs-demo](https://github.com/bootique-examples/bootique-jobs-demo). +See usage examples [here](https://github.com/bootique-examples/bootique-job-examples). ## Commands @@ -45,11 +45,13 @@ Executes one or more jobs, possibly in parallel. The options have the following * **--job=_name_**: _name_ is either a job name or a job [group](#job-groups) name. Can optionally contain a JSON map of job parameters. E.g. `myjob{"p":1}`. Multiple `--job` arguments can be specified in order to run several jobs with a single command. -* **--serial**: enforces sequential execution of jobs, in the same order that they are specified in the program arguments. Does not have any effect, if only one `--job` argument has been specified. +* **--serial**: enforces sequential execution of jobs, in the same order that they are specified in the program arguments. +* Does not have any effect, if only one `--job` argument has been specified. -This command implements a fail-fast behavior, when run in _serial_ mode. If there is more than one `--job` argument, and one of the jobs fails, the command terminates immediately, and the subsequent jobs are not executed. +This command implements a fail-fast behavior, when run in _serial_ mode. If there is more than one `--job` argument, +and one of the jobs fails, the command terminates immediately, and the subsequent jobs are not executed. -This command returns exit code 0, only if all of the jobs complete normally. I.e. it always returns a non-zero exit code, if at least one of the jobs fails, regardless of the mode of execution (parallel or serial). +The command exits with `0`, only if all the jobs completed normally. Otherwise, returns a non-zero exit code. ### ScheduleCommand