Commit Graph

21 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
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
ef91b41663 Doc: Remove "Setting Up" from build system reference topic titles
- And split some of them into several topics.
- Combine almost identical topics.
- Put settings values into tables to make them easier to browse.

Task-number: QTCREATORBUG-29361
Change-Id: I2ee5a65848ab3a4643cf5fafe5a654730166aab1
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-12-14 15:38:58 +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
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
097cb17af4 Doc: Replace "Getting Help" with "How To"
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 06:56:53 +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
70f5d18fe9 Doc: Turn Opening Projects into a How-to topic
Describe the ways to open projects before the case where
one needs to re-configure the project.

Task-number: QTCREATORBUG-29361
Change-Id: I32b8676112e412fe8b4f114c54371169f478d361
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-08-31 06:56:15 +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
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
Eike Ziller
cd8c4ced81 Merge remote-tracking branch 'origin/7.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs
	qtcreator_ide_branding.pri

Change-Id: Ic02df53b880d0861d9d9ea0df3e0d381ae99f350
2022-03-11 09:50:48 +01: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
72eba8218d Doc: Describe Meson Parameters build setting
- Edit the build settings topic for grammar and style.
- Update screenshots.

Task-number: QTCREATORBUG-26610
Change-Id: I168a08921457cd62a013c64c3aaffcffb866626d
Reviewed-by: hjk <hjk@qt.io>
2022-03-09 09:12:14 +00:00
Leena Miettinen
b569041709 Doc: Update Meson screenshots
And add alt text for them.

Task-number: QTCREATORBUG-26278
Change-Id: Ibe40f284e3162a77982fc3731313a6f2bc9492b5
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-11-19 08:47:58 +00:00
Leena Miettinen
49c7f21891 Doc: Reorganize info about build settings by build system
Change-Id: Iaee9cc581f76a45cc10c9ae8cba601889320be86
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-03-31 06:53:14 +00:00
Leena Miettinen
ed95b3e6a1 Doc: Add info about IncrediBuild plugin
Fixes: QTCREATORBUG-24217
Change-Id: I3e9023933db508f14139b719eae0191d4615eab7
Reviewed-by: hjk <hjk@qt.io>
2020-08-11 07:53:36 +00:00
Alexis Jeandet
66c3fe931f Meson/Doc: Initial documentation for Meson build plugin
Mostly copied from CMake and adapted to Meson.

qtcreator-kits.png screenshot has been taken on Linux but
https://doc.qt.io/qtcreator/creator-targets.html#specifying-kit-settings
has Windows specific stuff (item 11. "Select the Force UTF-8 MSVC compiler").

Fixes: QTCREATORBUG-24216
Change-Id: Ie6c3c48fea7f1732f010eb10cbb152406e08810c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-06-30 08:11:37 +00:00