From ae4e3c4af29fea66d3396161958c8fa111912d7d Mon Sep 17 00:00:00 2001
From: Dave Wallace <dwallacelf@gmail.com>
Date: Fri, 17 Jun 2022 13:08:17 -0400
Subject: [PATCH] Add docs-spell to vpp checkstyle job

- also replace individual package install confirm/force
  environment variables with UNATTENDED=yes.

Change-Id: I22a503848d7ae916bdbff1977586a0fa17498cca
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
---
 docker/scripts/dbld_vpp_install_packages.sh |  2 +-
 docker/scripts/lib_vpp.sh                   |  7 ++-----
 jjb/scripts/vpp/docs.sh                     |  4 ++--
 jjb/scripts/vpp/docs_spell.sh               | 23 +++++++++++++++++++++++
 jjb/vpp/vpp.yaml                            |  5 +++--
 5 files changed, 31 insertions(+), 10 deletions(-)
 create mode 100755 jjb/scripts/vpp/docs_spell.sh

diff --git a/docker/scripts/dbld_vpp_install_packages.sh b/docker/scripts/dbld_vpp_install_packages.sh
index 7672a7c6c..3af55dd61 100755
--- a/docker/scripts/dbld_vpp_install_packages.sh
+++ b/docker/scripts/dbld_vpp_install_packages.sh
@@ -60,7 +60,7 @@ for branch in ${VPP_BRANCHES[$OS_NAME]} ; do
     # Install/cache python packages
     make_vpp_test "test-dep" "$branch"
     if [ "$OS_ID" = "ubuntu" ] ; then
-         # TODO: Remove make test-doc after VPP 21.06 and 21.10 are no longer supported
+        # TODO: Remove make test-doc after VPP 21.06 and 21.10 are no longer supported
         #       which is deprecated in master (VPP 22.02)
         make_vpp_test "doc" "$branch"
         make_vpp test-wipe "$branch"
diff --git a/docker/scripts/lib_vpp.sh b/docker/scripts/lib_vpp.sh
index 8b9c91dc8..7bae93afd 100644
--- a/docker/scripts/lib_vpp.sh
+++ b/docker/scripts/lib_vpp.sh
@@ -46,12 +46,9 @@ make_vpp() {
         return
     fi
     git clean -qfdx
-    description="'make UNATTENDED=y $target' in $(pwd) ($branch)"
+    description="'make UNATTENDED=yes $target' in $(pwd) ($branch)"
     echo_log -e "    Starting  $description..."
-    local force_opts="--allow-downgrades --allow-remove-essential"
-    force_opts="$force_opts --allow-change-held-packages"
-    make UNATTENDED=y CONFIRM="-y" FORCE="$force_opts" \
-         $target 2>&1 | tee -a "$bld_log"
+    make UNATTENDED=yes $target 2>&1 | tee -a "$bld_log"
     git checkout -q -- .
     echo_log "    Completed $description!"
 }
diff --git a/jjb/scripts/vpp/docs.sh b/jjb/scripts/vpp/docs.sh
index a3c9f477f..2d80e5593 100755
--- a/jjb/scripts/vpp/docs.sh
+++ b/jjb/scripts/vpp/docs.sh
@@ -30,7 +30,7 @@ fi
 #       longer supported
 vpp_release="$(${WORKSPACE}/build-root/scripts/version rpm-version)"
 if [[ "${vpp_release::2}" -ge "22" ]] ; then
-    CONFIRM=-y FORCE=--force-yes make docs docs-spell
+    make UNATTENDED=yes docs docs-spell
 else
-    CONFIRM=-y FORCE=--force-yes make docs-venv docs
+    make UNATTENDED=yes docs-venv docs
 fi
diff --git a/jjb/scripts/vpp/docs_spell.sh b/jjb/scripts/vpp/docs_spell.sh
new file mode 100755
index 000000000..4b6a97851
--- /dev/null
+++ b/jjb/scripts/vpp/docs_spell.sh
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Copyright (c) 2022 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+echo "---> jjb/scripts/vpp/docs_spell.sh"
+
+if grep -qE '^docs\-%' Makefile && grep -qE '^spell' docs/Makefile
+then
+	make docs-spell
+else
+    echo "Can't find docs-spell target in Makefile - skipping docs-spell"
+fi
diff --git a/jjb/vpp/vpp.yaml b/jjb/vpp/vpp.yaml
index 1e336c9c6..5a157285c 100644
--- a/jjb/vpp/vpp.yaml
+++ b/jjb/vpp/vpp.yaml
@@ -401,8 +401,6 @@
                 - compare-type: REG_EXP
                   pattern: ^((?!\/COMMIT_MSG|docs|_abc|_def[\/\.]).)*$
               forbidden-file-paths:
-                - compare-type: REG_EXP
-                  pattern: .*docs\/.*
                 - compare-type: REG_EXP
                   pattern: .*extras\/emacs\/.*
               disable-strict-forbidden-file-verification: 'true'
@@ -436,6 +434,9 @@
       - shell:
           !include-raw-escape:
           - ../scripts/vpp/commitmsg.sh
+      - shell:
+          !include-raw-escape:
+          - ../scripts/vpp/docs_spell.sh
 
     publishers:
       - fdio-infra-publish
-- 
2.16.6