-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix typographical errors in .md files found by cspell
Signed-off-by: Tom Cosgrove <[email protected]>
- Loading branch information
1 parent
8934db7
commit c71bc7b
Showing
4 changed files
with
7 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +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 | ||
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. | ||
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>/tests/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: | ||
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!** | ||
**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. |