feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Replace "Advanced Use" with "Reference"

Browse Source 
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>
This commit is contained in:
Leena Miettinen
2023-08-31 14:13:57 +02:00
parent 2480189c5b
commit 50b14b5046
23 changed files with 158 additions and 320 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
View File

@@ -8,12 +8,16 @@
// **********************************************************************
/*!
\previouspage creator-project-other.html
\page creator-project-cmake.html
\nextpage creator-project-qbs.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up CMake
\brief CMake is an alternative to qmake for automating the generation of
build systems.
CMake automates the configuration of build systems. It controls the software
compilation process by using simple
configuration files, called \c {CMakeLists.txt} files. CMake generates
@@ -212,12 +216,6 @@
Syntax completion and highlighting work once your project successfully
builds and links against the external library.
\section1 Related Topics
\list
\li \l {Open projects}
\li \l {CMake Build Configuration}
\li \l {Specifying Run Settings}
\li \l {Deploying to Remote Linux}
\endlist
\sa {Open projects}, {CMake Build Configuration}, {Specifying Run Settings},
{Deploying to Remote Linux}
*/

7
doc/qtcreator/src/conan/creator-projects-conan.qdoc
View File

@@ -3,11 +3,14 @@
/*!
\page creator-project-conan.html
\previouspage creator-project-incredibuild.html
\nextpage creator-vcpkg.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up Conan
\brief The experimental Conan plugin integrates the Conan package manager.
\l {https://conan.io}{Conan} is a C/C++ package manager that speeds up the
integration of C or C++ libraries into your own project. It's available on
all the \l{Supported Platforms}{supported development platforms}.

2
doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
View File

@@ -390,7 +390,7 @@
\endlist
For more information, see \l{Using Command Line Options}.
For more information, see \l{Command Line Options}.
*/
/*!

5
doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc
View File

@@ -13,14 +13,15 @@
\previouspage creator-project-managing-sessions.html
\nextpage studio-projects.html
\else
\previouspage creator-cli.html
\nextpage creator-editor-external.html
\previouspage creator-reference.html
\endif
\ingroup creator-reference
\title Keyboard Shortcuts
\brief Default keyboard shortcuts.
\QC has various keyboard shortcuts that speed up your development process.
To view all \QC functions in and their keyboard shortcuts, select
\uicontrol Edit > \uicontrol Preferences > \uicontrol Environment >

55
doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -8,58 +8,20 @@
// **********************************************************************
/*!
\previouspage creator-vcpkg.html
\page creator-cli.html
\nextpage creator-keyboard-shortcuts.html
\previouspage creator-reference.html
\title Using Command Line Options
\ingroup creator-reference
You can start \QC and specify some options from the command line. For
example, you can open a file to any line and column.
\title Command Line Options
\brief Options for starting \QC from the command line.
To specify command line options, enter the following command in the \QC
installation or build directory:
\c {qtcreator [option] [filename[:line_number[:column_number]]]}
\note You can use either a colon (:) or a plus sign (+) as a separator
between the filename and line number and the line number and the column
number. You can also use a space between the separator and the line number.
For example, on Windows:
\list
\li \c {C:\qtcreator\bin>qtcreator -help}
\li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100:2}
\li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100+2}
\endlist
On \macos:
\list
\li \c {Qt\ Creator.app/Contents/MacOS/Qt\ Creator -help}
\endlist
To open a project that is located in a particular folder, you can pass on
the folder name as a command line argument. \QC looks for a session that
matches the folder name and loads it. Or it looks for a project file in the
folder and opens it. For example:
\c {qtcreator .}
\note To run a self-built \QC from the command line on Windows, make sure
that the Qt installation directory is included in the PATH environment
variable. You can enter the following command on the command line to add Qt
to the path:
\code
set PATH=<Qt_installation_directory>\mingw\bin;c:<Qt_installation_directory>\bin;%PATH%
\badcode
qtcreator [option] [filename[:line_number[:column_number]]]
\endcode
The following table summarizes the available options:
@@ -262,4 +224,5 @@
You can also switch to a dark theme to customize the appearance of widgets,
colors, and icons without using stylesheets.
\sa {Run Qt Creator from the command line}
*/

11
doc/qtcreator/src/howto/creator-only/creator-vcpkg.qdoc
View File

@@ -3,13 +3,16 @@
/*!
\page creator-vcpkg.html
\previouspage creator-project-conan.html
\nextpage creator-cli.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Managing Packages with vcpkg
The experimental vcpkg plugin integrates the \l {https://vcpkg.io/en/}{vcpkg}
C/C++ package manager into \QC. It's available on all the
\brief The experimental vcpkg plugin integrates the vcpkg C/C++ package
manager into \QC.
\l {https://vcpkg.io/en/}{vcpkg} is available on all the
\l{Supported Platforms}{supported development platforms}.
You can use \QC to create and edit vcpkg.json files to specify packages to

2
doc/qtcreator/src/howto/creator-sessions.qdoc
View File

@@ -96,7 +96,7 @@
When you start \QC from the command line, you can give the name of
a session as an argument and \QC will start with this session.
For more information, see \l{Using Command Line Options}.
For more information, see \l{Command Line Options}.
\endif
*/

9
doc/qtcreator/src/incredibuild/creator-projects-incredibuild.qdoc
View File

@@ -1,13 +1,16 @@
// Copyright (C) 2020 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-project-meson.html
\page creator-project-incredibuild.html
\nextpage creator-project-conan.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up IncrediBuild
\brief IncrediBuild decreases the time it takes to build C++ code.
\l{https://www.incredibuild.com/}{IncrediBuild} accelerates process
execution and thus shortens the time you spend on building C++ code.
In addition, you can view the build progress in the graphical Build

9
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -3,11 +3,14 @@
/*!
\page creator-embedded-platforms.html
\previouspage creator-desktop-platforms.html
\nextpage creator-mobile-platforms.html
\previouspage creator-reference.html
\ingroup creator-reference
\title Embedded Platforms
\brief Embedded platforms that you can develop applications for.
You can develop applications for the following embedded platforms:
\list
@@ -110,4 +113,6 @@
\li \l{Running on QNX Devices}
\li \l{Qt for QNX}
\endlist
\sa {Supported Platforms}
*/

22
doc/qtcreator/src/meson/creator-projects-meson.qdoc
View File

@@ -1,21 +1,23 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-project-nimble.html
\page creator-project-meson.html
\nextpage creator-project-incredibuild.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up Meson
\brief Use Meson to build native desktop applications.
\l{https://mesonbuild.com/}{Meson} is an open source and multi-platform build
system generator using Ninja as main backend. Build definitions are located
in \c {meson.build} files while build options are located in
\c {meson_options.txt}.
Meson build support in \QC is not mature yet, you can only use it to build
native desktop applications. Many features available with Meson build or
usually available from \QC are missing.
\note Many features available with Meson build or usually available from \QC
are missing.
\QC automatically detects the Meson and Ninja executables specified in the
\c PATH. You can add paths to other Meson or Ninja executables and use them
@@ -84,11 +86,5 @@
\li Adding files to Meson projects from \QC.
\endlist
\section1 Related Topics
\list
\li \l {Open projects}
\li \l {Meson Build Configuration}
\li \l {Specifying Run Settings}
\endlist
\sa {Open projects}, {Meson Build Configuration}, {Specifying Run Settings}
*/

88
doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc
View File

@@ -1,88 +0,0 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-squish.html
\page creator-advanced.html
\nextpage creator-os-supported-platforms.html
\title Advanced Use
\image front-advanced.png
\QC attempts to meet your development needs, whether you are an
experienced Qt developer or a newcomer to Qt. When you install \QC
as a part of \QSDK, the default configuration allows you to start coding,
building, running and debugging applications with very little effort.
However, you can easily change or extend the default configuration, by
choosing a different build system or integrating external tools.
You can also use special options to start \QC from the command line and use
it mainly from the keyboard.
\list
\li \l{Supported Platforms}
You can install and run \QC on several operating systems to create
applications for multiple desktop and \l{glossary-device}{device}
platforms.
\li \l{Build Systems}
\QC is integrated with cross-platform systems for build automation:
qmake, Qbs, CMake, and Autotools. In addition, you can import
generic projects that do not use those systems, and specify that \QC
ignores your build system.
\li \l{Using Command Line Options}
You can start \QC and specify some options for running it from the
command line.
\li \l{Keyboard Shortcuts}
\QC has keyboard shortcuts that speed up your development
process. You can change the keyboard shortcuts, as well as import
and export keyboard shortcut mapping schemes.
\li \l{Using External Tools}
You can use external tools directly from \QC. Qt Linguist,
QML utilities, the default text editor for your system, and the
\c sort tool are preconfigured for use. You can change their default
configurations and configure new tools.
\endlist
\section1 Related Topics
\list
\li \l{Showing Task List Files in Issues}
You can load report files created by code scanning and analysis
tools to \l Issues. You can navigate to the corresponding source
code by clicking the error message or by using keyboard shortcuts.
\li \l{Inspecting Internal Logs}
You can inspect internal log messages of \QC. They may be
helpful when developing \QC or investigating problems.
\li \l{Managing Data Collection}
If you agreed to pseudonymous data collection during \QC
installation, you can turn it on and determine what type
of data is collected and transmitted to the backend storage.
\endlist
*/

10
doc/qtcreator/src/overview/creator-only/creator-desktop-platforms.qdoc
View File

@@ -3,11 +3,15 @@
/*!
\page creator-desktop-platforms.html
\previouspage creator-os-supported-platforms.html
\nextpage creator-embedded-platforms.html
\previouspage creator-reference.html
\ingroup creator-reference
\title Desktop Platforms
\brief Requirements for operating systems that you can install and run \QC
on.
\QC is available in binary packages for the following operating systems:
\list
@@ -66,4 +70,6 @@
To build \QC from the source, see the requirements and instructions in the
readme file that is located in the source repository.
\sa {Supported Platforms}
*/

8
doc/qtcreator/src/overview/creator-only/creator-mobile-platforms.qdoc
View File

@@ -3,11 +3,14 @@
/*!
\page creator-mobile-platforms.html
\previouspage creator-embedded-platforms.html
\nextpage creator-project-other.html
\previouspage creator-reference.html
\ingroup creator-reference
\title Mobile Platforms
\brief Mobile platforms that you can develop applications for.
You can develop applications for the following mobile platforms:
\list
@@ -60,4 +63,5 @@
\li \l{Qt for iOS}
\endlist
\sa {Supported Platforms}
*/

9
doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
View File

@@ -10,6 +10,15 @@
\annotatedlist creator-reference
\section1 Build Systems
Most \QC project wizards enable you to choose the build system to use for
building the project: qmake, CMake, Meson, or Qbs. qmake is installed and
configured when you install Qt. To use one of the other supported build
systems, you need to set it up.
\annotatedlist creator-reference-build-systems
\section1 Sidebar Views
\annotatedlist creator-reference-sidebar-views

18
doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc
View File

@@ -1,13 +1,17 @@
// Copyright (C) 2020 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-advanced.html
\page creator-os-supported-platforms.html
\nextpage creator-desktop-platforms.html
\previouspage creator-reference.html
\ingroup creator-reference
\title Supported Platforms
\brief Summary of development and target platforms.
You can install and run \QC on several operating systems to create
applications for multiple desktop, embedded, and mobile device platforms,
as well as web browsers (experimental).
@@ -72,11 +76,5 @@
specified in \uicontrol Edit > \uicontrol Preferences \uicontrol Environment >
\uicontrol Update.
For more information on the requirements for each platform, see:
\list
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\sa {Desktop Platforms}, {Embedded Platforms}, {Mobile Platforms}
*/

10
doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc
View File

@@ -1,13 +1,17 @@
// Copyright (C) 2018 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-project-qbs.html
\page creator-projects-autotools.html
\nextpage creator-project-generic.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up an Autotools Project
\brief \QC can open projects that use the Autotools build system. You can
build and run the projects directly from \QC.
The AutotoolsProjectManager is a plugin for autotools support. It is
disabled by default. To enable the plugin, select \uicontrol Help >
\uicontrol {About Plugins} > \uicontrol {Build Systems} >

2
doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc
View File

@@ -146,7 +146,7 @@
/global/genericfilewizard.png" not found.
\endcode
See \l{Using Command Line Options} for more information about command line
See \l{Command Line Options} for more information about command line
arguments.
\include creator-projects-custom-wizards-json.qdocinc json wizards

10
doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc
View File

@@ -8,12 +8,18 @@
// **********************************************************************
/*!
\previouspage creator-projects-autotools.html
\page creator-project-generic.html
\nextpage creator-project-nimble.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up a Generic Project
\brief \QC supports generic projects, so you can import existing projects
that do not use qmake or CMake. This enables you to use \QC as a
code editor and to fully control the steps and commands used to
build the project.
Generic project support allows you to use \QC as a code editor. You
can change the way your project is built by modifying the \c make command
in the \uicontrol{Projects} mode under \uicontrol{Build Settings}.

8
doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc
View File

@@ -2,12 +2,16 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-project-generic.html
\page creator-project-nimble.html
\nextpage creator-project-meson.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up Nimble
\brief The Nimble package manager generates Nim application
executables that are supported on Windows, Linux, and \macos.
\l {https://github.com/nim-lang/nimble#readme}{Nimble} is a package
manager for the Nim programming language. It is delivered with
\l{https://nim-lang.org/}{Nim} and uses the Nim compiler to generate

78
doc/qtcreator/src/projects/creator-only/creator-projects-other.qdoc
View File

@@ -1,78 +0,0 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-os-supported-platforms.html
\page creator-project-other.html
\nextpage creator-project-cmake.html
\title Build Systems
Most \QC project wizards enable you to choose the build system to use for
building the project: qmake, CMake, Meson, or Qbs. qmake is installed and
configured when you install Qt. To use one of the other supported build
systems, you need to set it up, as described in the following sections:
\list
\li \l{Setting Up CMake}
CMake is an alternative to qmake for automating the generation of
build configurations.
\li \l{Setting Up Qbs}
\l{Qbs Manual}{Qbs} is an all-in-one build
tool that generates a build graph from a high-level project
description (like qmake or CMake do) and executes the commands in
the low-level build graph (like make does).
\li \l{Setting Up an Autotools Project}
\QC can open projects that use the Autotools build system. You can
build and run the projects directly from \QC.
\li \l{Setting Up a Generic Project}
\QC supports generic projects, so you can import existing projects
that do not use qmake or CMake. This enables you to use \QC as a
code editor and to fully control the steps and commands used to
build the project.
\li \l{Setting Up Nimble}
The experimental \l{https://nim-lang.org/}{Nim} plugin integrates
the Nimble package manager for generating Nim application
executables that are supported on Windows, Linux, and \macos.
\li \l{Setting Up Meson}
Meson is an open source build system meant to be both extremely fast,
and, even more importantly, as user friendly as possible.
\li \l{Setting Up IncrediBuild}
IncrediBuild decreases the time it takes to build C++ code.
\li \l{Setting Up Conan}
The experimental Conan plugin integrates the Conan package manager
that speeds up the integration of C or C++ libraries into your
project. You can use Conan with most build systems integrated into
\QC.
\li \l{Managing Packages with vcpkg}
The experimental vcpkg plugin integrates the
\l {https://vcpkg.io/en/}{vcpkg} C/C++ package manager into \QC.
Create and edit vcpkg.json files to specify packages to build as
part of your project when using CMake as the build system.
\endlist
*/

11
doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc
View File

@@ -1,13 +1,18 @@
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-project-cmake.html
\page creator-project-qbs.html
\nextpage creator-projects-autotools.html
\previouspage creator-reference.html
\ingroup creator-reference-build-systems
\title Setting Up Qbs
\brief \l{Qbs Manual}{Qbs} is an all-in-one build tool that generates a build
graph from a high-level project description (like qmake or CMake do) and
executes the commands in the low-level build graph (like make does).
To use Qbs to build a project, you must create a .qbs file for the project.
You can use \QC to create a C or C++ project that is built with Qbs.
For more information about Qbs, see

66
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -197,36 +197,6 @@
\li \l{Running Autotests}
\li \l{Using Squish}
\endlist
\li \l{Advanced Use}
\list
\li \l{Supported Platforms}
\list
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\li \l{Build Systems}
\list
\li \l{Setting Up CMake}
\li \l{Setting Up Qbs}
\li \l{Setting Up an Autotools Project}
\li \l{Setting Up a Generic Project}
\li \l{Setting Up Nimble}
\li \l{Setting Up Meson}
\li \l{Setting Up IncrediBuild}
\li \l{Setting Up Conan}
\li \l{Managing Packages with vcpkg}
\endlist
\li \l{Using Command Line Options}
\li \l{Keyboard Shortcuts}
\li \l{Using External Tools}
\li \l{Showing Task List Files in Issues}
\li \l{Inspecting Internal Logs}
\li \l{Managing Data Collection}
\list
\li \l {Collecting Usage Statistics}
\endlist
\endlist
\li \l{Getting Help}
\list
\li \l{Using the Help Mode}
@@ -286,15 +256,46 @@
\endlist
\li Use \QC
\list
\li \l {Collect usage statistics}
\li \l {Enable and disable plugins}
\li \l {Find settings files}
\li \l {Inspect internal logs}
\li \l {Install plugins}
\li \l {Manage data collection}
\li \l {Run \QC from the command line}
\li \l {Use external text editors}
\li \l {Use external tools}
\li \l {Use Qt Linguist}
\endlist
\endlist
\li \l{Known Issues}
\li \l{Glossary}
\li \l{Technical Support}
\li \l{Acknowledgements}
\endlist
\li \l{Reference}
\list
\li \l {Build Systems}
\list
\li \l{Managing Packages with vcpkg}
\li \l{Setting Up CMake}
\li \l{Setting Up Conan}
\li \l{Setting Up IncrediBuild}
\li \l{Setting Up Nimble}
\li \l{Setting Up Meson}
\li \l{Setting Up Qbs}
\li \l{Setting Up a Generic Project}
\li \l{Setting Up an Autotools Project}
\endlist
\li \l {Command Line Options}
\li \l {Custom Wizards}
\li \l {Keyboard Shortcuts}
\li \l {Supported Platforms}
\list
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\li Sidebar Views
\list
\li \l {Call Hierarchy}
@@ -315,10 +316,5 @@
\li \l {To-Do Entries}
\endlist
\endlist
\li \l{Known Issues}
\li \l{Glossary}
\li \l{Technical Support}
\li \l{Acknowledgements}
\endlist
\endlist
*/

20
doc/qtcreator/src/qtcreator.qdoc
View File

@@ -73,8 +73,8 @@
\row
\li \inlineimage front-preview.png
\li \inlineimage front-testing.png
\li \inlineimage front-advanced.png
\li \inlineimage front-help.png
\li \inlineimage front-advanced.png
\row
\li \b {\l{Building and Running}}
\list
@@ -91,23 +91,23 @@
\li \l{Running Autotests}
\li \l{Using Squish}
\endlist
\li \b {\l{Advanced Use}}
\list
\li \l{Supported Platforms}
\li \l{Build Systems}
\li \l{Using Command Line Options}
\li \l{Keyboard Shortcuts}
\li \l{Using External Tools}
\endlist
\li \b {\l{Getting Help}}
\list
\li \l{Using the Help Mode}
\li \l{FAQ}
\li \l{How-to}
\li \l{Reference}
\li \l{Known Issues}
\li \l{Glossary}
\endlist
\li \b {\l{Reference}}
\list
\li \l {Build Systems}
\li \l {Command Line Options}
\li \l {Custom Wizards}
\li \l {Keyboard Shortcuts}
\li \l {Supported Platforms}
\li \l {Reference}{See More...}
\endlist
\row
\li {4,1} \b {Contact Us}
\list