diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-06-27 09:12:56 +0000 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2023-06-27 15:12:31 +0000 |
| commit | 43ea57b901bc02af7c0b9ebf5a5032184dae312e (patch) | |
| tree | 395df59c4f2c2372d96b20fd5c0a68a6a752a247 /coin | |
| parent | 69de333e1fbb3b866ab77a9d6a4ad26d0796633b (diff) | |
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 <paul.wicking@qt.io>
Diffstat (limited to 'coin')
| -rw-r--r-- | coin/instructions/coin_module_test_docs.qdocconf | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/coin/instructions/coin_module_test_docs.qdocconf b/coin/instructions/coin_module_test_docs.qdocconf new file mode 100644 index 0000000000..661240820a --- /dev/null +++ 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 |