Skip to content

Commit

Permalink
Fix documentation of qa-catalogue script
Browse files Browse the repository at this point in the history
Only one command can be passed. Use option -a to executed multiple
commands.
  • Loading branch information
nichtich committed May 24, 2024
1 parent bebfe86 commit ac667f9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,11 +245,11 @@ If you do not want to
#### run

```bash
catalogues/[your script] [command(s)]
catalogues/[your script] [command]
```
or
```bash
./qa-catalogue --params="[options]" [command(s)]
./qa-catalogue --params="[options]" [command]
```

The following commands are supported:
Expand Down
13 changes: 8 additions & 5 deletions qa-catalogue
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ set -ueo pipefail

usage() {
cat << EOF
Usage: $0 [options] <command[,command...]>
Usage: $0 [options] <command>
QA catalogue for analysing library data
Expand All @@ -27,6 +27,11 @@ EOF
exit
}

error() {
echo $@ >&2
exit 1
}

# optionally load default values
[ -f ./setdir.sh ] && . ./setdir.sh

Expand Down Expand Up @@ -98,11 +103,9 @@ EOF
# don't proceed if web configuration shall be updated but cannot do so
if [[ ! -z "$WEB_CONFIG" ]]; then
if [[ ! -f "$WEB_CONFIG" ]]; then
echo "web configuration file missing: $WEB_CONFIG" >&2
exit 1
error "web configuration file missing: $WEB_CONFIG"
elif [[ -z "$CATALOGUE" ]]; then
echo "catalogue short name not set" >&2
exit 1
error "catalogue short name not set"
fi
fi

Expand Down

0 comments on commit ac667f9

Please sign in to comment.