Use a global value for warning limit when testing documentation in CI

The most common limit for the maximum number of allowed documentation warnings is zero. Use a global value for 'warninglimit', adopted by all Qt module documentation projects that include the configuration from qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Increase this base limit temporarily to 10 to help re-enable documentation testing in CI as it's currently disabled. Task-number: QTBUG-113326 Change-Id: I8b66951ca9324bcfaec3b5a7ec2cff544c62feb0 Reviewed-by: Paul Wicking <[email protected]>
Martchus · Jun 27, 2023 · 43ea57b · 43ea57b
1 parent 69de333
commit 43ea57b
Show file tree

Hide file tree

Showing 14 changed files with 12 additions and 36 deletions.
diff --git a/coin/instructions/coin_module_test_docs.qdocconf b/coin/instructions/coin_module_test_docs.qdocconf
@@ -0,0 +1,9 @@
+# Fail the documentation test build if QDoc warnings exceed the limit.
+#
+# Submodule documentation projects can increase this base limit to
+# account for known warnings, for example:
+#
+# qtcore.qdocconf:
+#     warninglimit += 1
+
+warninglimit = 10
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
@@ -34,3 +34,6 @@ qhp = true
 
 # Disable writing host-specific paths into .index files
 locationinfo = false
+
+# Include the warninglimit used for documentation testing in CI
+include(../../coin/instructions/coin_module_test_docs.qdocconf)
diff --git a/qmake/doc/qmake.qdocconf b/qmake/doc/qmake.qdocconf
@@ -59,6 +59,3 @@ depends += \
     qtxml
 
 navigation.landingpage = "qmake Manual"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/concurrent/doc/qtconcurrent.qdocconf b/src/concurrent/doc/qtconcurrent.qdocconf
@@ -42,6 +42,3 @@ imagedirs   += images
 
 navigation.landingpage = "Qt Concurrent"
 navigation.cppclassespage = "Qt Concurrent C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/corelib/doc/qtcore.qdocconf b/src/corelib/doc/qtcore.qdocconf
@@ -59,6 +59,3 @@ excludefiles += ../kernel/qtestsupport_core.cpp
 
 navigation.landingpage = "Qt Core"
 navigation.cppclassespage = "Qt Core C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/dbus/doc/qtdbus.qdocconf b/src/dbus/doc/qtdbus.qdocconf
@@ -65,6 +65,3 @@ navigation.cppclassespage = "Qt D-Bus C++ Classes"
 
 manifestmeta.thumbnail.names    =   "QtDBus/D-Bus Ping Pong" \
                                     "QtDBus/D-Bus Complex Ping Pong"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/gui/doc/qtgui.qdocconf b/src/gui/doc/qtgui.qdocconf
@@ -72,6 +72,3 @@ spurious += "Undocumented enum item '.*' in QGradient::Preset"
 # \svgcolor {#ffdead}
 macro.svgcolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\"></div>"
 macro.svgcolor.DocBook = "<db:phrase role=\"color:\1\">&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;</db:phrase>"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/network/doc/qtnetwork.qdocconf b/src/network/doc/qtnetwork.qdocconf
@@ -39,6 +39,3 @@ imagedirs   += images \
 
 navigation.landingpage = "Qt Network"
 navigation.cppclassespage = "Qt Network C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/opengl/doc/qtopengl.qdocconf b/src/opengl/doc/qtopengl.qdocconf
@@ -64,6 +64,3 @@ qhp.QtOpenGL.subprojects.classes.sortPages = true
 
 navigation.landingpage = "Qt OpenGL"
 navigation.cppclassespage = "Qt OpenGL C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/printsupport/doc/qtprintsupport.qdocconf b/src/printsupport/doc/qtprintsupport.qdocconf
@@ -40,6 +40,3 @@ imagedirs   += images \
 
 navigation.landingpage = "Qt Print Support"
 navigation.cppclassespage = "Qt Print Support C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/sql/doc/qtsql.qdocconf b/src/sql/doc/qtsql.qdocconf
@@ -39,6 +39,3 @@ imagedirs   += images \
 
 navigation.landingpage = "Qt SQL"
 navigation.cppclassespage = "Qt SQL C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/testlib/doc/qttestlib.qdocconf b/src/testlib/doc/qttestlib.qdocconf
@@ -55,6 +55,3 @@ manifestmeta.thumbnail.names = "QtTestLib/Chapter *"
 
 navigation.landingpage = "Qt Test"
 navigation.cppclassespage = "Qt Test C++ Classes"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf
@@ -61,6 +61,3 @@ imagedirs   += images \
 navigation.landingpage = "Qt Widgets"
 navigation.cppclassespage = "Qt Widgets C++ Classes"
 manifestmeta.highlighted.names = "QtWidgets/Qt Widgets - Application Example"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0
diff --git a/src/xml/doc/qtxml.qdocconf b/src/xml/doc/qtxml.qdocconf
@@ -38,6 +38,3 @@ navigation.cppclassespage = "Qt XML C++ Classes"
 
 # Add a thumbnail for examples that do not have images
 manifestmeta.thumbnail.names = "QtXml/XML Stream Lint Example"
-
-# Fail the documentation build if there are more warnings than the limit
-warninglimit = 0