Commit Graph

79 Commits

Author SHA1 Message Date
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
hjk
a8092c9708 Doc: Add a hint on what to do when stuck with older CMake versions
Change-Id: Ia68b0ae94f69eca8fd674d7537f35af1b0f685bb
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-02-08 08:58:17 +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
fd6380f935 Doc: Describe deploying apps to embedded Linux devices
- Describe deployment process in the instructions for generic
  remote Linux devices and link to there from the instructions
  for specific devices.
- Update instructions for adding files when using CMake and remove
  the include file.
- Add an example of adding files to deploy when using qmake.

Fixes: QTCREATORBUG-26616
Change-Id: I07cf9169da384dd65adc6935110e4dcbeb3e308b
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
2022-01-14 07:31:34 +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
1ae5787e38 Doc: Remove docs for Auto-create build directories CMake option
The option was removed, so removed also the docs and updated the
screenshot.

Task-number: QTCREATORBUG-25642
Change-Id: I61b3e01ad0b620bc7d2661a7a76deb53c7ffa238
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-06-28 06:47:17 +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
Leena Miettinen
2fe99cef9f Doc: Describe new actions on CMake parameters
Multi-selection of parameters is now enabled, as well as
clearing the selection, unsetting multiple parameters at
a go, and undoing the unsetting.

Task-number: QTCREATORBUG-24529
Change-Id: Ie87e6e5bf081fd6d70e3a9461ca8489fb3a71589
Reviewed-by: hjk <hjk@qt.io>
2020-10-09 14:42:58 +00:00
Leena Miettinen
6d897b67dd Doc: Update info about CMake support
Fixes: QTCREATORBUG-24497
Change-Id: I524907e461ba91b18a6741690bef9ed27a40fb5f
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-08-19 06:52:51 +00:00
Alexis Jeandet
2caedc7134 CMake/Doc: fix small typo in link
Change-Id: I1dcefbe25bff1faedf77175770ee7e2521101924
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-06-26 15:49:53 +00:00
Eike Ziller
aa2aa9bf2a Merge remote-tracking branch 'origin/4.12'
Change-Id: Id1c063ae716c3acf5e6201c15663637040aa9a35
2020-06-03 12:22:18 +02:00
Leena Miettinen
6c9d8e619f Doc: Improve usage of terminology related to embedded devices
Make a distinction between "Boot2Qt" and "generic remote Linux"
devices. Use "embedded devices" as a more general term.

Change-Id: Ice06e6737d6baca001a2a13a6cec7be7624dff2e
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-05-27 10:49:40 +00:00
Eike Ziller
20ef5c6de3 Merge remote-tracking branch 'origin/4.12'
Change-Id: Ibbf9f16677a58bdcdd3ce63701ffa34db6f44916
2020-05-11 11:36:22 +02: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
Tobias Hunger
494b9f5287 CMake: Remove servermode support
Task-number: QTCREATORBUG-23915
Change-Id: I2a58e1d6d95c28e25787722fa37448d86c4aebc9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-04-29 14:30:16 +00:00
Tobias Hunger
283763a3e2 CMake: Update documentation to require CMake 3.7 or later
Tealeaf mode has been removed, so update the documentation accordingly.

Change-Id: Ibecc2f127f3acb5d6813e4f670c3424db633cacb
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-04-22 11:59:30 +00:00
Leena Miettinen
9bf8610935 Doc: Update info on automatically registering CMake help
Change-Id: Icdc010102055def6b87902c0c924f647f1f408da
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-03-24 08:11:10 +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