summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src/qtwebengine-debugging.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/doc/src/qtwebengine-debugging.qdoc')
-rw-r--r--src/core/doc/src/qtwebengine-debugging.qdoc25
1 files changed, 22 insertions, 3 deletions
diff --git a/src/core/doc/src/qtwebengine-debugging.qdoc b/src/core/doc/src/qtwebengine-debugging.qdoc
index dd7e6bdad..3dd4d9276 100644
--- a/src/core/doc/src/qtwebengine-debugging.qdoc
+++ b/src/core/doc/src/qtwebengine-debugging.qdoc
@@ -28,10 +28,14 @@
\QWE based browser, such as the Chrome browser.
To activate the developer tools, start an application that uses \QWE
- with the command-line arguments:
+ with the command-line argument \c {--remote-debugging-port=<portnumber>}.
+
+ \note Any WebEngine command line options should be specified after the
+ \c {--webEngineArgs} option, which is used to separate the user's application
+ specific options from the WebEngine's ones.
\badcode
- --remote-debugging-port=<port_number>
+ --webEngineArgs --remote-debugging-port=<portnumber>
\endcode
Where \c <port_number> refers to a local network port. The web developer
@@ -45,6 +49,12 @@
interface on, so that you can access the developer tools from a remote
device.
+ To avoid WebSocket errors during remote debugging, add an additional command-line
+ argument \c {--remote-allow-origins=<origin>[,<origin>, ...]}, where \c <origin> refers to the request origin.
+ Use \c {--remote-allow-origins=*} to allow connections from all origins. If nothing is specified,
+ \QWE will add \c {--remote-allow-origins=*} to command-line arguments when remote-debugging is enabled,
+ thereby allowing requests from all origins.
+
For a detailed explanation of the capabilities of developer tools, see the
\l {Chrome DevTools} page.
@@ -88,6 +98,15 @@
QTWEBENGINE_CHROMIUM_FLAGS="--disable-logging" mybrowser
\endcode
- QTWEBENGINE_CHROMIUM_FLAGS can also be set using {qputenv} from within the
+ QTWEBENGINE_CHROMIUM_FLAGS can also be set using \c qputenv from within the
application if called before QtWebEngineQuick::initialize().
+
+ \section1 Dump WebEngineContext Information
+
+ For dumping the WebEngineContext information, you can set the \c QT_LOGGING_RULES
+ environment variable to \c "qt.webenginecontext.debug=true".
+
+ The output contains information about the graphical backend, and the way how \QWE
+ is initialized for the application. This is particularly useful for reproducing
+ issues.
*/