aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorEric Biggers <ebiggers@google.com>2020-05-09 14:04:47 -0700
committerEric Biggers <ebiggers@google.com>2020-05-09 14:04:47 -0700
commitd6cc933ff1722ca3229aadd8878fe77ba5d05575 (patch)
tree96b12b67acf9e0819393a6bd97e5e0c36eb9efb8 /CONTRIBUTING.md
parent3619eed4515cf51161cfa7c57be4f330cd07e377 (diff)
Wire up shellcheck of cli-tests/*.sh to 'make lint'
Enforce that all the cli-test scripts pass 'shellcheck'.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5968d0e..d5be721 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -87,6 +87,7 @@ The `Makefile` will automatically download and build any needed Go dependencies.
However, you'll also need to install some non-Go dependencies:
- `make format` requires
[`clang-format`](https://clang.llvm.org/docs/ClangFormat.html).
+ - `make lint` requires [`shellcheck`](https://github.com/koalaman/shellcheck).
- `make test-setup` and `make cli-test` require
[`e2fsprogs`](https://en.wikipedia.org/wiki/E2fsprogs) version 1.43 or
later.
@@ -96,7 +97,7 @@ However, you'll also need to install some non-Go dependencies:
On Ubuntu, the following command installs the needed packages:
```
-sudo apt-get install clang-format e2fsprogs expect keyutils
+sudo apt-get install clang-format shellcheck e2fsprogs expect keyutils
```
### Running Integration Tests