From: Ryota MIBU <r-mibu@cq.jp.nec.com>
Date: Tue, 8 Dec 2015 15:51:36 +0000 (+0900)
Subject: Adding doc8 check against rst files
X-Git-Tag: test-tag~60^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F85%2F4085%2F2;p=releng.git

Adding doc8 check against rst files

This patch adds checks for trailing whitespace or length (> 120)
in rst files. If there is any violation, the result will be posted
on gerrit as jenkins comment, but won't turn the job failed.

JIRA: RELENG-26
JIRA: RELENG-27

Change-Id: I9261e3d91921877a95eafe0a650d8da46304ef40
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
---

diff --git a/utils/docs-build.sh b/utils/docs-build.sh
index bf9ab5b1e..5ac8b2be6 100755
--- a/utils/docs-build.sh
+++ b/utils/docs-build.sh
@@ -38,6 +38,26 @@ html_notes="\n    Revision: $rev_full\n\n    Build date: |today|"
 default_conf='releng/docs/etc/conf.py'
 opnfv_logo='releng/docs/etc/opnfv-logo.png'
 
+function check_rst_doc() {
+    _src="$1"
+
+    if ! which doc8 > /dev/null ; then
+        echo "Error: 'doc8' not found. Exec 'sudo pip install doc8' first."
+        exit 1
+    fi
+    # Note: This check may fail in many jobs for building project docs, since
+    #       the old sample has lines more than 120. We ignore failures on this
+    #       check right now, but these have to be fixed before OPNFV B release.
+    _out=$(doc8 --max-line-length 120 "$_src") || {
+        _msg='Error: rst validatino (doc8) has failed, please fix the following error(s).'
+        _errs=$(echo "$_out" | sed -n -e "/^$_src/s/^/    /p")
+        echo
+        echo -e "$_msg\n$_errs"
+        echo
+        [[ -n "$GERRIT_COMMENT" ]] && echo -e "$_msg\n$_errs" >> "$GERRIT_COMMENT"
+    }
+}
+
 function add_html_notes() {
     _src="$1"
     _dir="$2"
@@ -65,6 +85,8 @@ function add_config() {
 }
 
 
+check_rst_doc $SRC_DIR
+
 if [[ ! -d "$RELENG_DIR" ]] ; then
     echo "Error: $RELENG_DIR dir not found. See https://wiki.opnfv.org/documentation/tools ."
     exit 1