Skip to content

Commit 6bd56e2

Browse files
peterschrammelthk123
authored and
thk123
committed
Add documentation for cpplint pre-commit hook
Closes #565
1 parent e949196 commit 6bd56e2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CODING_STANDARD

+10
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,13 @@ Output:
172172
- Use '\n' instead of std::endl
173173

174174
You are allowed to break rules if you have a good reason to do so.
175+
176+
Pre-commit hook to run cpplint locally
177+
--------------------------------------
178+
To install the hook
179+
cp .githooks/pre-commit .git/hooks/pre-commit
180+
or use a symbolic link.
181+
Then, when running git commit, you should get the linter output
182+
(if any) before being prompted to enter a commit message.
183+
To bypass the check (e.g. if there was a false positive),
184+
add the option --no-verify.

0 commit comments

Comments
 (0)