hack/verify-generated-docs.sh
f3482fc8
 #!/bin/bash
614bf6cc
 source "$(dirname "${BASH_SOURCE}")/lib/init.sh"
f3482fc8
 
43ad12ae
 echo "===== Verifying Generated Docs ====="
f3482fc8
 
43ad12ae
 GENERATED_DOCS_ROOT_REL="docs/generated"
 GENERATED_DOCS_ROOT="${OS_ROOT}/${GENERATED_DOCS_ROOT_REL}"
f9a9c357
 TMP_GENERATED_DOCS_ROOT_REL="_output/verify-generated-docs"
43ad12ae
 TMP_GENERATED_DOCS_ROOT="${OS_ROOT}/${TMP_GENERATED_DOCS_ROOT_REL}/${GENERATED_DOCS_ROOT_REL}"
f3482fc8
 
5b29eeeb
 GENERATED_DOCS_MAN_ROOT_REL="docs/man/man1"
4fa337a1
 GENERATED_DOCS_MAN_ROOT="${OS_ROOT}/${GENERATED_DOCS_MAN_ROOT_REL}"
 TMP_GENERATED_DOCS_MAN_ROOT="${OS_ROOT}/${TMP_GENERATED_DOCS_ROOT_REL}/${GENERATED_DOCS_MAN_ROOT_REL}"
 
43ad12ae
 echo "Generating fresh docs..."
 if ! output=`${OS_ROOT}/hack/update-generated-docs.sh ${TMP_GENERATED_DOCS_ROOT_REL} 2>&1`
 then
 	echo "FAILURE: Generation of fresh docs failed:"
 	echo "$output"
09a8c7d3
   exit 1
43ad12ae
 fi
 
 echo "Diffing current docs against freshly generated docs"
f3482fc8
 ret=0
 diff -Naupr "${GENERATED_DOCS_ROOT}" "${TMP_GENERATED_DOCS_ROOT}" || ret=$?
43ad12ae
 rm -rf "${TMP_GENERATED_DOCS_ROOT}"
4fa337a1
 
 echo "Diffing current man pages against freshly generated man pages"
 retman=0
 diff -Naupr "${GENERATED_DOCS_MAN_ROOT}" "${TMP_GENERATED_DOCS_MAN_ROOT}" || retman=$?
 rm -rf "${TMP_GENERATED_DOCS_MAN_ROOT}"
 
 if [[ $ret -eq 0 ]] && [[ $retman -eq 0 ]]
 then
   echo "SUCCESS: Generated docs and man pages up to date."
 elif [[ $ret -eq 0 ]] && [[ $retman -ne 0 ]]
f3482fc8
 then
4fa337a1
   echo "FAILURE: Generated docs up to date, but generated man pages out of date. Please run hack/update-generated-docs.sh"
   exit 1
 elif [[ $ret -ne 0 ]] && [[ $retman -eq 0 ]]
 then
   echo "FAILURE: Generated man pages up to date, but generated docs out of date. Please run hack/update-generated-docs.sh"
   exit 1
f3482fc8
 else
4fa337a1
   echo "FAILURE: Generated docs and man pages out of date. Please run hack/update-generated-docs.sh"
f3482fc8
   exit 1
 fi