summaryrefslogtreecommitdiff
path: root/scripts/lint-doc.sh
diff options
context:
space:
mode:
authorwinniehell <git@winniehell.de>2016-08-08 14:42:20 +0200
committerwinniehell <git@winniehell.de>2016-08-09 00:21:10 +0200
commita361f314f8f7f00a7541a5af1b8a2a92ced475e9 (patch)
tree6e9ccf10b8cc0922b9254d85c1f16f0cb3d7de1a /scripts/lint-doc.sh
parentfb20758f1eb0f9a0b27e8c4d804b5af80908f629 (diff)
downloadgitlab-ce-a361f314f8f7f00a7541a5af1b8a2a92ced475e9.tar.gz
add linting script for documentation
Diffstat (limited to 'scripts/lint-doc.sh')
-rwxr-xr-xscripts/lint-doc.sh15
1 files changed, 15 insertions, 0 deletions
diff --git a/scripts/lint-doc.sh b/scripts/lint-doc.sh
new file mode 100755
index 00000000000..bc6e4d94061
--- /dev/null
+++ b/scripts/lint-doc.sh
@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+cd "$(dirname "$0")/.."
+
+# Use long options (e.g. --header instead of -H) for curl examples in documentation.
+grep --perl-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/
+if [ $? == 0 ]
+then
+ echo '✖ ERROR: Short options should not be used in documentation!' >&2
+ exit 1
+fi
+
+echo "✔ Linting passed"
+exit 0
+