Commit Graph

79 Commits

Author SHA1 Message Date
Leena Miettinen
b4ece2e056 Doc: Update topics about reading documentation
- Describe the Open Online Documentation option
- Edit the style
- Use How To: Read Documentation as \sa for all topics in the group

Task-number: QTCREATORBUG-30604
Change-Id: I7219ef9a38e993fc1387dd0ece9c8dfe762387d1
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-24 14:33:51 +00:00
Leena Miettinen
2f2ed24092 Doc: Update info on CMake presets
- Described overriding CMake project settings in CMake presets
  or a CMakeLists.txt.shared file
- Added an example of setting debuggers
- Added an example of cross-compiling and running on the wine emulator

Task-number: QTCREATORBUG-30604
Change-Id: I04f26d98e21b1a1a214de5ab4451ac1e758e489e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-06-21 06:39:36 +00:00
Leena Miettinen
113275118e Doc: Describe overriding values from Preferences > CMake > General
Collect the settings to a table with links to where each setting
is documented.

Task-number: QTCREATORBUG-30604
Change-Id: Ia06076cdd7f51851f58307119716b4ed3cef630e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-06-20 06:44:44 +00:00
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
820e65894d Doc: Update debugger docs
- Make CDB and GDB preference docs more scannable by using tables.
- Describe the "Use debug info daemon" GDB option(update the screenshot).
- Add info about asynchronous GDB command execution.
- Replace "select" with "go to" for menus.
- Update some \sa links.

Change-Id: I029541b0bed284f12d6de7dbb10bbe0de05ac5c9
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-04-23 13:15:41 +00:00
Leena Miettinen
bdada3c5ff Doc: Move Debugging info into "How To" and "Reference"
- Turn "Debugging" into an overview topic
- Remove FSF GDB as it is not supported anymore

Task-number: QTCREATORBUG-29361
Change-Id: I1d8ce78a2f89a85a1337d83aa6011f06afac4e41
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2024-04-19 12:48:39 +00: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
afc8816589 Doc: Restructure the "Analyzing Code" section
- Turn the topics into how-to and reference topics.
- Rewrite "Analyzing Code" as an overview topic.

Task-number: QTCREATORBUG-29361
Change-Id: Id02253514cd1dcd808f040ced7f9f73f6db5e113
Reviewed-by: hjk <hjk@qt.io>
2024-04-15 11:15:01 +00:00
Marcus Tillmanns
dd2942d157 Doc: Improve "Manage files in CMake projects"
Change-Id: I2fa40b005f534bc71789d4fd834307c7dca1b867
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 13:53:00 +00:00
Leena Miettinen
9fa1dbcd3c Doc: Turn "Semantic Highlighting" into how-to topics
And move the general information to the Overview (or the Code
view docs in the QDS Manual).

Task-number: QTCREATORBUG-29361
Change-Id: Ib1d13f3d81d707691c84aa4241ed28662e2bc8ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:37 +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
5a1e5ce058 Doc: Split up "Searching with the Locator"
Hide the locator docs from the QDS Manual because the
locator is not visible in the Code view.

Task-number: QTCREATORBUG-29361
Change-Id: Iecbbaece78b0cd6a496289fd9a00acfdd054d41f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-05 13:37:04 +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
Leena Miettinen
76dcc5463a Doc: Turn Editing MIME Types into a how-to topic
Add subheadings and move content around.

Task-number: QTCREATORBUG-29361
Change-Id: I4c1d8c8c7065a3f306e2a4a341bc546c62828903
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-30 10:44:39 +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
32e6f73119 Doc: Split "Completing Code" into several topics
Task-number: QTCREATORBUG-29361
Change-Id: Icbface3923c3d56ed54d53dc1e614f02269c30b2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-09 11:48:09 +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
ab79d1f970 Doc: Split up "Parsing C++ Files with the Clang Code Model"
Turn "Use compilation databases" into a separate topic.

Task-number: QTCREATORBUG-29361
Change-Id: I022dcd1e0f59293be42b0f953084c63349d5600c
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-01-08 12:09:04 +00: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
3f24752247 Doc: Update info about importing generic projcts
Move the topic from Build Systems to How To: Manage Projects.

Task-number: QTCREATORBUG-29361
Change-Id: Ia91ef716a2907c9ae9296852ca137d3fa1f3e4c1
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-12-20 08:19:22 +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
aa9206ca81 Doc: Describe CMake profiling
Task-number: QTCREATORBUG-29392
Change-Id: I661d6d39148a53daf328b4895d8cd7cabf163d7a
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-02 10:00:19 +00:00
Leena Miettinen
372d19f9f4 Doc: Describe CMake changes
- Divide the "Setting Up CMake" into several how-to topics.
- Rename it as "CMake" and link to all the new topics.
- Update related topics accordingly.

Task-number: QTCREATORBUG-29361
Task-number: QTCREATORBUG-29392
Change-Id: Ib8f4a1951b5ffd7eaa25a4e5cf40e7bb252f9cf4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-01 13:26:19 +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
3078aaadcf Doc: Describe debugging CMake project files over DAP
Task-number: QTCREATORBUG-29392
Change-Id: Iceb7f0d07cae62e14b2e2c52c43aaaca090ad07d
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-10-16 10:55:45 +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
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
39dfc12a9e Doc: Divide "Creating Files" into How-to topics
Task-number: QTCREATORBUG-29361
Change-Id: Ib5e31777ef1649f86525b41bcfbcac52b9dd231e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-08-30 11:26:15 +00:00
Leena Miettinen
d3177b84bc Doc: Describe auto-adjustment of CMake config for Qt Quick projects
..when adding files to projects.

Task-number: QTCREATORBUG-28996
Change-Id: If1de542ce3262227c307e3f479f6f10bf493fa83
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-06-15 11:28:29 +00:00
Leena Miettinen
16bfc82ef0 Doc: Add info about files being added to CMakeLists.txt files
...when using project wizards to add them.

Renamed files are also renamed in CMakeLists.txt and removed
files are removed.

Task-number: QTCREATORBUG-28996
Change-Id: Ia2a3676841ec025c5e947b01144d06980b1b4a8f
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-06-15 07:16:39 +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
b48826f7bf Doc: Fix a broken link to Editing MIME Types
Change-Id: I545ec936b52db08c804f0fe025429dc39ddce978
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-03-15 14:09:56 +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
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
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
642ba31f8b Doc: Describe "Show subfolders inside source group folders"
...in Preferences > CMake.

Task-number: QTCREATORBUG-27876
Change-Id: I0d71e0281413433e6acfdd7023c138c422a8712f
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2022-10-26 08:32:26 +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