diff options
| author | Christian Klinger | 2016-09-29 15:48:49 +0200 |
|---|---|---|
| committer | Christian Klinger | 2016-09-29 15:48:49 +0200 |
| commit | 692748a07684cf6caf67fa736db853781c58842f (patch) | |
| tree | 1c07df56f24df8179518049e1522375b20bf52b2 /README.md | |
| parent | astyle. (diff) | |
| download | pvs2-692748a07684cf6caf67fa736db853781c58842f.tar.gz pvs2-692748a07684cf6caf67fa736db853781c58842f.tar.xz pvs2-692748a07684cf6caf67fa736db853781c58842f.zip | |
added a pre-commit hook for astyle.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -82,3 +82,25 @@ something like "xscreensaver-command --lock" or similar. ### Network Setup + + +# FOR CONTRIBUTORS + +## Code Style +Please check the file `.astylerc` for details. We recommend to install a +pre-commit hook to make sure that one only commit complying code. Such a hook +can be found in scripts/astyle-check.sh + +Steps to install the hook: + # install `astyle` + apt-get install astyle + + cd pvs2 + cd .git/hooks + ln -s ../../scripts/astyle-check.sh pre-commit + chmod +x pre-commit + +If a staged file does not comply to our coding style, you can use + `astyle --options=./.astylerc <FILE>` to correct the style. + + |