+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>/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.

+#!/bin/sh

+

+# pre-commit.sh

+#

+# Copyright The Mbed TLS Contributors

+# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

+#

+# This file is provided under the Apache License 2.0, or the

+# GNU General Public License v2.0 or later.

+#

+# **********

+# Apache License 2.0:

+#

+# Licensed under the Apache License, Version 2.0 (the "License"); you may

+# not use this file except in compliance with the License.

+# You may obtain a copy of the License at

+#

+# http://www.apache.org/licenses/LICENSE-2.0

+#

+# Unless required by applicable law or agreed to in writing, software

+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+# See the License for the specific language governing permissions and

+# limitations under the License.

+#

+# **********

+#

+# **********

+# GNU General Public License v2.0 or later:

+#

+# This program is free software; you can redistribute it and/or modify

+# it under the terms of the GNU General Public License as published by

+# the Free Software Foundation; either version 2 of the License, or

+# (at your option) any later version.

+#

+# This program is distributed in the hope that it will be useful,

+# but WITHOUT ANY WARRANTY; without even the implied warranty of

+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

+# GNU General Public License for more details.

+#

+# You should have received a copy of the GNU General Public License along

+# with this program; if not, write to the Free Software Foundation, Inc.,

+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

+#

+# **********

+

+# Purpose

+#

+# This script does quick sanity checks before commiting:

+# - check that generated files are up-to-date.

+#

+# It is meant to be called as a git pre-commit hook, see README.md.

+#

+# From the git sample pre-commit hook:

+# Called by "git commit" with no arguments. The hook should

+# exit with non-zero status after issuing an appropriate message if

+# it wants to stop the commit.

+

+set -eu

+

+tests/scripts/check-generated-files.sh

+#!/bin/sh

+# pre-push.sh

+#

+# Copyright The Mbed TLS Contributors

+# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

+#

+# This file is provided under the Apache License 2.0, or the

+# GNU General Public License v2.0 or later.

+#

+# **********

+# Apache License 2.0:

+#

+# Licensed under the Apache License, Version 2.0 (the "License"); you may

+# not use this file except in compliance with the License.

+# You may obtain a copy of the License at

+#

+# http://www.apache.org/licenses/LICENSE-2.0

+#

+# Unless required by applicable law or agreed to in writing, software

+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+# See the License for the specific language governing permissions and

+# limitations under the License.

+#

+# **********

+#

+# **********

+# GNU General Public License v2.0 or later:

+#

+# This program is free software; you can redistribute it and/or modify

+# it under the terms of the GNU General Public License as published by

+# the Free Software Foundation; either version 2 of the License, or

+# (at your option) any later version.

+#

+# This program is distributed in the hope that it will be useful,

+# but WITHOUT ANY WARRANTY; without even the implied warranty of

+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

+# GNU General Public License for more details.

+#

+# You should have received a copy of the GNU General Public License along

+# with this program; if not, write to the Free Software Foundation, Inc.,

+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

+#

+# **********

+#

+# Purpose

+#

+# Called by "git push" after it has checked the remote status, but before anything has been

+# pushed. If this script exits with a non-zero status nothing will be pushed.

+# This script can also be used independently, not using git.

+#

+# This hook is called with the following parameters:

+#

+# $1 -- Name of the remote to which the push is being done

+# $2 -- URL to which the push is being done

+#

+# If pushing without using a named remote those arguments will be equal.

+#

+# Information about the commits which are being pushed is supplied as lines to

+# the standard input in the form:

+#

+# <local ref> <local sha1> <remote ref> <remote sha1>

+#

+

+REMOTE="$1"

+URL="$2"

+

+echo "REMOTE is $REMOTE"

+echo "URL is $URL"

+

+set -eu

+

+tests/scripts/all.sh -q -k 'check_*'