diff options
| author | Dawid Potocki <dawid@dawidpotocki.com> | 2024-03-05 14:09:27 +1300 |
|---|---|---|
| committer | Dawid Potocki <dawid@dawidpotocki.com> | 2024-03-05 20:34:15 +1300 |
| commit | 063e15900bda8453fb0fc6751e78d064501ccbae (patch) | |
| tree | a4cd5f01dbca33a262333aff10e1e035217a30c8 /externals/mbedtls/tests/git-scripts/README.md | |
| parent | 537296095ab24eddcb196b5ef98004f91de9c8c2 (diff) | |
Diffstat (limited to 'externals/mbedtls/tests/git-scripts/README.md')
| -rw-r--r-- | externals/mbedtls/tests/git-scripts/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/externals/mbedtls/tests/git-scripts/README.md b/externals/mbedtls/tests/git-scripts/README.md new file mode 100644 index 0000000000..29d7501b33 --- /dev/null +++ b/externals/mbedtls/tests/git-scripts/README.md @@ -0,0 +1,16 @@ +README for git hooks script +=========================== +git has a way to run scripts, which are invoked by specific git commands. +The git hooks are located in `<mbed TLS root>/.git/hooks`, and as such are not under version control +for more information, see the [git documentation](https://git-scm.com/docs/githooks). + +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>/tesst/git-scripts`, in order to make the hook scripts successfully work. + +Example: + +Execute the following command to create a link on linux from the mbed TLS `.git/hooks` directory: +`ln -s ../../tests/git-scripts/pre-push.sh pre-push` + +**Note: Currently the mbed TLS git hooks work only on a GNU platform. If using a non-GNU platform, don't enable these hooks!** + +These scripts can also be used independently. |