diff options
Diffstat (limited to 'doc')
31 files changed, 200 insertions, 42 deletions
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf index 58fceb2740..b43166e8ad 100644 --- a/doc/config/qtcreator-project.qdocconf +++ b/doc/config/qtcreator-project.qdocconf @@ -20,7 +20,8 @@ imagedirs = ../images \ ../../src/plugins/qmldesigner/components/formeditor \ ../../src/plugins/qmldesigner/components/navigator \ ../../src/plugins/scxmleditor/common/images \ - ../../src/plugins/texteditor/images + ../../src/plugins/texteditor/images \ + ../../src/plugins/valgrind/images exampledirs = ../examples examples.fileextensions += *.qml *.svg diff --git a/doc/images/qtcreator-analyzer-settings.png b/doc/images/qtcreator-analyzer-settings.png Binary files differindex ce321e520a..2097cb2469 100644 --- a/doc/images/qtcreator-analyzer-settings.png +++ b/doc/images/qtcreator-analyzer-settings.png diff --git a/doc/images/qtcreator-code-style-clang-format.png b/doc/images/qtcreator-code-style-clang-format.png Binary files differindex f44c0ea47b..d803d551a1 100644 --- a/doc/images/qtcreator-code-style-clang-format.png +++ b/doc/images/qtcreator-code-style-clang-format.png diff --git a/doc/images/qtcreator-code-style-settings-edit-cpp.png b/doc/images/qtcreator-code-style-settings-edit-cpp.png Binary files differindex 3d15ac12e4..ff52a41b8f 100644 --- a/doc/images/qtcreator-code-style-settings-edit-cpp.png +++ b/doc/images/qtcreator-code-style-settings-edit-cpp.png diff --git a/doc/images/qtcreator-code-style-settings-edit-qtquick.png b/doc/images/qtcreator-code-style-settings-edit-qtquick.png Binary files differindex 0063f69e59..276ce1cbab 100644 --- a/doc/images/qtcreator-code-style-settings-edit-qtquick.png +++ b/doc/images/qtcreator-code-style-settings-edit-qtquick.png diff --git a/doc/images/qtcreator-options-build-run-debuggers.png b/doc/images/qtcreator-options-build-run-debuggers.png Binary files differindex b249ddbbee..f6a56fbe4f 100644 --- a/doc/images/qtcreator-options-build-run-debuggers.png +++ b/doc/images/qtcreator-options-build-run-debuggers.png diff --git a/doc/images/qtcreator-projects-code-style.png b/doc/images/qtcreator-projects-code-style.png Binary files differnew file mode 100644 index 0000000000..90fb3b4fcd --- /dev/null +++ b/doc/images/qtcreator-projects-code-style.png diff --git a/doc/images/qtcreator-python-run-settings-custom-executable.png b/doc/images/qtcreator-python-run-settings-custom-executable.png Binary files differnew file mode 100644 index 0000000000..3db0379f57 --- /dev/null +++ b/doc/images/qtcreator-python-run-settings-custom-executable.png diff --git a/doc/images/qtcreator-python-run-settings.png b/doc/images/qtcreator-python-run-settings.png Binary files differnew file mode 100644 index 0000000000..f5abe19861 --- /dev/null +++ b/doc/images/qtcreator-python-run-settings.png diff --git a/doc/images/qtcreator-valgrind-callgrind-options.png b/doc/images/qtcreator-valgrind-callgrind-options.png Binary files differindex eb7956c57b..82684f645b 100644 --- a/doc/images/qtcreator-valgrind-callgrind-options.png +++ b/doc/images/qtcreator-valgrind-callgrind-options.png diff --git a/doc/images/qtcreator-valgrind-callgrind.png b/doc/images/qtcreator-valgrind-callgrind.png Binary files differindex 34396a5663..e57038a151 100755 --- a/doc/images/qtcreator-valgrind-callgrind.png +++ b/doc/images/qtcreator-valgrind-callgrind.png diff --git a/doc/src/analyze/creator-valgrind.qdoc b/doc/src/analyze/creator-valgrind.qdoc index fb22f8632c..92c42fd48c 100644 --- a/doc/src/analyze/creator-valgrind.qdoc +++ b/doc/src/analyze/creator-valgrind.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -149,13 +149,17 @@ You can use the Callgrind tool included in the \l{http://valgrind.org/info/tools.html}{Valgrind tool suite} to detect - problems that are related to executing functions. + problems that are related to executing functions. In addition, you + can load the data files generated by Callgrind into the + \l{https://kcachegrind.github.io/html/Home.html}{KCachegrind} + profile data visualization tool for browsing the performance results. - After you download and install Valgrind tools, you can use Callgrind from - \QC. + After you download and install Valgrind tools and KCachegrind, you can use + Callgrind and KCachegrind from \QC. - \note You can install and run Callgrind locally on Linux. You can run - it on a remote Linux machine or device from any development machine. + \note You can install and run Callgrind and KCachegrind locally on Linux. + You can run Callgrind on a remote Linux machine or device from any + development machine. To analyze applications: @@ -207,6 +211,10 @@ \image qtcreator-valgrind-callgrind.png "Profile view" + To view the data in KCachegrind, select the \inlineimage kcachegrind.png + (\uicontrol {Open Results in KCachegrind}) button on the toolbar. \QC + launches KCachegrind and loads the data into it for visualization. + \section1 Selecting Profiling Options You can specify analyzer settings either globally for all projects or @@ -218,6 +226,9 @@ \image qtcreator-valgrind-callgrind-options.png "Valgrind options" + In the \uicontrol {KCachegrind executable} field, enter the path to the + KCachegrind executable to launch. + In the \uicontrol {Result view: Minimum event cost} field, limit the amount of results the profiler gives you to increase profiler performance. diff --git a/doc/src/editors/creator-clangformat.qdocinc b/doc/src/editors/creator-clangformat.qdocinc index 8a4b757399..705f4067bb 100644 --- a/doc/src/editors/creator-clangformat.qdocinc +++ b/doc/src/editors/creator-clangformat.qdocinc @@ -28,7 +28,7 @@ \section2 Automatic Formatting and Indentation - The experimental Clang Format plugin uses the + The Clang Format plugin uses the \l{https://clang.llvm.org/docs/LibFormat.html}{LibFormat} library for automatic formatting and indentation. diff --git a/doc/src/editors/creator-only/creator-clang-codemodel.qdoc b/doc/src/editors/creator-only/creator-clang-codemodel.qdoc index f8e2b890c1..fe582d342d 100644 --- a/doc/src/editors/creator-only/creator-clang-codemodel.qdoc +++ b/doc/src/editors/creator-only/creator-clang-codemodel.qdoc @@ -112,7 +112,7 @@ \list \li Clang code model (globally or at project level) - \li Clang tools (globally or at project level) + \li \l{Using Clang Tools}{Clang tools} (globally or at project level) \endlist \section1 Configuring Clang Code Model diff --git a/doc/src/editors/creator-only/creator-code-pasting.qdoc b/doc/src/editors/creator-only/creator-code-pasting.qdoc index 587ce158e5..803a15e64a 100644 --- a/doc/src/editors/creator-only/creator-code-pasting.qdoc +++ b/doc/src/editors/creator-only/creator-code-pasting.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -97,6 +97,6 @@ retrieve the code snippet by selecting \uicontrol Tools > \uicontrol {Code Pasting} > \uicontrol {Fetch Snippet}. If they have the project currently opened in \QC, they can apply and test the change by - choosing \uicontrol Tools > \uicontrol Git > \uicontrol {Patch} > - \uicontrol {Apply from Editor}. + choosing \uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} + > \uicontrol Patch > \uicontrol {Apply from Editor}. */ diff --git a/doc/src/howto/creator-sidebar-views.qdocinc b/doc/src/howto/creator-sidebar-views.qdocinc index 1a6af5a398..ff287b4525 100644 --- a/doc/src/howto/creator-sidebar-views.qdocinc +++ b/doc/src/howto/creator-sidebar-views.qdocinc @@ -145,6 +145,9 @@ \li To hide source files which are automatically generated by the build system, select \uicontrol {Filter Tree > Hide Generated Files}. + \li To hide directories that do not contain any files, select + \uicontrol {Filter Tree} > \uicontrol {Hide Empty Directories}. + \li To stop synchronizing the position in the project tree with the file currently opened in the editor, deselect \inlineimage linkicon.png (\uicontrol {Synchronize with Editor}). You can specify a keyboard @@ -190,7 +193,8 @@ For managing files and directories, the same functions are available as in the \uicontrol {File System} view. In addition, you can remove and rename - files. + files, as well as compare the selected file with the currently open file + in the diff editor. For more information, see \l{Comparing Files}. //! [projects view] diff --git a/doc/src/overview/creator-only/creator-configuring.qdoc b/doc/src/overview/creator-only/creator-configuring.qdoc index 0a3096737b..d6a91039ed 100644 --- a/doc/src/overview/creator-only/creator-configuring.qdoc +++ b/doc/src/overview/creator-only/creator-configuring.qdoc @@ -124,10 +124,11 @@ For more information, see \l{Defining Color Schemes}. - Generic highlighting is based on highlight definition files that are - provided by the - \l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/} - {Kate Editor}. You can download highlight definition files for use with \QC. + Generic highlighting is provided by + \l{https://api.kde.org/frameworks/syntax-highlighting/html/index.html} + {KSyntaxHighlighting}, which is the syntax highlighting engine for Kate + syntax definitions. \QC comes with most of the commonly used syntax files, + and you can download additional files. To download and use highlight definition files, select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} > \uicontrol {Generic Highlighter}. diff --git a/doc/src/overview/creator-only/creator-overview.qdoc b/doc/src/overview/creator-only/creator-overview.qdoc index c732d2d3d8..1f6f31936d 100644 --- a/doc/src/overview/creator-only/creator-overview.qdoc +++ b/doc/src/overview/creator-only/creator-overview.qdoc @@ -79,6 +79,10 @@ languages as code, not just as plain text. This enables it to provide you with useful features, such as semantic highlighting, checking code syntax, code completion, and refactoring actions. + In addition, the experimental language server plugin provides + some of these services for other programming languages, such as + Python, for which a \e {language server} is available that + provides information about the code to IDEs. For more information, see \l{Coding}. \row \li \inlineimage creator_buildingrunning.png diff --git a/doc/src/overview/creator-only/creator-supported-platforms.qdoc b/doc/src/overview/creator-only/creator-supported-platforms.qdoc index b91b67803f..a64947d802 100644 --- a/doc/src/overview/creator-only/creator-supported-platforms.qdoc +++ b/doc/src/overview/creator-only/creator-supported-platforms.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -101,7 +101,7 @@ \endlist - \li \macos 10.11 or later with the following: + \li \macos 10.12 or later with the following: \list @@ -117,9 +117,9 @@ Either Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS or later is required to install and use Qt for Device Creation. For more information about the requirements for the development host, see the - \l{http://doc.qt.io/QtForDeviceCreation/qtee-installation-guide.html} - {Installation Guide} in the - \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation} + \l{https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html} + {Installation Guides} in the + \l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation} documentation. \section1 Compiling from Source diff --git a/doc/src/overview/creator-only/creator-target-platforms.qdocinc b/doc/src/overview/creator-only/creator-target-platforms.qdocinc index 3e0153e09d..a936ae7a9a 100644 --- a/doc/src/overview/creator-only/creator-target-platforms.qdocinc +++ b/doc/src/overview/creator-only/creator-target-platforms.qdocinc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -56,9 +56,13 @@ hardware. For more information about the supported device groups and reference devices, - see \l{http://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html} - {Supported Platforms} in the \l{http://doc.qt.io/QtForDeviceCreation/index.html} - {Qt for Device Creation} documentation. + see \l{https://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html} + {Reference Target Devices and Development Hosts} in the + \l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation} + documentation. + + \note Since \QC 4.9, only Boot to Qt version 5.9 and later are supported. + To develop for earlier Boot to Qt versions, use \QC 4.8. \section2 Mobile Devices diff --git a/doc/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/src/projects/creator-only/creator-projects-compilers.qdoc index 0e3f89c326..5387e4c680 100644 --- a/doc/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/src/projects/creator-only/creator-projects-compilers.qdoc @@ -64,6 +64,10 @@ \li Clang is a C, C++, Objective C, and Objective C++ front-end for the LLVM compiler for Windows, Linux, and \macos. + \li \l{https://clang.llvm.org/docs/UsersManual.html#clang-cl}{clang-cl} + is an alternative command-line interface to Clang that is compatible + with the Visual C++ compiler, \c cl.exe. + \li Nim is the Nim Compiler for Windows, Linux, and \macos. \li QCC is the interface for compiling C++ applications for QNX. @@ -76,6 +80,12 @@ versions. You can also create a custom ABI definition. For QCC, also specify the path to the QNX Software Development Platform (SDP). + To enable Microsoft Visual C++ Compilers (MSVC) and clang-cl to find system + headers, libraries, and the linker, \QC executes them inside a command + prompt where the environment has been set up using \c {vcvarsall.bat}. For + these compilers, you also specify the path to the script that sets up the + command prompt. + You specify the compiler to use for each kit in \uicontrol Tools > \uicontrol Options > \uicontrol Kits. diff --git a/doc/src/projects/creator-only/creator-projects-debuggers.qdoc b/doc/src/projects/creator-only/creator-projects-debuggers.qdoc index 6e9b3013f9..ebd1f6c366 100644 --- a/doc/src/projects/creator-only/creator-projects-debuggers.qdoc +++ b/doc/src/projects/creator-only/creator-projects-debuggers.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -86,4 +86,8 @@ the shell or the device. Usually, you can leave this field empty. \endlist + + To remove the selected manually added debugger, select \uicontrol Remove. + The debugger is removed from the list when you select \uicontrol Apply. + Until then, you can cancel the deletion by clicking \uicontrol Restore. */ diff --git a/doc/src/projects/creator-only/creator-projects-opening.qdoc b/doc/src/projects/creator-only/creator-projects-opening.qdoc index 7fe17582ef..6298c896b5 100644 --- a/doc/src/projects/creator-only/creator-projects-opening.qdoc +++ b/doc/src/projects/creator-only/creator-projects-opening.qdoc @@ -1,7 +1,7 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -58,6 +58,10 @@ select the \uicontrol Options link, or select \uicontrol Tools > \uicontrol Options > \uicontrol Kits. + Qt for Python projects rely on the \l{Using Language Servers} + {experimental language server client} for code completion, + highlighting, and other useful features. + If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit}, it starts out from a clean slate, and creates new debug and release build configurations @@ -79,8 +83,8 @@ \li Select \uicontrol File > \uicontrol {Open File or Project} (\key Ctrl+O or \key Cmd+O on \macos) and select the project file for the project to open: \e {.pro} (qmake), \e {CMakeLists.txt} - (CMake), \e {.qbs} (Qbs), or \e {Makefile.am} (Autotools, - experimental). + (CMake), \e {.qbs} (Qbs), \e {pyproject} (Python), or + \e {Makefile.am} (Autotools, experimental). \li In the \uicontrol {Configure Project} tab, select kits for building and running your project, and click \uicontrol {Configure Project}. diff --git a/doc/src/projects/creator-only/creator-projects-settings-code-style.qdoc b/doc/src/projects/creator-only/creator-projects-settings-code-style.qdoc index 4e3841b4d2..525e7965f4 100644 --- a/doc/src/projects/creator-only/creator-projects-settings-code-style.qdoc +++ b/doc/src/projects/creator-only/creator-projects-settings-code-style.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -48,6 +48,16 @@ switch between them. In addition, you can import and export code style settings. + \image qtcreator-projects-code-style.png "Code Style settings in Projects mode" + + Alternatively, you can enable the Clang Format plugin to enforce + the code style specified in a \c {.clang-format} file. It uses the + \l{https://clang.llvm.org/docs/LibFormat.html}{LibFormat} library for + automatic code formatting and indentation. For more information, see + \l {Automatic Formatting and Indentation}. + + \image qtcreator-code-style-clang-format.png "Clang Format Code Style settings in Projects mode" + To specify global code style settings sets for C++ files, select \uicontrol {Tools > Options > C++}. diff --git a/doc/src/projects/creator-only/creator-projects-settings-run.qdoc b/doc/src/projects/creator-only/creator-projects-settings-run.qdoc index 1010186a3f..a67b2052fd 100644 --- a/doc/src/projects/creator-only/creator-projects-settings-run.qdoc +++ b/doc/src/projects/creator-only/creator-projects-settings-run.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -117,4 +117,6 @@ \image qmldesigner-run-custom-exe.png "Run settings for custom executables" \include qtquick/creator-projects-settings-run-qtquick.qdocinc run settings qt quick ui + \include python/creator-python-run.qdocinc run settings python + */ diff --git a/doc/src/projects/creator-only/creator-projects-targets.qdoc b/doc/src/projects/creator-only/creator-projects-targets.qdoc index b3a4229f14..1d6101b02f 100644 --- a/doc/src/projects/creator-only/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-only/creator-projects-targets.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -53,6 +53,10 @@ \li Bare Metal Device + \li Boot2Qt Device (commercial only) + + \li \l {Emulator}{Boot2Qt Emulator Device} (commercial only) + \li Generic Linux Device \li iOS Device @@ -61,6 +65,12 @@ \li QNX Device + \li Windows Phone + + \li Windows Phone Emulator + + \li Windows Runtime (local) + \endlist To add kits: @@ -95,6 +105,9 @@ \li In the \uicontrol Device field, select a device. + \li In the \uicontrol {Emulator skin} field, select the skin to use for + the \l {Emulator}{Boot2Qt Emulator Device}. + \li In the \uicontrol Sysroot field, specify the directory where the device image is located. If you are not cross-compiling, leave this field empty. diff --git a/doc/src/projects/creator-projects-running.qdoc b/doc/src/projects/creator-projects-running.qdoc index caca6bb636..85cb0b287c 100644 --- a/doc/src/projects/creator-projects-running.qdoc +++ b/doc/src/projects/creator-projects-running.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -85,5 +85,6 @@ \if defined(qtcreator) \include qnx/creator-projects-running-qnx.qdocinc running on qnx + \include python/creator-python-run.qdocinc running python \endif */ diff --git a/doc/src/python/creator-python-run.qdocinc b/doc/src/python/creator-python-run.qdocinc new file mode 100644 index 0000000000..cc9b19698c --- /dev/null +++ b/doc/src/python/creator-python-run.qdocinc @@ -0,0 +1,73 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! +//! [running python] + \section1 Running Python Projects + + You can execute Qt for Python applications directly from \QC. If you + used the \l{Creating Qt for Python Applications}{new project wizard} + to create the application project, the \c main.py file is automatically + executed when you select the \uicontrol Run button. + + You can specify another file to execute in the + \l{Specifying Run Settings for Python Projects}{run settings} + of the project. + +//! [running python] + + +//! [run settings python] + + \section1 Specifying Run Settings for Python Projects + + You can specify settings for running Qt for Python applications: + + \image qtcreator-python-run-settings.png + + \list + \li In the \uicontrol Interpreter field, specify the path to the + Python executable. + \li In the \uicontrol Script field, you can see the path to the + main file of the project that will be run. + \li In the \uicontrol {Command line arguments} field, specify + command line arguments to be passed to the executable. + \endlist + + If you want to run some other Python file than \c main.py, create a custom + executable run configuration: + + \image qtcreator-python-run-settings-custom-executable.png + + \list 1 + \li Select \uicontrol Add > \uicontrol {Custom Executable}. + \li In the \uicontrol Executable field, specify the path to the + Python executable. + \li In the \uicontrol {Command line arguments} field, select + the Python file to run. + \endlist + +//! [run settings python] +*/ diff --git a/doc/src/qtquick/qtquick-profiler.qdoc b/doc/src/qtquick/qtquick-profiler.qdoc index cd934eb55d..f94f4f0b25 100644 --- a/doc/src/qtquick/qtquick-profiler.qdoc +++ b/doc/src/qtquick/qtquick-profiler.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -212,6 +212,11 @@ To zoom into an event range, double-click it. + To narrow down the current range in the \uicontrol Timeline, + \uicontrol Statistics, and \uicontrol {Flame Graph} views, right-click + the range and select \uicontrol {Analyze Current Range}. To return to + the full range, select \uicontrol {Analyze Full Range} in the context menu. + To remove an event range, close the \uicontrol Selection dialog. \section2 Understanding the Data @@ -556,10 +561,9 @@ Click on an event to move to it in the source code in the code editor. - When you select an event in the \uicontrol Timeline view, information about it is - displayed in the \uicontrol Statistics view. To view an event range in the - \uicontrol Statistics view, select \uicontrol {Analyze Current Range} - in the context menu in the \uicontrol Timeline view. + When you select an event in the \uicontrol Timeline view, information about + it is displayed in the \uicontrol Statistics and \uicontrol {Flame Graph} + views. To copy the contents of one view or row to the clipboard, select \uicontrol {Copy Table} or \uicontrol {Copy Row} in the context menu. diff --git a/doc/src/vcs/creator-only/creator-vcs-cvs.qdoc b/doc/src/vcs/creator-only/creator-vcs-cvs.qdoc index 738db2b7bb..030fd73240 100644 --- a/doc/src/vcs/creator-only/creator-vcs-cvs.qdoc +++ b/doc/src/vcs/creator-only/creator-vcs-cvs.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -41,9 +41,16 @@ In addition to the standard version control system functions described in \l {Using Common Functions}, you can select \uicontrol Tools > - \uicontrol CVS > \uicontrol Edit to open a file for editing. + \uicontrol CVS > \uicontrol Edit to set a file as writable, notify + watchers that the file is being edited, and watch for actions performed + on the file by other users. - To discard the changes that you made in a file, select \uicontrol Unedit. + To discard the changes that you made in a file, notify watchers that + the file is no longer being edited, and set the file as read-only, + select \uicontrol Unedit. + + To unedit files in the local directory, as well as recursively in all + subdirectories, select \uicontrol {Unedit Repository}. To specify the CVS root directory, select \uicontrol Tools > \uicontrol Options > \uicontrol {Version Control} > \uicontrol CVS, and then diff --git a/doc/src/vcs/creator-only/creator-vcs.qdoc b/doc/src/vcs/creator-only/creator-vcs.qdoc index c7f3c0dc94..b0e7502ad2 100644 --- a/doc/src/vcs/creator-only/creator-vcs.qdoc +++ b/doc/src/vcs/creator-only/creator-vcs.qdoc @@ -72,6 +72,11 @@ \li \l{Using Perforce}{Perforce} \li \l{http://www.perforce.com} \li Server version 2006.1 and later + + Disabled by default. To enable the plugin, select + \uicontrol Help > \uicontrol {About Plugins} > + \uicontrol {Version Control} > \uicontrol Perforce, + and then restart \QC. \row \li \l{Using Subversion}{Subversion} \li \l{http://subversion.apache.org/} |