Commit Graph

98 Commits

Author SHA1 Message Date
Leena Miettinen
a0f0f9c69b Doc: Update tutorials
- Use \ingroup creator-tutorials to group tutorials
- Use \annotatedlist to automatically generate tables that list tutorials
- Add \brief commands to add descriptions to the tables
- Remove some leftover descriptions from the Qt Quick Application
  wizard template docs
- Fix references to UI text
- Write "you" instead of "we"
- Use curly braces to define alt text for images
- Some language fixes

Task-number: QTCREATORBUG-28996
Change-Id: I4b611319b6867cae11d613e0a4d075923cdb037e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-07-05 13:48:04 +00:00
Leena Miettinen
0f409b7ae8 Doc: Move details of managing plugins into How-to topics
...from Configuring Qt Creator

Create "Enable and disable plugins" and "Install plugins" topics.

Task-number: QTCREATORBUG-29361
Change-Id: I51fdfad1cd7d210a72cf08ef3e82f08ae8c6ecac
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-04 11:06:13 +00:00
Leena Miettinen
0d75ba0293 Doc: Reorganize "User Interface" topic and move info to How-tos
Moved How-to topics into separate topics (HTML files) and
linked to them from UI Interface in QDS Manual and from How-to
in Qt Creator Manual.

Task-number: QTCREATORBUG-28996
Change-Id: I2b6defa936954c6a41085d0276f29942462ec12f
Signed-off-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-06-30 09:31:50 +00:00
Leena Miettinen
7c533d4d0c Doc: Update info about code analysis tools
Remove detail from the IDE Overview and Testing topics
because 7 other code analysis tools are now integrated in
addition to Valgrind and QML Profiler.

Task-number: QTCREATORBUG-28996
Change-Id: I23ab9935b9cff4f3bfc1bdc046c112dbb223c8f0
Reviewed-by: hjk <hjk@qt.io>
2023-06-27 14:56:48 +00:00
Leena Miettinen
596be71a89 Doc: Rewrite known issue about Ctrl+Shift+U on Linux
Change-Id: Ia14c89097b06f25649bc155c0c31734fd612b603
Reviewed-by: Robert Löhning <robert.loehning@qt.io>
2023-06-22 12:28:31 +00:00
Leena Miettinen
daad58175b Doc: Describe what to do if Ctrl+Shift+U stops finding references
Task-number: QTCREATORBUG-29134
Change-Id: I7c6816b692ae9decdad42c1a8ec73418735d0019
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-06-09 08:20:35 +00:00
Tim Jenssen
1b6c0ff56c Merge remote-tracking branch 'origin/qds/dev'
Conflicts:
  coin/instructions/build.yaml
  doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc
  share/qtcreator/qmldesigner/studio_templates/projects/common/CMakeLists.main.txt.tpl
  src/libs/CMakeLists.txt
  src/libs/advanceddockingsystem/dockmanager.cpp
  src/libs/advanceddockingsystem/workspacedialog.cpp
  src/plugins/coreplugin/manhattanstyle.cpp
  src/plugins/qmldesigner/CMakeLists.txt
  src/plugins/qmldesigner/components/formeditor/toolbox.cpp
  src/plugins/qmldesigner/components/itemlibrary/itemlibraryassetimporter.cpp
  src/plugins/qmldesigner/components/toolbar/toolbarbackend.cpp
  src/plugins/qmldesigner/designercore/projectstorage/qmltypesparser.h
  src/plugins/qmldesigner/qmldesignerexternaldependencies.cpp
  src/plugins/qmldesignerbase/qmldesignerbaseplugin.cpp
  src/plugins/qmldesignerbase/qmldesignerbaseplugin.h
  src/plugins/qmlprojectmanager/qmlproject.cpp
  src/tools/qml2puppet/CMakeLists.txt
  tests/unit/unittest/CMakeLists.txt

Change-Id: I2c5f18c4fca49471d02713ce5859032232cf7756
2023-05-22 21:13:40 +02:00
Tim Jenßen
9c2a73b1c8 Merge remote-tracking branch 'origin/10.0' into qds/dev
Change-Id: I51801c3bec7e29f7c7384d86d79b4fcabb4f99c1
2023-04-27 20:30:00 +02:00
Cristian Adam
dad415b884 Terminal: add cmd shell integration when using clink
The script was provided at https://github.com/chrisant996/clink/discussions/453

If clink is not installed cmd will not have any issues, since only
the environment variable CLINK_PATH will be set.

Change-Id: I9f1d16933ae6bbcb3da1243e8704af6dc86b9a4d
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-04-25 09:23:22 +00:00
Eike Ziller
c9696fbabb Merge remote-tracking branch 'origin/10.0'
Change-Id: I8b36c1812b61dbe08fe3e7930f950e6b8e8a7079
2023-04-24 08:52:35 +02:00
Cristian Adam
71eb0ab9f8 CMakePM: Add CMake source file parser
Files taken from the CMake repository https://gitlab.kitware.com/cmake/cmake.git

624461526f4707a2406ebbd40245a605b6bd41fa (tag: v3.26.3)

Change-Id: I9ef388908cd22eb2748b5c17d039848ee23585b9
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-20 11:34:29 +00:00
Leena Miettinen
e441648259 Doc: Replace libSM-dev with libsm-dev
Which is the correct way to write the name of the package.

Fixes: QTCREATORBUG-29031
Change-Id: I860051b8e5f94a800d6f7b448daf02ae01611f9d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-19 07:24:13 +00:00
Tim Jenssen
c04f0e5d9c Increase the minimum macOS version to 10.15
Qt 6.5 doesn't support 10.14 anymore, because it
uses std::filesystem.
QmlDesigner also wants to use std::filesystem.

Change-Id: I36c14c6efa439c9372eb0d8bf90d1024e8b532eb
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2023-04-04 10:12:43 +00:00
Marcus Tillmanns
bd52e53dbf Terminal: Add shell integration
Change-Id: Ic1e226b56f0103e5a6e7764073ab7ab241b67baa
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-16 06:08:09 +00:00
Eike Ziller
c7e94d80c7 Merge remote-tracking branch 'origin/10.0'
Conflicts:
	src/shared/qbs

Change-Id: I33e13270c8c15a51b4ce4eaa6b4584041ed124e0
2023-03-13 12:30:04 +01:00
Leena Miettinen
c7a67ab9e9 Doc: Add Profile to Qbs Build variant field options
Task-number: QTCREATORBUG-28721
Change-Id: Ib05ce93ac4813d35cbe5bdd0e1bccdf24bce172b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-03-09 13:31:32 +00:00
Leena Miettinen
b8ddbde13b Doc: Add link to Qt Learning
Linking to the Getting Started with Qt Creator course directly
does not seem to work.

Change-Id: I4393749e9c66d66340d094c7cb7dc4f4847b8eba
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-03-06 14:49:16 +00:00
Marcus Tillmanns
82194d7e9c Terminal: Add required 3rdparty libraries
Change-Id: Ic477e305f78632f5c454cd639dfc7e41fb643fe1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2023-02-23 14:18:45 +00:00
Leena Miettinen
738819ec71 Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-06 11:09:29 +00:00
Leena Miettinen
ce0f48e0f9 Doc: Replace "contain" with "have" to simplify language
This follows the ComplexWords rule in vale.

Change-Id: Ie5dbb7ac1eff1546dcfbe2bf5da6cc3ed18b7a20
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-03 15:06:17 +00:00
Marcus Tillmanns
eca7044361 Utils: Add std::expected implementation
Adds a std::expected implementation that is compatible with >= C++11.

FilePath::fileContents and FilePath::writeFileContents as well as
FilePath::copyFile are changed to return std::expected.

A couple of macros have been added to aid in using the expected types.

An auto test was added showing how to use the library.

Change-Id: Ibe3aecfc1029a0cf13b45bf5184ff03a04a2393b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2022-12-14 10:39:29 +00:00
Leena Miettinen
cc190110f5 Doc: Add Linux as a supported platform for MCUs
Fixes: QTCREATORBUG-28551
Change-Id: I179e84bef57370f6c7616236aff33a969bc3bb17
Reviewed-by: Timo Aarnipuro <timo.aarnipuro@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2022-12-02 16:17:12 +00:00
Leena Miettinen
b59ad8b0a9 Doc: Use active voice instead of passive voice
This fixes issues found by vale.

Change-Id: Ic3495633cc3aabd000e53b4a4107b9bccde28005
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2022-11-11 09:43:32 +00:00
Leena Miettinen
65cfbc1b6e Doc: Use "remote Linux" instead of "generic remote Linux"
- Reflect the term changes in the UI.
- Move info about SSH port property to the wizard step list.
- Make the topic names in "Deploying to Devices" shorter.
- Remove some unnecessary "if defined(qtdesignstudio)" conditions
  from topics that are not used in the QDS Manual.

Task-number: QTCREATORBUG-27876
Change-Id: I2282257f245c31af82a41ea0e533407bf1cbd775
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2022-11-08 08:31:30 +00:00
Leena Miettinen
5759da754e Doc: Use filename extension of ok.png to fix qdoc warnings
Change-Id: Ic33d9c4e8a3af523e087fc1284cb374e7fd37ec0
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-10-27 14:31:23 +00:00
Leena Miettinen
8aaf60218c Doc: Add alternative terms for "shadow build" to the glossary
Change-Id: I36e160840520778f5ef7012ef72fb1abb967a3c5
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-10-18 06:38:43 +00:00
Leena Miettinen
49378ced3c Doc: Describe Squish plugin
Fixes: QTCREATORBUG-27890
Change-Id: Icc203a96f08c785f016130480c45c988d26ac371
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-10-06 07:07:56 +00:00
Leena Miettinen
65d6c663e3 Doc: Describe the Help > Change Log option
Task-number: QTCREATORBUG-27876
Change-Id: I484070f77695652642c6b2a12a57b2d0ec691708
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-09-30 07:14:43 +00:00
Eike Ziller
04e50438eb Utils: Remove Utils::optional
Since we are now requiring macOS 10.14 we can remove our local
implementation of optional and use std::optional for macOS too.

Change-Id: I2bd018261b68da64f7f031a812045dd7784697e1
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Marco Bubke <marco.bubke@qt.io>
2022-09-01 06:58:04 +00:00
Eike Ziller
fe4e74af75 Adapt attributions to removal of Utils::variant implementation
Amends 84c1d6572b

Change-Id: I6cf02d577babb35537338447e4918776bd3012fd
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Marco Bubke <marco.bubke@qt.io>
2022-08-29 08:21:05 +00:00
Lucie Gérard
a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00
Leena Miettinen
48ebab7c58 Doc: Fix links in the Glossary topic
- "Target Platforms" has been replaced with separate topics
  for "Embedded Platforms" and "Mobile Platforms"
- Linking within the Glossary did not make sense because
  the whole page fits on the screen, so nothing happens when
  clicking the links

Task-number: QTCREATORBUG-27560
Change-Id: I55fe0b98685f67aab7ad0c9a00d28ac744235a9a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-15 06:49:29 +00:00
Leena Miettinen
cc2a79fb2e Doc: Fix reference to "Locals and Expressions" view
They are now two separate views.

Task-number: QTCREATORBUG-27560
Change-Id: Iab659bd915c213d11db08b3a2b8749ebdbc5e70c
Reviewed-by: hjk <hjk@qt.io>
2022-07-14 13:52:57 +00:00
Leena Miettinen
87bdbb993e Doc: Describe adding docker devices
For building and running apps using docker images.

Fixes: QTCREATORBUG-27561
Change-Id: Ice195e73ef8eb321cd53aee5888a9f01ddcf06f8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2022-07-11 08:50:46 +00:00
Leena Miettinen
b5066d71b8 Doc: Replace "Tools > Options" with "Edit > Preferences"
The menu was moved and renamed. The Options dialog was
also renamed "Preferences".

Change-Id: I05d187915382b3ce49699d91304cd447c87e2bd6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-06-28 08:32:44 +00:00
Eike Ziller
3b2134711b Merge remote-tracking branch 'origin/7.0'
Conflicts:
	src/plugins/webassembly/webassemblyrunconfiguration.cpp
	src/tools/processlauncher/launchersockethandler.cpp

Change-Id: Iab052af98013aa59282c16f22ae6e9ecb32f50c4
2022-04-20 16:12:41 +02:00
Leena Miettinen
63aaa65439 Doc: Fix links to Boot2Qt topics
And update information about Boot2Qt requirements.

Fixes: QTCREATORBUG-27251
Change-Id: Ifda686fafcd6b258a2c4dd8102260e05b637335d
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2022-04-13 13:49:42 +00:00
David Schulz
b8caa4f26b Remove UWP support
The UWP support in Qt was removed with Qt 6 and the support in Qt
Creator is basically untested.

Change-Id: I3148efdb596ddd326f590c14c22cc77ded2582a7
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-10 11:29:02 +00:00
Leena Miettinen
09804a65e4 Doc: Do not use the term "Output pane" in docs
When necessary, replace it with "view". When possible,
rephrase to omit the term. Link to descriptions of the
output views.

Update screenshots.

Change-Id: I80ccd12f5a10f221bbea6de994a15ddd07d20842
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-09 15:30:36 +00:00
Leena Miettinen
659d82c499 Doc: Fix broken links when building with Qt 6
Some section titles have changed in Qt 6 and some
platforms and modules are not supported. Where necessary,
use fixed links to Qt 5 docs.

Fixes: QTCREATORBUG-27015
Change-Id: I469a630731f9c37deffe5ca454f5365310aaf713
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-02-28 16:05:01 +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
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
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
Leena Miettinen
daeb6a0eae Doc: Add Catch 2 test to list of supported testing frameworks
Task-number: QTCREATORBUG-26278
Change-Id: Ic42f63c298c4d7f9ca0373b7737f3653599dbe4d
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2021-11-12 12:16:22 +00:00
Leena Miettinen
5b84f409c8 Doc: Fix UI string in docs
Task-number: QTCREATORBUG-26278
Change-Id: I82aa350d869f5f2c71489be177096c86d41af73f
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2021-11-12 07:40:32 +00:00
Leena Miettinen
ef9569f9b1 Doc: Link to Qt Design Studio Manual
Task-number: QTCREATORBUG-26278
Change-Id: Id51e9591a63aceae3bd92c0e12d8e423059efaf0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-11-12 07:40:20 +00:00
Leena Miettinen
b7bae45d12 Doc: Rename "Using Other Build Systems" to "Build Systems"
...now that qmake is not the default anymore, but you can choose
the build system when creating projects.

Change-Id: I52098059e1d32ba2c43c48af7df9dd4c2daff09e
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2021-11-11 08:09:51 +00:00
Eike Ziller
c2e27bd927 Merge remote-tracking branch 'origin/5.0' into 6.0
Change-Id: I436d15f2aeefbf6fc80340f01398509c213fc1b1
2021-11-03 14:26:47 +01:00
Kai Köhne
75b6266694 Document third-party components by their upstream name
Also use a paragraph from the upstream documentation for
third-party code that missed it so far.

Change-Id: I2609d32eafca9810116f7a9ac2df9221541acb15
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-11-02 13:22:51 +00:00
Leena Miettinen
8f98f61ed4 Doc: Update info on developing for Android devices
Task-number: QTCREATORBUG-26312
Change-Id: Ic95a7c6ea4b0ab092a1b1feb07bba3dd368a3584
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2021-11-02 10:41:58 +00:00