Commit Graph

37 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
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
6a74c829df Doc: Extend "Using CMake with Conan" to vcpkg
The automatic setup also works with vcpkg.

Change-Id: I755e59ef0a88105da195e9abe30adca5e3011fae
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-03-12 15:43:23 +00:00
Leena Miettinen
681d2da3b3 Doc: Update info about environment settings
They are now edited in an editor next to the variable list.

Task-number: QTCREATORBUG-30209
Change-Id: I8eb46272a2b4b3b92ebf93247f4ef33ee4114b6f
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-05 15:32:07 +00:00
Leena Miettinen
217b6eae03 Doc: Describe using junction points on Windows
Task-number: QTCREATORBUG-30209
Change-Id: If6692b697e92a6d3fdffaaddc268cab82f50afd4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-03-01 15:11:02 +00:00
Leena Miettinen
a1f317798d Doc: Link to "Add custom output parsers"
...from "CMake Build Configuration"

Task-number: QTCREATORBUG-30209
Change-Id: Ic10125f84eee29ddae05b18d80512fbde530dd2d
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-02-21 08:18:01 +00:00
Leena Miettinen
9d3b154ca8 Doc: Describe new search options
- Restructure the "Finding and Replacing" topic.

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: I107f366d99877a80a0ed8973c9156e46ee0ab312
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-15 13:49:17 +00:00
Eike Ziller
cf63b1884e Merge remote-tracking branch 'origin/12.0'
Conflicts:
	src/libs/utils/treemodel.cpp
	src/libs/utils/treemodel.h

Change-Id: I9c5e8ef77905745c201cfc647218c9e747d268d6
2024-01-08 14:56:54 +01:00
Leena Miettinen
7aa57249b8 Doc: Describe setting CLICOLOR_FORCE to 0
...to disable the ANSI Escape codes support in CMake.

Task-number: QTCREATORBUG-30147
Change-Id: Icbc5fa26652d85bbd89d827914b2c59051c69ab0
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-01-05 15:34:50 +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
266f9bc632 Doc: Turn "Specifying Environment Settings" into how-tos
Add a line drawing that describes the environment settings
hierarchy.

Task-number: QTCREATORBUG-29361
Change-Id: I7869797154c0e70263528a8635ea7f2dcee30f30
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-09 08:23:10 +00:00
Leena Miettinen
8762af4912 Doc: Describe the "Stage for installation" option
...in Projects > Build & Run > Build Settings.

Updated screenshots.

Task-number: QTCREATORBUG-29392
Change-Id: Ieb44b593452e4999c9603ae51148075cb23b6e86
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-10-31 11:05:51 +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
7ae586220d Doc: Update info about CMake presets files
Move the section into a new topic.

Task-number: QTCREATORBUG-28996
Change-Id: Ib0eb8696606b6612bf8c639e7ebeb9123c107146
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-06-15 07:16:26 +00:00
Leena Miettinen
837a779b86 Doc: Describe changes in CMake build settings
- Added `Show advanced options by default` to
  `Edit > Preferences > CMake > Tools`
- Moved `Autorun CMake` to `Edit > Preferences > CMake > General`
- Reorganize the building with CMake topic and add subtitles for
  readability

Task-number: QTCREATORBUG-28721
Change-Id: Id8bab60bc2e148c067ac1eb3669b544d12031078
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-10 09:26:27 +00:00
Leena Miettinen
5fc74d06e0 Doc: Describe Formatter tab in Preferences > CMake
Update screenshots and fix alt text to use {} instead of "".

Task-number: QTCREATORBUG-28721
Change-Id: I9535f099047b36dda2f7a37b181c688e40a534d1
Reviewed-by: Xavier BESSON <developer@xavi-b.fr>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-10 09:26:10 +00:00
Leena Miettinen
d299edfe05 Doc: Add MSVC example for CMake presets using 'external' strategy
... for the architecture and toolset fields.

Task-number: QTCREATORBUG-28721
Change-Id: Ieac6c4bc1553204a1e34ea0ea05028e6e4975adc
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-09 14:40:40 +00:00
Cristian Adam
10bbc7ce33 CMakePM: Add QTC_RUN environment variable for the CMake run
This way one can do certain things knowing that CMake is being run in Qt
Creator.

Change-Id: If3ac8a52f30f9fa73a756212199a25632c757dcd
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2023-02-21 10:08:48 +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
86a24b707d Doc: Add info and examples of using CMake presets
Task-number: QTCREATORBUG-27876
Change-Id: Iaaea164d7a8395d6ddc7580db72790187b719eda
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-10-27 06:44:48 +00:00
Leena Miettinen
85cf6f3365 Doc: Describe Configuration field in CMake build settings
Update screenshots.

Task-number: QTCREATORBUG-27876
Change-Id: Ib0424bef44ac29078a86445da5032011ffc7ff94
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-10-24 12:19:52 +00:00
Leena Miettinen
b4c3431768 Doc: Fix qdoc command \section to \section1
Change-Id: I500a5dc5e84e19e975904cc5d04a465f736dc86b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-10-20 11:43:09 +00:00
Leena Miettinen
31e24208b5 Doc: Describe using CMake presets for configuring and building
Update screenshots.

Task-number: QTCREATORBUG-27876
Change-Id: I62135a0254b730b2cbbad65f5bac7b1594ee454e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-10-18 06:38:57 +00:00
Leena Miettinen
de357a138e Doc: Update docs after CMake preferences were moved to separate category
...from tabs in Build & Run and Kits categories.

Task-number: QTCREATORBUG-27876
Change-Id: I4f808eaaa32fa978e3ef06d0a3f2a9739d8ef726
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-10-14 14:21:40 +00:00
Leena Miettinen
51e31713ff Doc: Describe the Hide/Show Right Sidebar button in build output
Task-number: QTCREATORBUG-27876
Change-Id: Ie0804bccb034d138afd1cca5facbc1bd3cae8cb3
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-10-12 07:15:12 +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
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
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
0c13c1c084 Doc: Describe formatting in CMake Build Settings
Italic text indicates that a value was inherited from
the kit configuration or initial configuration. Red text
indicates mismatches.

Change-Id: Ief30eef1d2667d0b4e570ea439ffb6af681db2b7
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-02-21 16:44:10 +00:00
Leena Miettinen
756a67c563 Doc: Update CMake build settings
- Describe context menu options for syncing configurations
- Describe options for getting help on variables and options

Task-number: QTCREATORBUG-26983
Change-Id: Ide88172bc2e8032434ee657a9995528b6917a871
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-02-11 09:30:40 +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
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files

This is the second step towards making the icons visible in both
dark and light online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 10:44:55 +00:00
Leena Miettinen
a59797afa5 Doc: Update info about using CMake
Update screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I069908acf0cf4cf529460286362b4da579cba8f3
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-11-09 10:44:56 +00:00
Leena Miettinen
20533cc398 Doc: Describe viewing CMake output in Projects mode
Task-number: QTCREATORBUG-25642
Change-Id: I4c9ddf59bae1189e672b1a9a6129970ff3299744
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-06-28 13:52:39 +00:00
Leena Miettinen
67e264b619 Doc: Describe CMake multi-config support
Fixes: QTCREATORBUG-25595
Change-Id: I8b7c5ea64ba150c8bd5e8909c50bbaf716d89118
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-04-16 10:36:40 +00:00
Leena Miettinen
30c5fd6599 Doc: Update info about building with CMake
Reorganize tool-specific information into separate topics.
The other build systems will be added in follow-up commits.

Fixes: QTCREATORBUG-25460
Change-Id: I324f66a464d7ab799e351e77ebe20f29fb091622
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-03-29 06:59:16 +00:00