summaryrefslogtreecommitdiffstats
path: root/src/tools/cargo/ci/validate-man.sh
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/cargo/ci/validate-man.sh')
-rwxr-xr-xsrc/tools/cargo/ci/validate-man.sh26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/tools/cargo/ci/validate-man.sh b/src/tools/cargo/ci/validate-man.sh
new file mode 100755
index 000000000..92df49781
--- /dev/null
+++ b/src/tools/cargo/ci/validate-man.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+# This script validates that there aren't any changes to the man pages.
+
+set -e
+
+cd src/doc
+
+changes=$(git status --porcelain)
+if [ -n "$changes" ]
+then
+ echo "git directory must be clean before running this script."
+ exit 1
+fi
+
+./build-man.sh
+
+changes=$(git status --porcelain)
+if [ -n "$changes" ]
+then
+ echo "Detected changes in man pages:"
+ echo "$changes"
+ echo
+ echo "Please run './build-man.sh' in the src/doc directory to rebuild the"
+ echo "man pages, and commit the changes."
+ exit 1
+fi