From: Manuel Nickschas <sputnick@quassel-irc.org>
Date: Wed, 7 Sep 2016 23:40:09 +0000 (+0200)
Subject: Update INSTALL for WebEngine/WebKit
X-Git-Tag: travis-deploy-test~392
X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=342b2df76f0a2a9e0bf234c681c3072a56216e14

Update INSTALL for WebEngine/WebKit

WebEngine is a new feature, and WebKit is deprecated and unmaintained.
Update INSTALL to reflect the changes.
---

diff --git a/INSTALL b/INSTALL
index ba4a13f1..3429f244 100644
--- a/INSTALL
+++ b/INSTALL
@@ -98,11 +98,17 @@ options here:
     also the bundled icon theme in Quassel before version 0.13.
     By default, WITH_OXYGEN is OFF.
 
+-DWITH_WEBENGINE=(ON|OFF)
+    Use WebEngine for showing previews of webpages linked in the chat. Requires
+    the QtWebEngine module to be available, and increases the client's RAM usage
+    by *a lot* if enabled at runtime. Only available for Qt5. The default is ON.
+
 -DWITH_WEBKIT=OFF
-    Use Webkit for showing previews of webpages linked in the chat. Requires
-    the QtWebkit module to be available, and increases the client's RAM usage
-    by *a lot* if enabled at runtime. Note also that Webkit frequently crashes
-    especially on Windows.
+    Use WebKit for showing previews of webpages linked in the chat. Requires
+    the QtWebKit module to be available, and increases the client's RAM usage
+    by *a lot* if enabled at runtime.
+    Note that WebKit support is deprecated and mostly unmaintained in Qt, and
+    should no longer be used for security reasons. The default is OFF.
 
 -DEMBED_DATA=(ON|OFF)
     Specifies whether Quassel's data files (icons, translations and so on)