README.md (901B)
1 README for git hooks script 2 =========================== 3 git has a way to run scripts, which are invoked by specific git commands. 4 The git hooks are located in `<Mbed TLS root>/.git/hooks`, and as such are not under version control 5 for more information, see the [git documentation](https://git-scm.com/docs/githooks). 6 7 The Mbed TLS git hooks are located in `<Mbed TLS root>/tests/git-scripts` directory, and one must create a soft link from `<Mbed TLS root>/.git/hooks` to `<Mbed TLS root>/tests/git-scripts`, in order to make the hook scripts successfully work. 8 9 Example: 10 11 Execute the following command to create a link on Linux from the Mbed TLS `.git/hooks` directory: 12 `ln -s ../../tests/git-scripts/pre-push.sh pre-push` 13 14 **Note: Currently the Mbed TLS git hooks work only on a GNU platform. If using a non-GNU platform, don't enable these hooks!** 15 16 These scripts can also be used independently.