summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2022-10-04 13:13:16 +0300
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-10-07 12:36:54 +0000
commit0bfa52d07a07c849d5f8a503762437e76e94fc3b (patch)
tree2714f2fc064dcbe6741c1621f12b4f5b93b3b30c
parent1723ead9e1632e25c6d86f28b360bf9c8106f80c (diff)
downloadqtdoc-0bfa52d07a07c849d5f8a503762437e76e94fc3b.tar.gz
Docs: Fix some naming around performance optimization documentation
While doing some work to add performance optimization information for embedded Linux targets noticed the naming of some other pages could more match the material to prevent confusion with what is to be added. Added QML in front of the qt quick performance doc page title. Added a link to the Qt Creator docs regarding the QML profiler. Change-Id: Iecf91dbf8d329e89519e16391bebf4295af35397 Reviewed-by: Kai Koehne <kai.koehne@qt.io> (cherry picked from commit 30827d85a55026342277e5d9f7ca7665c1cfd5ba) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--doc/src/external-resources.qdoc4
-rw-r--r--doc/src/qmlapp/applicationdevelopers.qdoc2
-rw-r--r--doc/src/qmlapp/performance.qdoc11
3 files changed, 11 insertions, 6 deletions
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 2b22a60e..7e30b634 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -400,6 +400,10 @@
\externalpage http://doc.qt.io/qtcreator/creator-deploying-android.html#editing-manifest-files
\title Qt Creator: Editing Manifest Files
*/
+/*!
+ \externalpage https://doc.qt.io/qtcreator/creator-qml-performance-monitor.html
+ \title Qt Creator: Profiling QML Applications
+*/
/*!
\externalpage https://doc.qt.io/qtcreator/creator-build-example-application.html
diff --git a/doc/src/qmlapp/applicationdevelopers.qdoc b/doc/src/qmlapp/applicationdevelopers.qdoc
index fd62cd12..62efd6ac 100644
--- a/doc/src/qmlapp/applicationdevelopers.qdoc
+++ b/doc/src/qmlapp/applicationdevelopers.qdoc
@@ -106,7 +106,7 @@ QML code is used in applications.
\li \l{Overview - QML and C++ Integration}
\li \l{qtquick-deployment.html}{Deploying QML Applications}
\li \l{qtquick-bestpractices.html}{Best Practices for QML and Qt Quick}
-\li \l{qtquick-performance.html}{Performance Considerations and Suggestions}
+\li \l{qtquick-performance.html}{QML Performance Considerations and Suggestions}
\li \l{qtquick-internationalization.html}{Internationalization and Localization}
\li Testing and Debugging
\list
diff --git a/doc/src/qmlapp/performance.qdoc b/doc/src/qmlapp/performance.qdoc
index d1939034..f0f9af68 100644
--- a/doc/src/qmlapp/performance.qdoc
+++ b/doc/src/qmlapp/performance.qdoc
@@ -3,8 +3,8 @@
/*!
\page qtquick-performance.html
-\title Performance Considerations And Suggestions
-\brief Discussion of performance-related tradeoffs and best-practices
+\title QML Performance Considerations And Suggestions
+\brief Discussion of performance-related trade-offs and best-practices
\section1 Timing Considerations
@@ -37,8 +37,9 @@ your event loop.
The most important tip is: use the QML profiler included with Qt Creator. Knowing
where time is spent in an application will allow you to focus on problem areas which
-actually exist, rather than problem areas which potentially exist. See the Qt Creator
-manual for more information on how to use the QML profiling tool.
+actually exist, rather than problem areas which potentially exist. See the
+\l{Qt Creator: Profiling QML Applications}{Qt Creator manual} for more
+information on how to use the QML profiling tool.
Determining which bindings are being run the most often, or which functions your
application is spending the most time in, will allow you to decide whether you need
@@ -452,7 +453,7 @@ sub-properties of a value-type is usually far less than the number of elements
in a sequence), any increase in the number of bindings being re-evaluated needlessly
will have a negative impact on performance.
-\section1 General Performance Tips
+\section2 General Performance Tips
General JavaScript performance considerations resulting from the language design are applicable also to QML. Most prominently: