mbedtls/git_hooks/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](https://git-scm.com/docs/githooks).

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.

Example:

Execute the following command to create a link on linux from the mbed TLS `.git/hooks` directory:  
`ln -s ../../git_hooks/pre-push 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!**
Pre push hook script Add git_hook folder, and pre-push script, to be soft linked from .git/hooks/pre-push 2016-12-15 12:42:37 +00:00			`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>/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.

			`Example:`

Fix slash direction for linux path Update direction of the slash, for linux path, after @hanno-arm comments 2017-07-20 15:24:43 +00:00			Execute the following command to create a link on linux from the mbed TLS `.git/hooks` directory:
Pre push hook script Add git_hook folder, and pre-push script, to be soft linked from .git/hooks/pre-push 2016-12-15 12:42:37 +00:00			`ln -s ../../git_hooks/pre-push pre-push`

Add note for the git_hoos README file Add a note to the git_hooks README.md file, to state that currently they only work on GNU platforms 2017-07-20 08:25:14 +00:00			`Note: Currently the mbed TLS git hooks work only on a GNU platform. If using a non-GNU platform, don't enable these hooks!`