Commit Graph

1278 Commits

Author SHA1 Message Date
Leena Miettinen
ace0a0d9d1 Doc: Add CLI options
Make the wording and capitalization of existing docs more
consistent.

Task-number: QTCREATORBUG-26610
Change-Id: If241a951ce4df757a1b26524dee412ef44bbfa4e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2022-02-25 08:54:18 +00:00
Leena Miettinen
6e366c0823 Doc: Replace "New File or Project" with "New Project" or "New File"
We missed the .qdocinc files.
Update the screenshot.

Task-number: QTCREATORBUG-26610
Change-Id: Ic5a86c94e995a209c2139976ed645b7f71556b37
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-23 11:56:50 +00:00
Leena Miettinen
b0a7fe31c0 Doc: Update Options > Environment > System screenshot
- Mention "Auto-save files after refactoring" in Opening Files.
- Include the screenshot in Specifying Environment Settings.

Task-number: QTCREATORBUG-26610
Change-Id: I05eaf85244ba1f1acf870bbcd37ba81f616b17a4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-23 07:48:58 +00:00
Leena Miettinen
0c13c1c084 Doc: Describe formatting in CMake Build Settings
Italic text indicates that a value was inherited from
the kit configuration or initial configuration. Red text
indicates mismatches.

Change-Id: Ief30eef1d2667d0b4e570ea439ffb6af681db2b7
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-02-21 16:44:10 +00:00
Leena Miettinen
d487110351 QML/JS: Fix terminology in messages
- Replace Qt Quick Designer with Qt Design Studio
- Replace "Qt Quick UI form" with "UI file (.ui.qml)"

Also fix the docs:

- Add missing messages
- Hide QDS  messages from Qt Creator Manual
- Make punctuation consistent
- Add some links to more information

Task-number: QDS-2670
Task-number: QTCREATORBUG-27055
Change-Id: Id90f1ad82e7297f91225bc8d650a9578ba071330
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-02-18 07:33:35 +00:00
Leena Miettinen
b2d90241fe Log Viewer: Fix UI text
Also update the string in the documentation.

Task-number: QTCREATORBUG-27055
Change-Id: Idce699a7796e7cb55d8218c105ec851c369cef7b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-17 14:23:29 +00:00
Antti Määttä
3905239cea Add Quick 3D events to profiler documentation
Task-number: QTBUG-100643
Change-Id: I8e3096892742b647d3aadabfc61e0eab966f11ea
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
2022-02-15 12:47:08 +00:00
Leena Miettinen
756a67c563 Doc: Update CMake build settings
- Describe context menu options for syncing configurations
- Describe options for getting help on variables and options

Task-number: QTCREATORBUG-26983
Change-Id: Ide88172bc2e8032434ee657a9995528b6917a871
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-02-11 09:30:40 +00:00
Leena Miettinen
7e00d5f662 Doc: Describe applying context menu actions to multiple issues
...in the Issues pane.

Task-number: QTCREATORBUG-26610
Change-Id: I5ad148b7f8e1696aa0f3b494f05b068df9d2210d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-02-10 09:49:09 +00:00
Leena Miettinen
3bd96e7e73 Doc: Move creating files into a separate topic
"New File" is now a separate menu item in the "File" menu.
This way the topics are a bit shorter.

Task-number: QTCREATORBUG-26610
Change-Id: Iedfc79f196fc9c3b28f8613f7d8a5ed057770b9a
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-09 15:29:01 +00:00
Leena Miettinen
4e781e7915 Doc: Describe new Clang compiler options
The target triple can be viewed and overridden if Clang
does not understand the target architecture.

Task-number: QTCREATORBUG-26610
Change-Id: I3420f09ae5227c3aa4be3baf9cb2383e9bdac135
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-02-09 12:09:34 +00:00
Leena Miettinen
67e4e4f5a7 Doc: Describe new option in Qt Quick Autotest project wizard
The "Generate setup code" check box executes C++ code before
any of the QML tests are run.

Task-number: QTCREATORBUG-26741
Task-number: QTCREATORBUG-26610
Change-Id: Ica4d0391e3624196b3327267f5a3082ca57b58cd
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-02-08 14:58:33 +00:00
Leena Miettinen
68592ad59e Doc: Update info on clangd, which is now used by default
Update the text and screenshot.

Task-number: QTCREATORBUG-26610
Change-Id: Ie35f3b6885df49029ac0dbc54677e9e6f472d2c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-02-08 13:21:41 +00:00
Leena Miettinen
3926e708a9 Doc: Update info on Android settings
Fixes: QTCREATORBUG-26672
Change-Id: Ifaf9f28b485f965302bca9aa2ec2a308b96d4b34
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-02-08 12:39:57 +00:00
hjk
a8092c9708 Doc: Add a hint on what to do when stuck with older CMake versions
Change-Id: Ia68b0ae94f69eca8fd674d7537f35af1b0f685bb
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-02-08 08:58:17 +00:00
Leena Miettinen
80dee0fd32 Doc: Describe using system editor by default
...for files of a particular MIME type.

Task-number: QTCREATORBUG-13880
Task-number: QTCREATORBUG-26610
Change-Id: I6866849b861c124b7a4e028a4ee62b7ad47239aa
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-08 07:55:19 +00:00
Leena Miettinen
ea7b370fe9 Doc: Update CMake configuration info
- Initial variables are now listed in the Initial Configuration tab
  and current ones in the Current Configuration tab.
- CMake builds can be stopped.
- Variables are no longer grouped according to their prefix.
- Kit Configuration button enables setting CMake options for the
  current kit.

Fixes: QTCREATORBUG-26983
Change-Id: I0b8696adc9d442b4c33c6e3c34739e5583254cd9
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-02-07 11:07:27 +00:00
Christian Stenger
a9fbd675e2 Doc: Document logging viewer
Task-number: QTCREATORBUG-26929
Change-Id: I67e7ab32ab92e28c1d9b018801872d0e111e1971
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-02-07 09:42:47 +00:00
Leena Miettinen
85e9a7a9c2 Doc: Describe filtering Git log by author and toggling colors
Task-number: QTCREATORBUG-26610
Change-Id: I72abb044d6ab54f83b76b72b34b500ed5ea8c47d
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2022-02-07 07:55:13 +00:00
Leena Miettinen
da95472eb7 Doc: Describe using precompiled headers in generic projects
Users can add the pch tag after a file path in .files.

Task-number: QTCREATORBUG-26610
Change-Id: I55cc6ef86c6371658845d233614bebad2a20e35d
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-02-04 12:48:15 +00:00
Leena Miettinen
a3ca2f4c31 Doc: Describe new search options
In incremental search, you can now Select All occurrences of
a search term and open Advanced search.

Task-number: QTCREATORBUG-26610
Change-Id: I264f9c7ae7f73aab0ef63e5b70914ff6cdb2f02c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-02-02 15:38:37 +00:00
Leena Miettinen
749a9b27ec Doc: Describe Language Client Inspector
Users can inspect the communication between Qt Creator
and language servers and view server capabilities.

Task-number: QTCREATORBUG-26929
Change-Id: I9ad4518eea030ba70dda2f0b956b319b3682af0f
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2022-02-01 08:45:18 +00:00
Christian Kandeler
a77f5d41b4 CppEditor: No longer refer to clangd as experimental in the UI
Change-Id: Iadfbdf23a92ee551fff03f5eb5b8a1b2b15b0870
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2022-01-31 13:58:16 +00:00
Leena Miettinen
8ace5d3895 Doc: Update info about ClangFormat options
The options are now in a separate tab.

Fixes: QTCREATORBUG-26597
Change-Id: If2d337c132f468897cd71e217205c3db29028f34
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-01-27 14:58:21 +00:00
Eike Ziller
c6fdb66b2b Collect Qt Creator debug menu items into common submenu
instead of spreading them over the place.

- rename "Logger..." to "Show Logs..."
- create "Tools > Debug Qt Creator" menu and put "Show Logs", "Inspect
Language Clients" and "Inspect C++ Code Model" there
- add missing ellipsis

That gets rid of the otherwise not useful "Language Client" submenu, and
creates a nicer place for the "Show Logs" item.

Change-Id: I2588b4c93327669579979dfbfce37005ada29dab
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-01-26 12:59:21 +00:00
Knud Dollereder
ebac821e9e Replace minitrace with nanotrace
Minitrace is a library to produce json traces suitable for chromes
built-in trace viewer. Unfortunately it lacks the ability to add
custom arguments to the json files which is needed in our case
in order to examine Design Studios state from within the evaluating
python script. Nanotrace is a rewrite of minitrace that adds this
ability. Additional benefits are higher precision and the fact that
it is written in c++.

Change-Id: Id2610b93188483d88547369c3fa8dacbe4dee9f7
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2022-01-25 14:25:04 +00:00
Eike Ziller
7a94cca007 Merge remote-tracking branch 'origin/6.0'
Change-Id: Ia208fc746333e3d36868c580aa7794da9627c3e0
2022-01-14 10:24:10 +01:00
Leena Miettinen
fd6380f935 Doc: Describe deploying apps to embedded Linux devices
- Describe deployment process in the instructions for generic
  remote Linux devices and link to there from the instructions
  for specific devices.
- Update instructions for adding files when using CMake and remove
  the include file.
- Add an example of adding files to deploy when using qmake.

Fixes: QTCREATORBUG-26616
Change-Id: I07cf9169da384dd65adc6935110e4dcbeb3e308b
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
2022-01-14 07:31:34 +00:00
Cristian Adam
45e078541e Doc: Update Clang version / URL in README.md
Change-Id: Ic0e1865cf6761436a12d8f36d1af80e462118c2f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-01-13 11:07:49 +00:00
Eike Ziller
65e8c864af Merge remote-tracking branch 'origin/6.0'
Change-Id: I405e3f95b0cdcd7b2686f31baae16c03c787f007
2022-01-06 11:55:39 +01:00
Leena Miettinen
243521380b Doc: Update CMakeLists.txt files of tutorial example apps
To match the files generated by the application wizards.

Change-Id: If749a6dcc25eacb9daef451fec6abbc879bbc8a8
Reviewed-by: Artem Sokolovskii <artem.sokolovskii@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2022-01-06 09:45:03 +00:00
Leena Miettinen
8d06519211 Doc: Describe new and modified Debugger keyboard shortcuts
F9 (F8 on macOS) is now Set or Remove Breakpoint and
Ctrl+9 (Ctrl+8) was added for Enable or Disable Breakpoint.

Task-number: QTCREATORBUG-26788
Change-Id: I54ddf2f15812dd5349ac31c8afade84c0e3fff96
Reviewed-by: hjk <hjk@qt.io>
2022-01-04 09:47:24 +00:00
Eike Ziller
85b60d9608 Merge remote-tracking branch 'origin/6.0'
Conflicts:
	src/plugins/coreplugin/editormanager/editormanager.cpp

Change-Id: I80fe565749ad5c06dfe99436f2dc6ab4b66a2537
2021-12-16 10:50:33 +01:00
Christiaan Janssen
b9b9075300 Docs: update requirements for Qt for MCUs
Task-number: UL-5063
Change-Id: I3e92e29c636f4dee649fb1107ea58d6eac0768d4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-15 15:26:33 +00:00
Leena Miettinen
229d26df6f Doc: Describe CMake config for debugging running Qt Quick apps
The target_compile_definitions(myapp PRIVATE QT_QML_DEBUG) command
is used.

Task-number: QTCREATORBUG-26616
Change-Id: Ifde5f6f11081afa8af19e0339733d7380d1d14be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-14 08:04:37 +00:00
Leena Miettinen
749bc57046 Doc: Describe library declaration in CMakeLists.txt files
The C++ Library wizard template adds target_link_libraries when
CMake is selected as the build system.

Task-number: QTCREATORBUG-26616
Change-Id: Ib3e42530d0b0f8f288849fed539e0d7b5ee42eb6
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2021-12-13 12:24:40 +00:00
Christian Stenger
3989245562 AutoTest: Allow handling of maximum warnings for QtTest
If the maximum number of warnings is reached the test will be
canceled automatically. Allow to handle this from the user side
in case it might be needed.

Fixes: QTCREATORBUG-26637
Change-Id: I239eca280cdc2ce46f6d64cd53b8f3ad0205f7f2
Reviewed-by: David Schulz <david.schulz@qt.io>
2021-12-10 05:42:03 +00:00
Eike Ziller
d422b408e0 Merge remote-tracking branch 'origin/6.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs
	qtcreator_ide_branding.pri

Change-Id: I32991a77e52831dd2e24cf4a51ec252998c2d743
2021-12-09 12:04:32 +01:00
Leena Miettinen
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files

This is the second step towards making the icons visible in both
dark and light online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 10:44:55 +00:00
Leena Miettinen
48fafae034 Doc: Move all icon images to images/icons and fix references to them
As a first step to making the images visible in both dark and light
online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: If7da7fec69d1114201d2832b4228b4dba0f090f0
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 08:01:40 +00:00
Leena Miettinen
f6757fd87f Doc: Add CMake equivalent for LSMinimumSystemVersion
...in an Info.plist file.

Also remove "Qt 5", because this also applies to Qt 6 apps.

Task-number: QTCREATORBUG-26616
Change-Id: I2041506dccf719559d53f066dfe5acc864a51569
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2021-12-08 15:47:07 +00:00
Leena Miettinen
7bb558fa64 Doc: Describe specifying default config file for Beautifier
...when using CMake as the build system.

Task-number: QTCREATORBUG-26616
Change-Id: I03cadcc1eea6a50b52b59f6ab76931d988f09058
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-08 15:46:49 +00:00
Leena Miettinen
c12b09e543 Doc: Describe showing additional files in Projects view
...when using CMake.

Add link targets for CMake command and property docs, because
at least the "install" command is needed in several places in the
manual.

Task-number: QTCREATORBUG-26616
Change-Id: I204325741925080532e8944578464cf4e1cb648f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-08 15:46:40 +00:00
Leena Miettinen
e545e8fdbb Doc: Add info about integrating wizards into CMake builds
Add CMake to the example of creating a selection list for
choosing build systems in a custom wizard.

Task-number: QTCREATORBUG-26616
Change-Id: I0bb7e59b8a2f6d42d139de7a24c033dabbe6da6a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-08 11:51:24 +00:00
Leena Miettinen
d81f48964d Doc: Mention that lupdate and lrelease integration is qmake-only
Add a link to information about using the tools with CMake.

Task-number: QTCREATORBUG-26616
Change-Id: I44c3701703e8831dcb4a89f3bd1ecb14fb3c4853
Reviewed-by: Lucie Gerard <lucie.gerard@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-08 10:50:56 +00:00
Leena Miettinen
e2b40333fe Doc: Mention that SUBDIRS are only used for qmake projects
Task-number: QTCREATORBUG-26616
Change-Id: I359846f21bcf234fe1d804bc9e7916092f7dd939
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-08 10:50:17 +00:00
Leena Miettinen
9b4e68dd84 Doc: Describe creating GUI apps and app bundles using CMake
The default behavior is opposite from when using qmake.

Task-number: QTCREATORBUG-26616
Change-Id: I9ec0f1a961e8d0cb25957dddcceec79cffbf292b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-07 08:13:55 +00:00
Leena Miettinen
4a37833803 Doc: Improve FAQ answer about QML imports
Even though CMake was mentioned, the text could be made more
general.

Task-number: QTCREATORBUG-26616
Change-Id: I6ff59e96559579c773d8ae1313f96800597e0ccc
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-12-06 08:31:50 +00:00
Leena Miettinen
ccc5223d94 Doc: Describe adding other projects to CMake projects
Mostly, this is explained in CMake documentation. There is
currently no special support for this in Qt Creator.

Task-number: QTCREATORBUG-26616
Change-Id: I7981324e04be6fc716256754db9f2089eaffee73
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-03 12:02:20 +00:00
Leena Miettinen
be059ac11a Doc: Fix info about qtc_runnable for CMake and qmake
Combine the sections and fix misleading information.

Task-number: QTCREATORBUG-26616
Change-Id: I6349d7f6d6765b8f76d391a48c232bf68ed124f6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-03 09:31:52 +00:00