diff options
| author | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2021-03-18 13:07:39 +0200 |
|---|---|---|
| committer | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2021-04-09 09:19:48 +0300 |
| commit | 6c70f89e8e8e312a4a738c180742c0ab41b3ab95 (patch) | |
| tree | 4093246a789b25125b074aa6b682a3a60e8c497e /doc | |
| parent | 8f97bf0ba510a374d4ce3ab040a513c62779454f (diff) | |
CLI: Add support for additional filtering of search results
Search command results can now be optionally filtered with
the '--filter-packages'-option, which takes an unspecified
count of key-value pairs that contain the desired package
information element and a regular expression used to find
matches in the element.
Example usage:
'installer --fp "Version=1.0, Description=Some text" search *'
Only the packages which match all given filter rules are
included in the output print.
Task-number: QTIFW-2168
Change-Id: I788b065d95952b988489c36db80b3c859b970f05
Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/installerfw-using.qdoc | 6 | ||||
| -rw-r--r-- | doc/installerfw.qdoc | 10 |
2 files changed, 13 insertions, 3 deletions
diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc index f0205755f..5c5bbbbc4 100644 --- a/doc/installerfw-using.qdoc +++ b/doc/installerfw-using.qdoc @@ -448,10 +448,12 @@ The \c search command can be used to search components from available repositories, or from integrated binary content in case of an offline installer. It can be used with no arguments to list all available components or with a regular expression to get a list - of only components matching the pattern: + of only components matching the pattern. The \c --filter-packages option can be + used to specify additional filters for the search operation. For a list of usable + information elements with the option, refer to \l{Summary of Package Information File Elements}. \code - installer.exe search "expression" + installer.exe --filter-packages "DisplayName=MyComponent, Version=1.0" search "expression" \endcode \section1 Performing Full Uninstallation diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 4ae62eff6..6f77d8850 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2020 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: http://www.qt.io/licensing/ ** ** This file is part of the Qt Installer Framework. @@ -247,6 +247,11 @@ \li Create a local repository inside the installation directory. This option has no effect on online installers. \row + \li --fp, --filter-packages <element=regex,...> + \li [CLI] Comma separated list of additional key-value pair filters used to query packages with the + search command. The keys can be any of the possible package information elements, like + \c DisplayName and \c Description. + \row \li --am, --accept-messages \li [CLI] Accepts all message queries without user input. \row @@ -316,6 +321,9 @@ \row \li se, search <regexp> \li Search available packages. If no search pattern is given, show all available packages. + + \note The \c --filter-packages option can be used to specify additional filters for + the search operation. See \l{Summary of Options}. \row \li co, create-offline <pkg ...> \li Create offline installer from selected packages. |