add comment to tool/cover.sh

mackerelio · Jan 11, 2015 · d4b6ce6 · d4b6ce6
1 parent b6c4d94
commit d4b6ce6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/tool/cover.sh b/tool/cover.sh
@@ -1,4 +1,8 @@
 #/bin/sh
+# Calculate coverage
+# run this and you can see coverage reports as following
+#   % go tool cover -html .profile.cov
+
 set -e
 
 prof=${1:-".profile.cov"}
@@ -12,6 +16,8 @@ cleanup() {
 }
 trap cleanup INT QUIT TERM EXIT
 
+# cmd/cover doesn't support -coverprofile for multiple packages, so run tests in each dir.
+# ref. https://github.com/mattn/goveralls/issues/20
 for dir in $(find . -not -path '*/[._]*' -type d); do
   if ls $dir/*.go > /dev/null 2>&1; then
     tmpprof=$dir/profile.tmp