History

Gilles Peskine 7ca4ff677d Remove Git pre-commit hook Since generated files are no longer stored in the repository, they don't need to be up-to-date before committing. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>		2021-05-20 10:37:22 +02:00
..
pre-push.sh	Update copyright notices to use Linux Foundation guidance	2020-08-19 10:35:41 +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.