aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/doc/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-09-01 09:32:09 +0000
committerTopi Reinio <topi.reinio@qt.io>2023-09-06 10:40:49 +0000
commitec72526396156250b2d86d832feea05655f36c9f (patch)
tree44e4c25600172a7787fa601f162d722dc025bf44 /src/virtualkeyboard/doc/src
parent46feed9abf4987d011facede8798e7b8c720f01f (diff)
Doc: Update reference to 'Pure QML' example
The 'Pure QML' example compositor in Qt Wayland has been renamed to 'Fancy Compositor'. Split the long snippet code line for starting the compositor for better readability. Mark the module clear of documentation warnings. Pick-to: 6.6 Change-Id: I6e07fa2f7a54820613760e98dd501821e0afb3b5 Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
Diffstat (limited to 'src/virtualkeyboard/doc/src')
-rw-r--r--src/virtualkeyboard/doc/src/deployment-guide.qdoc7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/virtualkeyboard/doc/src/deployment-guide.qdoc b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
index 7a8a34a8..04abd288 100644
--- a/src/virtualkeyboard/doc/src/deployment-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
@@ -96,16 +96,17 @@ or by adding \c -no-vkb-desktop to the \c configure command line.
This section explains how to use Qt Virtual Keyboard to interact with the
\l {Line Edits Example}{Qt Widgets Line Edits example} using the
-\l {Pure QML}{Pure QML example} as a compositor.
+\l {Fancy Compositor}{Fancy Compositor example} as a compositor.
We will be using Ubuntu 18.04 to run the example, using the X11 as the
-windowing system. The example compositor (\c pure-qml) will open
+windowing system. The example compositor (\c fancy-compositor) will open
as a window within an X11 session.
\list 1
\li Start the compositor:
\badcode
-QT_XCB_GL_INTEGRATION=xcb_egl QT_WAYLAND_CLIENT_BUFFER_INTEGRATION=xcomposite-egl QT_IM_MODULE=qtvirtualkeyboard ./pure-qml -platform xcb
+QT_XCB_GL_INTEGRATION=xcb_egl QT_WAYLAND_CLIENT_BUFFER_INTEGRATION=xcomposite-egl \
+QT_IM_MODULE=qtvirtualkeyboard ./fancy-compositor -platform xcb
\endcode
\li Before running the client application, ensure that QT_IM_MODULE is unset:
\badcode