Commit Graph

35 Commits

Author SHA1 Message Date
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
6eed65e92a Doc: Update table of supported Qt for MCUs SDKs
Fixes: QTCREATORBUG-28543
Change-Id: I9bc73d24d4077f2b7ec0fbe8e7ab0299b81833a9
Reviewed-by: Sivert Krøvel <sivert.krovel@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2022-12-02 16:17:14 +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
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
e94c0f4a8b Doc: Update supported Qt for MCU SDKs
Task-number: QTCREATORBUG-27560
Change-Id: I26f405a217648b5b44789fd33949b21ba514e2dc
Reviewed-by: Piotr Mućko <piotr.mucko@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-04 11:53:07 +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
Leena Miettinen
8ca2c21087 Doc: Move file about components and properties supported on MCUs
..from Qt Creator to QDS. The Components view is no longer
visible in Qt Creator by default. Moving the file makes it
easier to find its contents during search.

Change-Id: I340d54e990a4e5c09a51b94fe64f3b0e951911ff
Reviewed-by: Aleksei German <aleksei.german@qt.io>
2022-02-28 14:26:51 +00:00
Leena Miettinen
a6c44fdb1c Doc: Remove remaining referrences to Library view
The view was divided into Assets and Components views.

Task-number: QDS-6216
Change-Id: I5a73f60e511bb2936a009bbe6f61004f9d85d348
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2022-02-28 14:26:45 +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
Eike Ziller
d097314873 Split "New File or Project" into "File" and "Project" parts
This was non-standard to begin with, and splitting it makes it
possible to have different designs for New Project and New File dialogs
that are more tailored for the different needs (as is done in
Design Studio)

Change-Id: Ie6246e3c3f3527702c4562ec6f8fcbf5fae6c6ad
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2021-12-02 11:02:35 +00:00
Leena Miettinen
3b2bd641ee Doc: Update info about how MCU support is indicated in Properties view
Strikethrough text is now used instead of square brackets.

Task-number: QDS-4561
Change-Id: I83b7d2e3090c6b69465645c1844ca9a148ebbb4f
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-08-20 09:15:50 +00:00
Leena Miettinen
42141fed26 Doc: Describe "MCU dependencies" option in Kit options
Task-number: QTCREATORBUG-25642
Change-Id: I9b4be0682381dc886487b4c70d8bc9e79d8620b5
Reviewed-by: Erik Verbruggen <erik.verbruggen@me.com>
2021-07-07 13:52:44 +00:00
Christiaan Janssen
27b4383b31 McuSupport: Update documentation
Task-number: QTCREATORBUG-25587
Change-Id: Ida9fb5449818c1c4b78318a6e9d85672153c19ad
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-04-20 14:28:33 +00:00
Eike Ziller
3d1ad9db60 Merge remote-tracking branch 'origin/4.15'
Change-Id: I1d13f3543ab4bb17f0cbfe26bbea3f154f856ca6
2021-04-20 10:42:55 +02:00
Johanna Vanhatapio
f89b1ff497 Doc: Update more info about Library
Task-number: QDS-4007
Change-Id: Iede5ff19c55ea99453ad67b7f1782032779a77af
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-04-16 12:10:34 +00:00
Eike Ziller
5c713d624c Merge remote-tracking branch 'origin/4.15'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs
	qtcreator_ide_branding.pri

Change-Id: I309fe2a4ea7afac85481fc6466a9a6e58e340019
2021-03-18 09:41:37 +01:00
Leena Miettinen
012edb2d77 Doc: Update MCU info
- Use the term "component" instead of QML type
- Update screenshot with the new Library layout
- Link to the new topics for Library and Properties views

Task-number: QDS-3778
Change-Id: I123e3c2050075b17a8944e0d6dc4e6aadc1905a8
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-03-16 11:48:52 +00:00
Christiaan Janssen
b5781e6028 McuSupport: Improvements with version detection
Task-number: QTCREATORBUG-25261
Change-Id: I1b378eb4a4d132b64e4c36e0a0cdafd402570785
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-03-09 08:31:16 +00:00
Venugopal Shivashankar
1f41c53f0f Doc: Update the MCU options dialog screenshot
In addition, document the new option that
enables automatic kit creation for all the
available targets.

Change-Id: Ic9168f032472bdd98b9b026934476e606a9ab94e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-11 13:19:18 +00:00
Leena Miettinen
95685898a5 Doc: Edit info about MCU support and add screenshot
The QML Types tab displays only the supported types, so
that will tell users which types are supported.

Change-Id: I49dd1f7d81401a84b8780fdc61f49870c58c3935
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-20 07:58:44 +00:00
Leena Miettinen
3daf838cc3 Doc: Describe "Get Qt" option in Welcome mode
Update screenshot.

Change-Id: Ia209ba65a27f213c3248d4d2535eac6cebd03774
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-11-19 14:48:24 +00:00
Leena Miettinen
095970a57b Doc: Describe MCU support for types and properties
Fixes: QDS-3072
Change-Id: I3050b706b597d6f9171932c0ab5884b7d8ee094c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-19 10:39:40 +00:00
Venugopal Shivashankar
6d7abca41f Doc: Mention FreeRTOS sources for STM boards
'FreeRTOS Sources' is one of the required
fields if the chosen STM target supports
FreeRTOS.

Change-Id: Ib5074eda31cd73d64aa728751ef24a29957c3624
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-09-03 10:50:11 +00:00
Venugopal Shivashankar
e8eafd85ee Doc: Update the MCU options dialog screenshot
Also, fix the broken link to the Qt for MCUs
supported platforms page.

Change-Id: If0a0702b0821e2e46eca2ad57676c53cb20040e2
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-08-31 11:28:42 +00:00
Venugopal Shivashankar
5ac01be934 Doc: Drop BareMetal from the requirements list
In addition, drop the instructions to enable
or disable a plugin. It is already documented
else where and is less relevant in this
context.

Fixes: QTCREATORBUG-24531
Change-Id: Icd1f46333e1d1f64ff24ab0b2eb1e571d533e5ed
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-08-28 13:37:30 +00:00
Venugopal Shivashankar
3a2f09c1bb Doc: Update the setup instructions
Dropped/moved links to the Qt for MCUs documentation
at some places. This should improve the reading
experience and avoid confusion.

Fixes: UL-2324
Change-Id: Ied18323355884092d9b02a2228bdf8a9e1c4235c
Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-06-29 13:41:47 +00:00
Venugopal Shivashankar
33a91ab099 Doc: Update the MCU options dialog screenshot
In addition, document the option to create and
remove a kit for the chosen SDK.

Change-Id: I90c405d12ad6bc5d369453f70049b4fe9dd03962
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-06-25 09:44:23 +00:00
Venugopal Shivashankar
33c5ff216a Doc: Add a note against the optional subsections
The instructions to add a device or a kit is not
necessary if the SDK is set up already. Creator
handles these automatically and they are not
mandatory to set up the development environment.

Fixes: QTCREATORBUG-23859
Change-Id: I8ea7248f060a84eb29278950c68d020026106061
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-05-29 21:46:15 +00:00
Leena Miettinen
c370d345f1 Doc: Remove obsolete \contentspage command
This prints a QDoc warning when building with QDoc 5.15.

Change-Id: Id6f4646738f3e09956a243dc0da639f5567470f3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-11 08:43:31 +00:00
Venugopal Shivashankar
91f696b3f3 Doc: Fix the new project template's group name
Task-number: QTCREATORBUG-23858
Fixes: QTCREATORBUG-23858
Change-Id: If4493b9c5e3b017097c52797f14f3bc507275e61
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-29 08:33:44 +00:00
Leena Miettinen
0f1d0082aa Doc: Fix path to project wizards
Update screenshot

Task-number: QTCREATORBUG-23364
Change-Id: I3b1c56eed1603fac60f884f4685ce3da8263a4b3
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-04-06 06:41:34 +00:00
Venugopal Shivashankar
704d0eb882 Doc: Update the MCU options screenshot
In addition, replaced the explicit list
of hardware platforms with a link to the
Qt for MCUs documentation.

Task-numger: QTCREATORBUG-23764
Change-Id: I11b7a35a8307e3dbe832a77b43213c5049b73793
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-03-31 07:31:50 +00:00
Leena Miettinen
da5d53b89b Doc: Document the Restart Now button that appears when needed
Typically, when users enable or disable plugins.

Change-Id: I1d9588e662613d6c061756d247bf12f7c1ace4ba
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-26 16:15:21 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00