Make handling of deprecated items and properties configurable

As of now, a newly deprecated property leads to users getting bombarded
with warnings, even though they did not yet have a chance to adapt their
project.
Now the warnings appear by default one minor version before removal,
which together with our convention of keeping deprecated properties for
at least two minor versions gives users enough time to adapt without
getting spammed.
There is also a mode for switching to the previous behavior (for early
detection), as well as the possibility to trigger errors instead of
warnings, which should be helpful in CI configurations.
To support the case where the user cannot do anything about them, the
warnings can also be suppressed altogether.

Change-Id: I295f816758f0f111fcb0351581a4328be3af5668
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Ivan Komissarov <ABBAPOH@gmail.com>

1 files changed, 23 insertions, 0 deletions

diff --git a/src/lib/corelib/tools/setupprojectparameters.cpp b/src/lib/corelib/tools/setupprojectparameters.cpp
index a06ffc4bd..564ebe873 100644
--- a/src/lib/corelib/tools/setupprojectparameters.cpp
+++ b/src/lib/corelib/tools/setupprojectparameters.cpp
@@ -98,6 +98,7 @@ public:
     SetupProjectParameters::RestoreBehavior restoreBehavior;
     ErrorHandlingMode propertyCheckingMode;
     ErrorHandlingMode productErrorMode;
+    DeprecationWarningMode deprecationWarningMode = defaultDeprecationWarningMode();
     QProcessEnvironment environment;
 };
 
@@ -125,6 +126,11 @@ template<> ErrorHandlingMode fromJson(const QJsonValue &v)
     return ErrorHandlingMode::Strict;
 }
 
+template<> DeprecationWarningMode fromJson(const QJsonValue &v)
+{
+    return deprecationWarningModeFromName(v.toString());
+}
+
 template<> SetupProjectParameters::RestoreBehavior fromJson(const QJsonValue &v)
 {
     const QString value = v.toString();
@@ -154,6 +160,7 @@ SetupProjectParameters SetupProjectParameters::fromJson(const QJsonObject &data)
     setValueFromJson(params.d->environment, data, "environment");
     setValueFromJson(params.d->restoreBehavior, data, "restore-behavior");
     setValueFromJson(params.d->propertyCheckingMode, data, "error-handling-mode");
+    setValueFromJson(params.d->deprecationWarningMode, data, "deprecation-warning-mode");
     params.d->productErrorMode = params.d->propertyCheckingMode;
     return params;
 }
@@ -688,4 +695,20 @@ void SetupProjectParameters::setProductErrorMode(ErrorHandlingMode mode)
     d->productErrorMode = mode;
 }
 
+/*!
+ * \brief Indicates how deprecated constructs are handled.
+ */
+DeprecationWarningMode SetupProjectParameters::deprecationWarningMode() const
+{
+    return d->deprecationWarningMode;
+}
+
+/*!
+ * \brief Specifies the behavior on encountering deprecated constructs.
+ */
+void SetupProjectParameters::setDeprecationWarningMode(DeprecationWarningMode mode)
+{
+    d->deprecationWarningMode = mode;
+}
+
 } // namespace qbs