Commit Graph

22 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
9ee39e5141 Doc: Describe how to add optimized self-built Qt
Fixes: QTCREATORBUG-30841
Change-Id: Id5c2fe0fcf925812b9abc8d8f53557aeeb917e32
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-06-12 08:27:07 +00:00
Leena Miettinen
1218175c78 Doc: Write "toolchain" as one word
We still have some occurrences in the UI where it is written as
two words, though.

Change-Id: I245e4185c8ede4313bbe64641f38a3850fa8cbeb
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-05-07 09:25:16 +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
Leena Miettinen
f6c3318e94 Doc: Turn "Running on Multiple Platforms" into how-to topics
And hide it from the top level TOC in the manual.
Link to "How To: Build with CMake" from CMake topics.

Task-number: QTCREATORBUG-29361
Change-Id: If0522cdd9636ac075e8bdeafa0fc7248199aaf2a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-14 08:56:36 +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
40fae907ba Doc: Update Bare Metal docs
- Describe "Peripheral description file" option
- Update screenshots

Task-number: QTCREATORBUG-29392
Change-Id: I2d2881a13447dd2f14ac13f3b61cb3306b0e7f30
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-11-07 16:24:02 +00:00
Leena Miettinen
022847c852 Doc: Make the instructions for enabling plugins more consistent
- Add the following for documented plugins that are
  disabled by default: \note Enable the <name> plugin to use it
- Add \sa {Enable and disable plugins} for the above plugins and
  describe there how to find the About Plugins dialog on macOS
- For the one occurrence in the QDS Manual, add instructions for
  finding the About Plugins dialog on macOS ("Enable and disable plugins"
  is not included in the QDS Manual
- Mostly remove other kinds of references to enabling plugins

Task-number: QTCREATORBUG-29734
Change-Id: I7b12bd651c1c99e0c6b3ca6f94d3831ebe038438
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-27 06:59:11 +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
Leena Miettinen
447f8b80c3 Doc: Remove double words and fix a typo
For example, "and and", "the the", "or or"...

Change-Id: Ie5795efb857e674c5a584e97a60bcb9b2ba869d2
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-07 07:23:13 +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
be1aa6abed Doc: Fix typos
Change-Id: I22b610a6dcab73867f915f877d7b7b844da5dc22
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-11-16 10:39:24 +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
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
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
Leena Miettinen
de5858a5a8 Doc: Update information about developing for Bare Metal devices
Change-Id: I6bfbf01c5204f3bcf53375d84cb4604f91c0c7a2
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-08-21 14:34:01 +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
Leena Miettinen
da1e153f3d Doc: Update info about Bare Metal devices
Fixes: QTCREATORBUG-23723
Change-Id: Ic7289849bab5901cf9860067f1d127e69617a328
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: hjk <hjk@qt.io>
2020-03-24 12:35:09 +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