diff options
Diffstat (limited to 'misc/hooks')
| -rw-r--r-- | misc/hooks/README.md | 17 | ||||
| -rwxr-xr-x | misc/hooks/pre-commit-makerst | 9 |
2 files changed, 22 insertions, 4 deletions
diff --git a/misc/hooks/README.md b/misc/hooks/README.md index dad5300a09..5661c239ed 100644 --- a/misc/hooks/README.md +++ b/misc/hooks/README.md @@ -20,7 +20,18 @@ contributors to make sure they comply with our requirements. Copy all the files from this folder into your `.git/hooks` folder, and make sure the hooks and helper scripts are executable. +#### Linux/MacOS + The hooks rely on bash scripts and tools which should be in the system `PATH`, -so they should work out of the box on Linux/macOS, and might work on Windows -when using `git-bash.exe` with `clang-format`, Python, `black`, etc. in the -`PATH`. +so they should work out of the box on Linux/macOS. + +#### Windows + +##### clang-format +- Download LLVM for Windows (version 8 or later) from + <https://releases.llvm.org/download.html> +- Make sure LLVM is added to the `PATH` during installation + +##### black +- Python installation: make sure Python is added to the `PATH` +- Install `black` - in any console: `pip3 install black` diff --git a/misc/hooks/pre-commit-makerst b/misc/hooks/pre-commit-makerst index d9b684e73b..b990788b99 100755 --- a/misc/hooks/pre-commit-makerst +++ b/misc/hooks/pre-commit-makerst @@ -2,4 +2,11 @@ # Git pre-commit hook that checks the class reference syntax using makerst.py. -doc/tools/makerst.py doc/classes modules --dry-run +# Workaround because we can't execute the .py file directly on windows +PYTHON=python +py_ver=$($PYTHON -c "import sys; print(sys.version_info.major)") +if [[ "$py_ver" != "3" ]]; then + PYTHON+=3 +fi + +$PYTHON doc/tools/makerst.py doc/classes modules --dry-run |