summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKatja Marttila <katja.marttila@qt.io>2023-10-02 13:58:06 +0300
committerKatja Marttila <katja.marttila@qt.io>2023-10-13 10:54:04 +0300
commite8c4492693328568a1512303834e318aa1c1ea28 (patch)
tree1d720bc51e59c679ae54c46bb2870e9785eaf2d0
parentc1c943fa0141def4aafba0b4cba48ce21a308da5 (diff)
Unify maintenance tool name
Maintenance tool was written with both capital letters and non-capital letters, unifying the naming and writing with non-capital letters. Also wrote the name behind a macro, in case we some day want to change it. Task-number: QTIFW-3169 Change-Id: Ic4da06a14edd1d9675704befb5599d2c54747446 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
-rw-r--r--doc/config/ifw.qdocconf1
-rw-r--r--doc/installerfw-overview.qdoc8
-rw-r--r--doc/installerfw-using.qdoc34
-rw-r--r--doc/installerfw.qdoc54
-rw-r--r--doc/noninteractive.qdoc12
-rw-r--r--doc/scripting-api/console.qdoc2
-rw-r--r--doc/scripting-api/packagemanagercore.qdoc10
-rw-r--r--examples/doc/online.qdoc2
-rw-r--r--examples/doc/treename.qdoc8
9 files changed, 66 insertions, 65 deletions
diff --git a/doc/config/ifw.qdocconf b/doc/config/ifw.qdocconf
index 9e6a10423..ba7c39394 100644
--- a/doc/config/ifw.qdocconf
+++ b/doc/config/ifw.qdocconf
@@ -51,6 +51,7 @@ qhp.InstallerFramework.subprojects.manual.indexTitle = Qt Installer Framework Ma
qhp.InstallerFramework.subprojects.manual.type = manual
macro.IFW = "Qt Installer Framework"
+macro.MT = "maintenance tool"
# For docs, QT_VERSION resolves to IFW version
macro.ifwversion = $QT_VERSION
diff --git a/doc/installerfw-overview.qdoc b/doc/installerfw-overview.qdoc
index 7589aa915..498d7a733 100644
--- a/doc/installerfw-overview.qdoc
+++ b/doc/installerfw-overview.qdoc
@@ -55,10 +55,10 @@
\image ifw-overview.png
- Both installers install a \e {maintenance tool}, which allows you to later
+ Both installers install a \e {\MT}, which allows you to later
add, update, and remove components. Offline installers contain all the
installable components and do not require network connections during the
- installation. Online installers only install the maintenance tool that then
+ installation. Online installers only install the \MT that then
downloads and installs components from an online repository on a web server.
Therefore, the size of an online installer binary is smaller and its
download time is shorter than that of an offline installer binary. The total
@@ -66,12 +66,12 @@
than downloading and running an offline installer if the end users do not
install all the available components.
- End users can use the maintenance tool to install more components from
+ End users can use the \MT to install more components from
the server after the initial installation, as well as to receive automatic
updates to content as soon as the updates are available on the server.
However, this works for an offline installation only if you specify a
repository address in the offline installer configuration or if end users
- specify the repository address themselves in the maintenance tool settings.
+ specify the repository address themselves in the \MT settings.
Create an offline installer to enable users to directly download the
installation package on a media for installation on a computer later. You
diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc
index e6e2a3111..3cc52fb1a 100644
--- a/doc/installerfw-using.qdoc
+++ b/doc/installerfw-using.qdoc
@@ -33,12 +33,12 @@
\title End User Workflows
The end user experience is similar for offline and online installers.
- Along with your application, the installers install a maintenance tool that
+ Along with your application, the installers install a \MT that
consists of a package manager, an updater, and an uninstaller. End users can
- use the maintenance tool to add, update, and remove components. The
- maintenance tool connects to an external repository to fetch the components
+ use the \MT to add, update, and remove components. The
+ \MT connects to an external repository to fetch the components
to add or update. You can specify the repository in the configuration file
- or end users can specify it in the maintenance tool settings.
+ or end users can specify it in the \MT settings.
You can support the following end user workflows:
@@ -177,7 +177,7 @@
If end users did not select all the components available for installation
during the initial installation, they can use the package manager to install
the remaining components from a repository later. The package manager is
- part of a maintenance tool that is installed together with the application
+ part of a \MT that is installed together with the application
during the initial installation. This only works if a repository that
contains the components is available either locally or externally.
@@ -186,14 +186,14 @@
\image ifw-user-flow-adding.png "Add components workflow"
- This section uses the \e {Maintenance Tool} installed by the Qt 5 installer
+ This section uses the \e {\MT} installed by the Qt 5 installer
run on macOS as an example implementation of how end users can add components
- after the initial installation. The Maintenance Tool contains the package
+ after the initial installation. The \MT contains the package
manager, updater, and uninstaller.
\section1 Starting Package Manager
- When end users start the Maintenance Tool, the introduction page opens:
+ When end users start the \MT, the introduction page opens:
\image ifw-add-components-introduction.png "Introduction page"
@@ -242,12 +242,12 @@
\image ifw-user-flow-removing.png "Remove components workflow"
- This section uses the Qt 5 Maintenance Tool run on macOS as an example
+ This section uses the Qt 5 \MT run on macOS as an example
implementation of how end users can remove all or selected components.
\section1 Removing All Components
- When end users start the Maintenance Tool, the introduction page opens:
+ When end users start the \MT, the introduction page opens:
\image ifw-add-components-introduction.png "Introduction page"
@@ -294,12 +294,12 @@
\image ifw-user-flow-updating.png "Updating workflow"
- This section uses the Qt 5 Maintenance Tool run on macOS as an example
+ This section uses the Qt 5 \MT run on macOS as an example
implementation of how end users can update installed components.
\section1 Starting Updater
- When end users start the Maintenance Tool, the introduction page opens:
+ When end users start the \MT, the introduction page opens:
\image ifw-updating-introduction.png "Introduction page"
@@ -391,7 +391,7 @@
\section1 Installing Components
- Both the installer and the maintenance tool support installation of new components from
+ Both the installer and the \MT support installation of new components from
command line. The following will install the components given as an argument and
their respective dependencies:
@@ -418,7 +418,7 @@
\section1 Checking for Available Updates
To print information about available component updates, run the \c check-updates
- command with the maintenance tool:
+ command with the \MT:
\code
maintenancetool.exe check-updates
@@ -451,7 +451,7 @@
\section1 Listing Installed Components
To get a list and print additional information about currently installed components, run the
- \c list command with the maintenance tool. The command also accepts an optional regular
+ \c list command with the \MT. The command also accepts an optional regular
expression argument to filter the shown component list.
\code
@@ -492,7 +492,7 @@
\section1 Performing Full Uninstallation
- To uninstall all components and remove the program directory, including maintenance tool,
+ To uninstall all components and remove the program directory, including \MT,
run \c purge command:
\code
@@ -544,7 +544,7 @@
\c {--auto-answer OverwriteTargetDirectory=Yes}. Automatic answers are shown on the
console output and installation log.
- By default, the installer and maintenance tool will print a summary of components to be
+ By default, the installer and \MT will print a summary of components to be
affected by the command and then ask for permission to continue performing the action,
to prevent accidental changes. For unattended usage, this can be skipped by using the
\c --confirm-command option.
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 700ce8d4c..15f6f866a 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -322,7 +322,7 @@
\li Install packages and aliases given as an argument. If no arguments are given, install the default package set.
\row
\li ch, check-updates
- \li Show information about available updates on the maintenance tool.
+ \li Show information about available updates on the \MT.
\row
\li up, update <pkg ...>
\li Update packages given as an argument. If no packages are given, install all available updates.
@@ -530,16 +530,16 @@
For more information, see \l{Configuring Repository Categories}.
\row
\li MaintenanceToolName
- \li Filename of the generated maintenance tool. Defaults to
+ \li Filename of the generated \MT. Defaults to
\e maintenancetool. The platform-specific executable file extension is
appended.
\row
\li MaintenanceToolIniFile
- \li Filename for the configuration of the generated maintenance tool. Defaults to
+ \li Filename for the configuration of the generated \MT. Defaults to
\e {MaintenanceToolName}.ini.
\row
\li MaintenanceToolAlias
- \li Filename for an alias of the maintenance tool that will be created to the
+ \li Filename for an alias of the \MT that will be created to the
Applications directory. Optional. Only used on macOS.
\row
\li RemoveTargetDir
@@ -1001,7 +1001,7 @@
but this does not change the visibility of the check box in the updater view
where the end user may still manually select the component for update.
- When running an installer or a maintenance tool in package manager
+ When running an installer or a \MT in package manager
mode, the selection will be performed automatically.
If the component was not installed before, it will
be selected for installation only when all components
@@ -1539,9 +1539,9 @@
\section1 devtool
- You can use \c devtool to update an existing installer or maintenance tool
+ You can use \c devtool to update an existing installer or \MT
with a new installer base, to dump binary content from an installer or
- maintenance tool to a target, and to execute operations. For a summary of
+ \MT to a target, and to execute operations. For a summary of
available operations, see \l {Operations}.
\c devtool expects the following parameters in the following order:
@@ -1570,12 +1570,12 @@
\li Display additional information.
\row
\li update <binary> <installerbase>
- \li Update an existing installer or maintenance tool with a new
+ \li Update an existing installer or \MT with a new
installer base.
\row
\li dump <binary> <folder>
\li Dump the binary content that belongs to an installer or
- maintenance tool into the target.
+ \MT into the target.
\row
\li operation <mode,name,args,...>
\li Execute an operation with a list of arguments.
@@ -1648,7 +1648,7 @@
\endcode
The installer works only if it can access the repository. If the repository is
- accessed after the installation, the maintenance tool rejects installation.
+ accessed after the installation, the \MT rejects installation.
However, uninstallation is still possible.
A repository can be enabled or disabled by default.
For repositories requiring authentication, the details can also be set here,
@@ -1870,7 +1870,7 @@
If \c{url} is itself relative, it will be resolved against the base URL of the current document.
\c{displayname} specifies how the repository should be named in the \gui Settings page
- of the Maintenance Tool.
+ of the \MT.
\c{name} and \c{password} optionally specify credentials for a protected repository.
@@ -1926,22 +1926,22 @@
\section1 Promoting Updates for the Maintenance Tool
Without additional configuration, both online and offline installers install the
- \e {maintenance tool}, that can be later used to add, update, and remove components.
- Online installers also have an option to install the maintenance tool from an online repository.
- This makes it possible to promote updates for the maintenance tool to take the advantage of latest
+ \e {\MT}, that can be later used to add, update, and remove components.
+ Online installers also have an option to install the \MT from an online repository.
+ This makes it possible to promote updates for the \MT to take the advantage of latest
new features and fixes to the Qt Installer Framework.
You should download the latest release of the Installer Framework distribution that
includes new versions of \l{binarycreator} and \l{installerbase} tools. However, to only
update vendor specific configuration like \c <Name>, \c <Title>, and \c <Publisher> to the new
- maintenance tool, you can use the tools that were used to create the original installer.
+ \MT, you can use the tools that were used to create the original installer.
\section2 Creating the Component Directory Structure for Maintenance Tool
- To make the maintenance tool update installable for end users, you need to prepare an installer
- component for the maintenance tool and create a repository for that component.
+ To make the \MT update installable for end users, you need to prepare an installer
+ component for the \MT and create a repository for that component.
- \note If you already have a component for the maintenance tool available in a repository, you
+ \note If you already have a component for the \MT available in a repository, you
can skip the instructions in this section.
A common convention is to create a \c packages directory containing the metadata and data for
@@ -1952,10 +1952,10 @@
\section2 Compiling the Update Resource
If you want to apply configuration changes, like updating the title, publisher, or product URL
- when the end user updates the maintenance tool, you need to create an update resource file.
+ when the end user updates the \MT, you need to create an update resource file.
Otherwise this step is optional.
- First, you need to compile the resource file that will contain the new maintenance tool
+ First, you need to compile the resource file that will contain the new \MT
configuration and related files:
\code
@@ -1965,8 +1965,8 @@
The command outputs the result into \c update.rcc in the current path.
The \c packages directory argument refers to the previously created directory for the maintenance
- tool component. \c config.xml contains the maintenance tool configuration. This can be the same
- file that was used for creating the online installer that is going to consume the maintenance tool
+ tool component. \c config.xml contains the \MT configuration. This can be the same
+ file that was used for creating the online installer that is going to consume the \MT
repository, or you could make modifications to change some configuration elements like the window
title and product version.
@@ -1974,9 +1974,9 @@
\section2 Getting the Maintenance Tool
- The maintenance tool for Linux and Windows is the same as the \c installerbase
+ The \MT for Linux and Windows is the same as the \c installerbase
executable located in your Qt Installer Framework's installation \c bin folder.
- For macOS the maintenance tool app bundle can be created using the \c binarycreator
+ For macOS the \MT app bundle can be created using the \c binarycreator
tool with the command line switch \c --mt or \c --create-maintenancetool. The
name of the macOS app bundle can be configured in config.xml using
the \c <MaintenanceToolName> element. The app bundle can be later signed and
@@ -1989,7 +1989,7 @@
\section2 Populating the Maintenance Tool Component
In Linux and in Windows the \c installerbase executable from Qt Installer
- Framework's installation folder, or in macOS the maintenance tool app bundle,
+ Framework's installation folder, or in macOS the \MT app bundle,
should be copied to the component's data directory. If you generated the
\c update.rcc in the \l{Compiling the Update Resource} step, copy that to
the data directory as well. The meta directory should contain a \c package.xml
@@ -2001,7 +2001,7 @@
For further information about the \c package.xml file, see
\l{Summary of Package Information File Elements}.
- \note If you are providing an update for an existing maintenance tool component, copy and overwrite the
+ \note If you are providing an update for an existing \MT component, copy and overwrite the
existing files with the updated content to the package directory and increase the value of the
\c <Version> element in the \c package.xml file.
@@ -2049,7 +2049,7 @@
After preparation the component should be uploaded to an existing or a new online repository
to make it available for end users. The instructions on how to create repositories on
this page and \l{Creating Repositories} apply also for the component containing the
- maintenance tool update.
+ \MT update.
*/
/*!
diff --git a/doc/noninteractive.qdoc b/doc/noninteractive.qdoc
index 15c85d28a..d22a17800 100644
--- a/doc/noninteractive.qdoc
+++ b/doc/noninteractive.qdoc
@@ -155,15 +155,15 @@
\row
\li \c PackageManagerRadioButton
- \li The package manager radio button shown on the page while running as maintenance tool.
+ \li The package manager radio button shown on the page while running as \MT.
\row
\li \c UpdaterRadioButton
- \li The updater radio button shown on the page while running as maintenance tool.
+ \li The updater radio button shown on the page while running as \MT.
\row
\li \c UninstallerRadioButton
- \li The uninstaller radio button shown on the page while running as maintenance tool.
+ \li The uninstaller radio button shown on the page while running as \MT.
Selected by default.
\endtable
@@ -184,10 +184,10 @@
\row
\li \c packageManagerCoreTypeChanged()
- \li Connect to this signal if you want to be notified when the type of maintenance tool
+ \li Connect to this signal if you want to be notified when the type of \MT
changes.
\note The signal is only emitted when the user has started the binary as so called
- maintenance tool (after the installation) and switches between the radio buttons.
+ \MT (after the installation) and switches between the radio buttons.
\endtable
Example code:
@@ -567,7 +567,7 @@
\row
\li \c WriteError
\li OK
- \li An error occurred while writing the maintenance tool.
+ \li An error occurred while writing the \MT.
\row
\li \c ElevationError
diff --git a/doc/scripting-api/console.qdoc b/doc/scripting-api/console.qdoc
index 51825de9e..7785d9223 100644
--- a/doc/scripting-api/console.qdoc
+++ b/doc/scripting-api/console.qdoc
@@ -37,7 +37,7 @@
\l{console::log()}{log} method and \l installer object
\l{installer::isUpdater()}, \l{installer::isUninstaller()}, and
\l{installer::isPackageManager()} methods to display a message that
- indicates whether the maintenance tool is currently being used to update,
+ indicates whether the \MT is currently being used to update,
remove, or add components.
\code
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc
index 377e54842..b45d8edc8 100644
--- a/doc/scripting-api/packagemanagercore.qdoc
+++ b/doc/scripting-api/packagemanagercore.qdoc
@@ -645,23 +645,23 @@
/*!
\qmlmethod void installer::setAllowedRunningProcesses(stringlist processes)
- \deprecated [4.6] Maintenance tool no longer automatically checks for all running processes
+ \deprecated [4.6] The \MT no longer automatically checks for all running processes
in the installation directory for CLI runs. To check for a process to stop, use
\l {component::addStopProcessForUpdateRequest}{component.addStopProcessForUpdateRequest} instead.
Sets additional \a processes that can run when
- updating with the maintenance tool.
+ updating with the \MT.
*/
/*!
\qmlmethod stringlist installer::allowedRunningProcesses()
- \deprecated [4.6] Maintenance tool no longer automatically checks for all running processes
+ \deprecated [4.6] The \MT no longer automatically checks for all running processes
in the installation directory for CLI runs. To check for a process to stop, use
\l {component::addStopProcessForUpdateRequest}{component.addStopProcessForUpdateRequest} instead.
Returns processes that are allowed to run when updating with
- the maintenance tool.
+ the \MT.
*/
/*!
@@ -776,7 +776,7 @@
/*!
\qmlmethod void installer::setInstallerBaseBinary(string path)
- Sets the \c installerbase binary to use when writing the maintenance tool.
+ Sets the \c installerbase binary to use when writing the \MT.
Set the \a path if an update to the binary is available.
If not set, the executable segment of the running installer or uninstaller
diff --git a/examples/doc/online.qdoc b/examples/doc/online.qdoc
index f901c3445..0c14a8c26 100644
--- a/examples/doc/online.qdoc
+++ b/examples/doc/online.qdoc
@@ -150,7 +150,7 @@
only updates packages that are new, or have a higher version number.
See also the \l{Summary of repogen Parameters}.
- If you then run the maintenance tool from the previous installation and
+ If you then run the \MT from the previous installation and
select \gui {Update Components}, you should see that an update of package
\c A is available.
diff --git a/examples/doc/treename.qdoc b/examples/doc/treename.qdoc
index 22acb8e08..774b6e1fa 100644
--- a/examples/doc/treename.qdoc
+++ b/examples/doc/treename.qdoc
@@ -106,7 +106,7 @@
\section2 Multiple Tree Names in One Component Branch
Components in a single branch (\e A, \e{A.sub1}, \e{A.sub1.sub1}, \e{A.sub1.sub1.sub2} and so
- on) may each declare a separate tree name. The installer or maintenance tool calculates the
+ on) may each declare a separate tree name. The installer or \MT calculates the
new locations for components in an ascending order from leaf components to root components, so that
\e{A.sub1.sub1.sub2} is moved first and \e A last.
@@ -120,18 +120,18 @@
of the installer has installed component \e A with tree name \e ANewName1, and the
repository is updated with a new version of component \e A that declares tree name
\e ANewName2, the new location is only applied when the user updates the component
- locally with the maintenance tool.
+ locally with the \MT.
\li The automatic tree names of children of components with tree name and \c moveChildren
set to \c true are moved with the parent regardless if installed or not. Therefore, if
the user has installed component \e{A.sub1} but not component \e A, and \e A is updated
in the repository with a new tree name, the \e{A.sub1} uses also the new tree name in
- maintenance tool's component tree.
+ \MT's component tree.
\endlist
\section2 Tree Name and Name Conflicts
The tree names may conflict with existing component names or other tree names. Depending on whether
- the installer or maintenance tool is configured to allow unstable components with
+ the installer or \MT is configured to allow unstable components with
\c <AllowUnstableComponents> configuration file element, the offending components are either
registered as unstable components with their original name or not registered at all.