summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjmkiley <jordan.kiley@mapbox.com>2019-03-08 14:21:59 -0800
committerjmkiley <jordan.kiley@mapbox.com>2019-03-11 12:54:52 -0700
commit3f069691d5e349644de2f980d71f3a4c220a2144 (patch)
tree6448bc91711d4bcd0755e825645c2d0a14dc0087
parente48961b59191f1dabfda533535b1876c640dea06 (diff)
downloadqtlocation-mapboxgl-3f069691d5e349644de2f980d71f3a4c220a2144.tar.gz
[build] Add comments outlining the input values for code-coverage.sh
-rwxr-xr-xscripts/code-coverage.sh9
1 files changed, 8 insertions, 1 deletions
diff --git a/scripts/code-coverage.sh b/scripts/code-coverage.sh
index a2190b4949..2c41f2ceec 100755
--- a/scripts/code-coverage.sh
+++ b/scripts/code-coverage.sh
@@ -3,7 +3,14 @@
set -e
set -o pipefail
-# Check that input values are valid.
+#
+# This script takes three values: $1 should be a decimal value reflecting the
+# percentage of lines covered, with a maximum value of 100.0, $2 is
+# the platform the percentage pertains to (iOS or Android), and $3 is the
+# test scheme being run (on iOS, this is currently CI).
+#
+
+# Check that platform input values are valid.
if [[ ! $2 = "iOS" && ! $2 = "Android" ]]; then
echo "$2 does not match either 'iOS' or 'Android'. Platform must be specified for coverage report."