Commit Graph

55 Commits

Author SHA1 Message Date
Leena Miettinen
becb0af00a Doc: Add more topics to \ingroup creator-how-to-manage-kits
- Add links to the kit management topics from other topics
- Always use \l{Kits} to link to Preferences > Kits
  This has lived a little, as I've changed the category names

Change-Id: Ibcb137824a23bfe7e320a215eb461f689c43db77
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-06-17 14:33:45 +00:00
Leena Miettinen
3cf9f64791 Doc: Update info about connecting Linux-based devices
- The device wizard instructions should not mention USB, as
  USB connections are detected automatically
- The descriptions in the Extension Manager should use
  "network" when both wired and wireless connections are
  supported

Change-Id: I29a7279c413b335280fc5f2fa254e8922ecac5a9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-11 06:06:52 +00:00
Leena Miettinen
f2d4fa794a Doc: Reorganize "Adding Docker Devices"
Task-number: QTCREATORBUG-29361
Change-Id: I1946c4667c4b5c27040988747ba4d25f0a429ed4
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2024-05-27 09:12:46 +00:00
Leena Miettinen
b01a7a18f5 Doc: Reorganize info about developing for QNX Neutrino devices
- Include text from the remote Linux device docs
  (from a separate .qdocinc file)
- Remove the embedded platforms topic as the info is now in the
  overview and How To topics.
- Remove the note about QNX support being experimental.

Task-number: QTCREATORBUG-29361
Change-Id: I5ad807905ead7322900e9cdeb8f7e8660751d265
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Marianne Yrjänä <marianne.yrjana@qt.io>
Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
2024-05-27 09:11:56 +00:00
Leena Miettinen
5b5c61c519 Doc: Restructure info on developing for Boot2Qt devices
- Split the topic into how-to and reference topics
- Remove redundant information
- Make the instructions consistent with the remote Linux topics
- Include info about SSH connections from the remote Linux topic
- Add the \B2Q macro for "Boot to Qt" and use it where possible
  (some UI text still says "Boot2Qt"

Task-number: TCREATORBUG-29361
Change-Id: I7fe5f957049d84ec7402f4c11a070ac2d44fcb38
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
2024-05-16 07:42:09 +00:00
Leena Miettinen
f9b097436b Doc: Restructure info about remote Linux devices
Task-number: QTCREATORBUG-29361
Change-Id: If78cdeb28b0efb522aea871ae9f20e7742afd127
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-05-07 09:22:49 +00:00
Leena Miettinen
74994b435d Doc: Turn "Connecting Bare Metal Devices" into how-tos and reference
Task-number: QTCREATORBUG-29361
Change-Id: Ia0d93029367ae0d24278323d6c36030d1b167177
Reviewed-by: hjk <hjk@qt.io>
2024-05-03 14:25:16 +00:00
Eike Ziller
0f4efacb91 Merge remote-tracking branch 'origin/13.0'
Conflicts:
	doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
	doc/qtcreator/src/qtcreator-toc.qdoc

Change-Id: Ibea5488fda972321c448c64fad7f657e84d62cdb
2024-04-30 14:23:09 +02:00
Leena Miettinen
2275b43cc4 Doc: Update info on Qt for MCUs
Task-number: QTCREATORBUG-29361
Change-Id: I926e09748265ca123fd1a52838da1d05de7f7766
Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>
2024-04-30 11:27:02 +00:00
Eike Ziller
e5640386f8 Merge remote-tracking branch 'origin/13.0'
Conflicts:
	doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc
	src/plugins/projectexplorer/projectexplorer.cpp

Change-Id: I682b330a278a329fc6294baeff6a28040abd10bc
2024-04-22 12:18:10 +02:00
Leena Miettinen
b27be7e2bf Doc: Move deployment info to Reference
Task-number: QTCREATORBUG-29361
Change-Id: Ibabac3192c3f2c1aa7ae5594ed6f5f3a915d774c
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
Reviewed-by: Jarno Lämsä <jarno.lamsa@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
2024-04-19 08:28:09 +00:00
Leena Miettinen
87fb3358d1 Doc: Update info about previewing on Boot2Qt devices
- macOS is supported since Qt 6.5, so just link to the
  Boot2Qt docs.
- Some writing style changes.
- Change the product name macro back to \QC, as the info
  applies to both products.
- Move the link targets for Boot2Qt docs to external-resources.qdoc,
  so that they can be maintained in one place.

Change-Id: Id749dbd58465106108a542db9822080942e12f1b
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-04-18 13:52:51 +00:00
Leena Miettinen
2c21ea8d06 Doc: Add links to "Adding Docker Devices" from relevant topics
The link from "Build for many platforms" I already added as a
part of another change.

Fixes: QTCREATORBUG-30299
Change-Id: I690c8f5755896a7f8c7b8e34ba6b262f6ce96bfd
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-03-22 13:02:33 +00:00
Leena Miettinen
1cf925bc17 Doc: Describe the application manager plugin
Task-number: QTCREATORBUG-30209
Change-Id: Icd40d6da99e7fa53f667745a4de32b03b1157c99
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
2024-03-12 15:43:42 +00:00
Leena Miettinen
c28a388b1f Doc: Turn "Running on Multiple Platforms" into how-to topics
- Update screenshots of kit selector and Devices preferences,
  which now show the device status
- Turn running on QML and Linux into their own topics
- Remove conditions because the projects folder is excluded from
  QDS Manual

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: I869f6b577016c6712c6b37170dbee2249ded1f8e
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-02-19 12:33:24 +00:00
Leena Miettinen
fa17c9b8fa Doc: List Kit preferences under Preferences > Kits
Add "\target kits-tab" for the Kits tab docs because the links need to
be unique.

Task-number: QTCREATORBUG-29361
Change-Id: I76058c521a4e2c08f24ea2f03846bef6eac9716a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-11 09:11:44 +00:00
Leena Miettinen
4d91473c69 Doc: Create a group for supported platforms in Reference
Task-number: QTCREATORBUG-29361
Change-Id: I11f84b97e482c75c157ccec827f5214a9e8d7a7d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-08 13:27:48 +00:00
Leena Miettinen
f708e200f9 Doc: Restructure info about build and run configurations
Task-number: QTCREATORBUG-29361
Change-Id: I9e9d3a3448c327938e4f647b37a88857db5b16c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-12-05 12:30:54 +00:00
Leena Miettinen
1b82616f35 Doc: Describe the "Forward to local display" check box
In the run settings for a remote linux device.

Task-number: QTCREATORBUG-29392
Change-Id: Ib46241b62b4b0208f4f1e52419cc1b2a18e40295
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-26 09:09:34 +00:00
Leena Miettinen
81898c675c Doc: Add a \preferences macro and use it everywhere
The macro can be used to show the path to Preferences
on Windows, Linux, and macOS. The current value expands to:
"Edit (or Qt Creator on macOS) > Preferences".
We can now change this in one place if we so wish.

Task-number: QTCREATORBUG-29734
Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 14:43:29 +00:00
Leena Miettinen
bd38c30759 Doc: Reorganize info on kits
Divide current topics into how-to and reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I0e64b2bbe9d4f6d403815dffe937a567eb9d4844
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-22 06:35:32 +00:00
Tim Jenssen
1a3a8ecc96 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Id242ab4ca485527defdcc1555d204e12e50ddb7a
2023-09-14 17:37:24 +02:00
Leena Miettinen
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Mats Honkamaa
781e9dd5e3 Doc: Unify product naming
Unify naming for Qt Online Installer and Qt Maintenance Tool. Ass macros for theses
as well.

Task-number: QTBUG-116573
Change-Id: I90247956300607b852a17df96aa667bf55805e36
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-09-12 16:22:28 +00:00
Leena Miettinen
50b14b5046 Doc: Replace "Advanced Use" with "Reference"
Will move some topics to how-to topics in a follow-up change.

Task-number: QTCREATORBUG-29361
Change-Id: I7a7475844faafa9dfae9f2f4e3f6940959022c54
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-04 07:14:31 +00:00
Leena Miettinen
22476fc26f Doc: Divide "Creating Projects" into an explanation and how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: I623d824e423da950df9643c42d85b485daccfe4b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-08-28 09:55:57 +00:00
Leena Miettinen
f3b25b1d62 Doc: Describe adding devices without using a wizard
You can select to add a remote Linux, QNX, or Boot2Qt
device in the pull-down menu of the Add button and device
preferences in the Devices tab.

Task-number: QTCREATORBUG-28996
Change-Id: I65836a859e0d14b88768d4f83321ffa8093ed966
Reviewed-by: hjk <hjk@qt.io>
2023-06-09 09:27:41 +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
hjk
699b804181 ProjectExplorer: Rename 'Device' into 'Run device' in Kit settings
Similar for 'Run device type'. Less ambiguity.

Change-Id: Iab88009b92ae760f14140ac8bbdadea51d6dfad4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-05-10 14:55:48 +00:00
Esa Törmänen
ae6c686836 Doc: Add Qt for MCUs macro
Added a new Qt for MCUs macro and modified a number of related topics
accordingly.

Task-number: QDS-9609
Change-Id: I6506a9cb6671c29d5b164d53cb01c827639ecb16
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-04-04 06:39:19 +00:00
Leena Miettinen
dedc3e81fa Doc: Describe connection sharing for Boot2Qt devices
- Some language fixes.
- Use {} instead of "" for \image alt text

Change-Id: I1772c7e98bf40d8ff828205dcf1fd8749d4434cb
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-03-06 10:56:37 +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
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
4ebfd4b6cf Doc: Update instructions for adding B2Qt Devices
Update screenshots to use the dark mode.

Task-number: QTCREATORBUG-27876
Change-Id: I1b6483f76d7f14485ffc13b465e84f378494ea3f
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
2022-10-18 12:27:23 +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
ab10372b09 Doc: Update info on deploying to embedded Linux
- Describe the "Override deployment data from build system" option
- Remove docs for the obsolete "Check for free disk space" deployment
  step
- Move docs for the "Check for a configured device" deployment step to
  QNX topic because it does not appear for other types of devices
- Update screenshots

Task-number: QTCREATORBUG-27560
Change-Id: I3791b8e7021ba2a1e88c2c56d7eb38ef208a9967
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2022-07-13 08:43:56 +00:00
Leena Miettinen
89be4d7d17 Doc: Replace "options" with "preferences"
...when referring to Preferences dialog.

Task-number: QTCREATORBUG-27560
Change-Id: I2f41420b0ec5955d84ad715d239209adddff0529
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 07:30:49 +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
hjk
5dddc42f70 ProjectExplorer: Rename column headers in DeploymentDataView
Local and Remote are not quite right anymore, it's more generic
"Source" now.

Change-Id: I06e8985d4515bfeae3c31c8fcff6bd188916df86
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-06-07 07:40:09 +00:00
Leena Miettinen
5e6c7089d8 Doc: Describe how to declare files in projects
Including using OTHER_FILES for qmake projects.

Fixes: QTCREATORBUG-27157
Change-Id: I802000c90472464430d1335b9e962c6691cc567a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-05-02 11:27:26 +00: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
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
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
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
Leena Miettinen
06f8d860ed Doc: Mention that QNX for Qt 6 is part of Qt for Device Creation
...and the Qt Creator support is considered experimental.

Task-number: QTCREATORBUG-26278
Change-Id: I7d4963605cc18a016c8bb6be412e6774b4fd106d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-25 14:42:47 +00:00
Leena Miettinen
35f0246006 Doc: Update information about adding generic Linux devices
Key Deployment was pulled into a separate dialog.
Update screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I257b225c91a65af4b8794cc0a10ec9045e132ac4
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-25 14:42:35 +00:00
Leena Miettinen
60f2b81773 Doc: Fix method to ignore Boot2Qt for auto-linking
Removed the backslash from \Boot2Qt, and added Boot2Qt in ignorewords
in .qdocconf file. Created explicit links to the Boot2Qt topic in
this manual where needed.

Task-number: QTCREATORBUG-26278
Change-Id: Ieac851f711d7a2cd4d7ae034c3b81ab47c5fbc11
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-23 10:48:46 +00:00
Leena Miettinen
1325be78d9 Doc: Describe Boot2Qt Plugin
- Add connecting to Boot2Qt devices topic
- Move information about deploying to the generic
  embedded Linux devices topic to a Boot2Qt topic

Fixes: QTCREATORBUG-25946
Change-Id: I72f12ceece133f4a4efe303e82d25a3b5e9b9135
Reviewed-by: Rami Potinkara <rami.potinkara@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-07-09 14:36:17 +00:00