Commit Graph

83 Commits

Author SHA1 Message Date
Leena Miettinen
d0e240fd52 Doc: Turn "Pasting and Fetching Code Snippets" into a how-to
Task-number: QTCREATORBUG-29361
Change-Id: I0b2fe3cd2b3d3e3ec2c589ebcbd196832765c4ac
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
2024-03-14 08:56:18 +00:00
Leena Miettinen
87f2e9e190 Doc: Describe launching the debugger from the locator
The "dr" locator filter was added.

Task-number: QTCREATORBUG-30209
Change-Id: I25efd162c7adbff90e0c31c0965c30053ea4a64b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-29 14:44:06 +00:00
hjk
581e6ddf4f Debugger: Require Python 3.5 in the docs
... and make the adapter/mode description a bit simpler.

Change-Id: Ie1b7c6cc26780f38be60c8e51e3bc0bc82db0bc6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-02-28 09:19:48 +00:00
Leena Miettinen
76539a659e Doc: Update the IDE Overview
Use sections instead of a table and move or copy text from
other topics. This is to create a place for information that
becomes homeless when I remove other topics.

Task-number: QTCREATORBUG-29361
Change-Id: Ib3fcc2c345080e05f9f7ad4ed78e049c899e0855
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-19 15:28:14 +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
9fe7922d3b Doc: Remove docs for View > Views > Automatically Hide View Titlebars
Add the name of the removed option to the change log.

Task-number: QTCREATORBUG-30209
Change-Id: Ie526a3097ffec8077d042e919f01bbc348838041
Reviewed-by: hjk <hjk@qt.io>
2024-02-02 16:45:42 +00:00
Leena Miettinen
cc03aff960 Doc: Split up the "Working in Edit Mode topic"
- Make topics shorter and easier to browse
- Move information around
- Delete duplicate how-to topics
- Add \sa links to how-to topics

Task-number: QTCREATORBUG-29361
Change-Id: Ie84a29993129d175bbd65143fcfc45aa8304d621
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-01 10:28:25 +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
158058ca3b Doc: Reorganize the "Designing UIs" section
- Create how-to and reference topics.
- Move the short descriptions of topics to "IDE Overview".

Task-number: QTCREATORBUG-29361
Change-Id: I11a334de6151350ce993e4135828a3eecaabf308
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-05 13:35:43 +00:00
Leena Miettinen
04fb088cf9 Doc: Update GDB Preferences screenshot
"GDB" and "GDB Extended" tabs have been combined into one tab.

Task-number: QTCREATORBUG-29392
Change-Id: I5f5e40399abf20d61cf0e2cd4e4c1f02dfc1404c
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-11-07 16:24:16 +00:00
Leena Miettinen
70ed0aaa82 Doc: Describe using variables in "Default build directory" field
In Preferences > Build & Run > Default Build Properties

Fixes: QTCREATORBUG-29779
Change-Id: Ic893058d081655e21a294b0dcc25ccb0184f4564
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-26 07:37:24 +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
Tim Jenssen
1a3a8ecc96 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Id242ab4ca485527defdcc1555d204e12e50ddb7a
2023-09-14 17:37:24 +02:00
Leena Miettinen
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Mats Honkamaa
781e9dd5e3 Doc: Unify product naming
Unify naming for Qt Online Installer and Qt Maintenance Tool. Ass macros for theses
as well.

Task-number: QTBUG-116573
Change-Id: I90247956300607b852a17df96aa667bf55805e36
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-09-12 16:22:28 +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
4c4719f4d0 Doc: Turn Qt for Python wizard docs into tutorials
Remove the Python instructions from Creating Projects and
turn them into Qt Quick and Qt Widgets tutorials.

Turn the Developing Qt for Python Applications topic into
a How-to.

Change-Id: Ia3b547fbefd5f8e6b67d673b9724cd6e3f0b4424
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-08-28 09:55:01 +00:00
Leena Miettinen
6ed6946d2a Doc: Add links to YouTube videos
Task-number: QTCREATORBUG-28996
Change-Id: Ib829b67f2d91f06e0d567d5c19cad0d37bceb916
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-06-28 06:58:54 +00:00
Leena Miettinen
41c3a4aad6 Doc: Describe the "Default array size" field
In Preferences > Debugger > Locals & Expressions.

Task-number: QTCREATORBUG-28996
Change-Id: I5a54e7a33aa65dc63d91ec0bf977e60e96314a58
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-06-23 13:19:52 +00:00
Leena Miettinen
ff856ed030 Doc: Describe changes in enabling mixed C++/QML debugging
The check boxes are now combo boxes with several options.

Task-number: QTCREATORBUG-28996
Change-Id: Ib3ba3abb5c307b4fecffd267084bb2bd4057add9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-06-21 07:03:10 +00:00
Leena Miettinen
670d36a931 Doc: Don't mention qmake in Qt Quick debugging instructions
The same field is available for both qmake and CMake projects.
Use a screenshot from a CMake project.

Also point to "Preferences > Build & Run > Default Build Properties"
for globally enabling QML debugging and explain what "Use Project Default"
and "Leave at Default" mean.

Fixes: QTCREATORBUG-29089
Change-Id: I3d007d10ca3247dc387eaf21d4d4623d7e90167d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-05-11 07:31:32 +00:00
Leena Miettinen
779a3b126f Doc: Update the Examining Data topic
- Add some basic info
- Move info about Qt objects from Expressions view,
  How-tos, and Debugging Helpers topics
- Add links

Task-number: QTCREATORBUG-28778
Change-Id: I9ef5fbaef610e7a183a8d903d73e0e052c3e7177
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-31 06:58:33 +00:00
Leena Miettinen
df53b7c9b7 Doc: Add docs for Peripheral Registers view in Debug mode
Task-number: QTCREATORBUG-28778
Change-Id: I17b66417c943c08295a8e7fb9936e5f8d28b9263
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-28 14:19:39 +00:00
Leena Miettinen
faf8f91b65 Doc: Update the docs for the Expressions view in Debug mode
Task-number: QTCREATORBUG-28778
Change-Id: I687fb1bb2ecf6dbc511bffc70a6f9ac00aee6ee9
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-28 10:48:18 +00:00
Leena Miettinen
094b5294f6 Doc: Edit docs for Debug mode Disassembler and Debugger Log views
Task-number: QTCREATORBUG-28778
Change-Id: I66ea94881dc1ce3fa8d8fbe3bdd4b59504330738
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-27 07:29:40 +00:00
Leena Miettinen
1b2f1ac0f9 Doc: Edit Registers view docs
Task-number: QTCREATORBUG-28778
Change-Id: I30f24e7c192332611f9e7d14ec5541b6adccb9a5
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-27 07:29:33 +00:00
Leena Miettinen
31ea42eb54 Doc: Describe Threads, Modules, and Source Files debugger views
Add screenshots and more information about the views.

Task-number: QTCREATORBUG-28778
Change-Id: I385c1f6dd5eeed20d122bed2d9420b32b9a3d70b
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-03-24 07:24:26 +00:00
Leena Miettinen
7babb9677d Doc: Update debugger topics
- Add info about PDB
- Edit info about setting up debuggers and add (existing)
  screenshots
- Update info about Add Breakpoints view
- Move some text around

Task-number: QTCREATORBUG-28778
Change-Id: Ice3813ef2d4b143ed1f9d246aa6c029829dee60f
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-23 12:31:09 +00:00
Leena Miettinen
476c072b00 Doc: Add table of debugger toolbar icons and their purpose
Task-number: QTCREATORBUG-28778
Change-Id: Ic7c88862bc28e9680fb103a1d8663baedc28df79
Reviewed-by: hjk <hjk@qt.io>
2023-03-06 08:20:38 +00:00
Leena Miettinen
ce2d773510 Doc: Remove obsolete \include commands
The information was moved to the Expressions view docs.

Change-Id: I8e98e9de57412792746727f521253e85ecff9930
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2023-02-20 15:50:39 +00:00
Leena Miettinen
1e6933f48d Doc: Reorganize the Debugger topic
Divide the long topics into shorter ones and reorganize the
information.

The next step will be to improve the current topics: check that
the information is complete, add screenshots for all views, add
links between related topics, and so on.

Task-number: QTCREATORBUG-28778
Change-Id: I3549289a2be512bb09f45c91f85b12f89cedbe97
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2023-02-13 14:37:39 +00:00
Leena Miettinen
8512aba9eb Doc: Add a short overview of what debuggers do
Change-Id: I07062ea6e046ce51a9d3091e9d86071415706e6c
Reviewed-by: hjk <hjk@qt.io>
2023-02-07 09:54:10 +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
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
hjk
2b97f69796 Debugger: Merge GDB and GDB Extended option pages
Change-Id: I0d4c041cec9ea01e1310f08a4ee87ed8080976bd
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-12-20 13:26:09 +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
Leena Miettinen
d44a62d588 Doc: Describe "rettype" in "putCallItem" Dumper class
Not all Dumper class members are described, so remove or modify the
leading sentences before lists of members. Add a reference to
dumper.py.

Fixes: QTCREATORBUG-28404
Change-Id: Ib681c44f8ff952d2f2ac0a37a5daf12b4b2486d6
Reviewed-by: hjk <hjk@qt.io>
2022-11-14 10:07:58 +00:00
Leena Miettinen
f57ec09ee8 Doc: Add debugger troubleshooting information
From https://wiki.qt.io/Qt_Creator_Windows_Debugging

Task-number: QTCREATORBUG-27876
Change-Id: I36b19311387a93f729aea1bbc28db125e1d1230c
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2022-11-08 08:32:28 +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
bddac59a95 Doc: Fix arguments to start debugging Qt Quick applications
A dash was missing.

Fixes: QTCREATORBUG-28093
Change-Id: Ic7fbf8fda8d23fdc1eabf98b53240824a24aacc5
Reviewed-by: hjk <hjk@qt.io>
2022-08-23 07:14:22 +00:00
David Schulz
95a278760a Doc: update remote CDB setup instructions
Mention the dependencies of the cdbextension and instruct to copy the
full folder instead of just the dll.

Fixes: QTCREATORBUG-27914
Change-Id: If14d331af66437bc8723fc16fc72354cccd4e0d6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-08-22 18:13:48 +00:00
Leena Miettinen
d6cdce0de5 Doc: Update info about debugging
- Update screenshots
- Fix option names
- Show existing screenshots in more places (where they are
  discussed in text)

Task-number: QTCREATORBUG-27560
Change-Id: I16a45e5e05b8b50932431844e36851f693966201
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2022-07-13 07:26:07 +00:00
Leena Miettinen
226abd4de7 Doc: Do not use comma before "because"
Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 10:39:52 +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
Marcus Tillmanns
1e70973c32 qml-debug-doc: Inform the user that breakpoints are only available in block mode
Setting / triggering breakpoints is only possible
if the target application was started with the
"block" argument.

Fixes: QTCREATORBUG-27515
Change-Id: Idafdaa87c38c8c452771897d4d845c4398d55fc4
Reviewed-by: hjk <hjk@qt.io>
2022-06-17 08:37:58 +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