Update after @sbutcher-arm comments
1. Move the scripts to test/git-scripts folder 2. Support the script to run independant, not only with git 3. modify Readme accordingly
This commit is contained in:
parent
13067fca9d
commit
cf61d7d992
2 changed files with 15 additions and 4 deletions
16
test/git-scripts/README.md
Normal file
16
test/git-scripts/README.md
Normal file
|
@ -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>/test/git-scripts` directory, and one must create a soft link from `<mbed TLS root>/.git/hooks` to `<mbed TLS root>/test/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 ../../test/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.
|
Loading…
Add table
Add a link
Reference in a new issue