mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-10-19 09:11:48 +00:00

History

Manuel Pégourié-Gonnard a80651c483 Add a pre-commit hook that checks generated files Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>		2020-07-16 10:54:38 +02:00
..
pre-commit.sh	Add a pre-commit hook that checks generated files	2020-07-16 10:54:38 +02:00
pre-push.sh	Merge pull request #2639 from mpg/use-all-sh-checks-for-pre-push	2020-06-23 14:37:16 +02:00
README.md	Move the git scripts to correct path	2017-07-27 21:44:34 +01:00

README.md

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.

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.