| Ron Eldor | fcb7491 | 2016-12-15 14:42:37 +0200 | [diff] [blame] | 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>/git_hooks` directory, and one must create a soft link from `<mbed TLS root>/.git/hooks` to `<mbed TLS root>/git_hooks`, 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 ../../git_hooks/pre-push pre-push` |
| 13 | |
| Ron Eldor | 84f986c | 2017-07-20 11:25:14 +0300 | [diff] [blame^] | 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!** |