1a8e1175bSopenharmony_ciREADME for git hooks script
2a8e1175bSopenharmony_ci===========================
3a8e1175bSopenharmony_cigit has a way to run scripts, which are invoked by specific git commands.
4a8e1175bSopenharmony_ciThe git hooks are located in `<Mbed TLS root>/.git/hooks`, and as such are not under version control
5a8e1175bSopenharmony_cifor more information, see the [git documentation](https://git-scm.com/docs/githooks).
6a8e1175bSopenharmony_ci
7a8e1175bSopenharmony_ciThe 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.
8a8e1175bSopenharmony_ci
9a8e1175bSopenharmony_ciExample:
10a8e1175bSopenharmony_ci
11a8e1175bSopenharmony_ciExecute the following command to create a link on Linux from the Mbed TLS `.git/hooks` directory:  
12a8e1175bSopenharmony_ci`ln -s ../../tests/git-scripts/pre-push.sh pre-push`
13a8e1175bSopenharmony_ci
14a8e1175bSopenharmony_ci**Note: Currently the Mbed TLS git hooks work only on a GNU platform. If using a non-GNU platform, don't enable these hooks!**
15a8e1175bSopenharmony_ci
16a8e1175bSopenharmony_ciThese scripts can also be used independently.
17