From 8da4a1d97fed26a3361aeb658e067115e89c3bc8 Mon Sep 17 00:00:00 2001
From: Jin Hase <hase.jin@jp.fujitsu.com>
Date: Fri, 10 Jan 2020 20:12:30 +0900
Subject: [PATCH] Add some comment to hack/verify-linkcheck.sh

---
 hack/verify-linkcheck.sh | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/hack/verify-linkcheck.sh b/hack/verify-linkcheck.sh
index 4639d89e24c..e0315473d74 100755
--- a/hack/verify-linkcheck.sh
+++ b/hack/verify-linkcheck.sh
@@ -14,6 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script extracts the links from types.go and .md files in pkg/api/,
+# pkg/apis/ and docs/ directories, checks the status code of the response, and
+# output the list of invalid links.
+# Usage: hack/verify-linkcheck.sh
+
 set -o errexit
 set -o nounset
 set -o pipefail