From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Tue, 2 May 2023 03:04:11 +0000 (+0200)
Subject: CI: treat documentation warnings as errors
X-Git-Url: http://git.dujemihanovic.xyz/html/index.html?a=commitdiff_plain;h=8a6414d1e410ab65780a4c5eb99e79e5b9bc21c1;p=u-boot.git

CI: treat documentation warnings as errors

We do not want to merge documentation that produces Sphinx warnings.

scripts/kernel-doc uses environment variable KDOC_WERROR to determine
if warnings should be treated as errors.

Reported-by: Tom Rini <trini@konsulko.com>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
---

diff --git a/.azure-pipelines.yml b/.azure-pipelines.yml
index 76ffdeebd6..3c1846a5bc 100644
--- a/.azure-pipelines.yml
+++ b/.azure-pipelines.yml
@@ -89,7 +89,7 @@ stages:
           virtualenv -p /usr/bin/python3 /tmp/venvhtml
           . /tmp/venvhtml/bin/activate
           pip install -r doc/sphinx/requirements.txt
-          make htmldocs
+          make htmldocs KDOC_WERROR=1
           make infodocs
 
   - job: todo
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b193fee98f..e6c6ab3586 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -171,7 +171,7 @@ docs:
     - virtualenv -p /usr/bin/python3 /tmp/venvhtml
     - . /tmp/venvhtml/bin/activate
     - pip install -r doc/sphinx/requirements.txt
-    - make htmldocs
+    - make htmldocs KDOC_WERROR=1
     - make infodocs
 
 # some statistics about the code base