From ae388ec7969d08560c9704d1d84d35d6f1a5ac2c Mon Sep 17 00:00:00 2001 From: Mathias Vorreiter Pedersen Date: Tue, 5 Jan 2021 16:27:53 +0100 Subject: [PATCH] Update docs/pre-commit-hook-setup.md Co-authored-by: Cornelius Riemenschneider --- docs/pre-commit-hook-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pre-commit-hook-setup.md b/docs/pre-commit-hook-setup.md index f1de334f35c..3bc1f2606f1 100644 --- a/docs/pre-commit-hook-setup.md +++ b/docs/pre-commit-hook-setup.md @@ -3,7 +3,7 @@ As stated in [CONTRIBUTING](../CONTRIBUTING.md) all CodeQL files must be formatted according to our [CodeQL style guide](ql-style-guide.md). You can use our pre-commit hook to avoid committing incorrectly formatted code. To use it, simply copy the [pre-commit](../misc/scripts/pre-commit) script to `.git/modules/ql/hooks/pre-commit` and make sure that: - The script is executable. On Linux and macOS this can be done using `chmod +x`. -- The CodeQL CLI has in added to your `PATH`. +- The CodeQL CLI has been added to your `PATH`. The script will abort a commit that contains incorrectly formatted code in .ql or .qll files and print an error message like: