Add links to option flags

This commit is contained in:
David Dalcino
2021-08-04 00:07:51 -07:00
parent 89abf55c4a
commit ddc36064dc
3 changed files with 35 additions and 16 deletions

View File

@@ -60,13 +60,17 @@ List available versions of Qt, targets, extensions, modules, and architectures.
Display help text
.. _extension_flag:
.. option:: --extension <Extension>
Extension of packages to list
{wasm,src_doc_examples,preview,wasm_preview,x86_64,x86,armv7,arm64_v8a}
Use the ``--extensions`` flag to list all relevant options for a host/target.
Incompatible with the ``--extensions`` flag, but may be combined with any other flag.
Use the :ref:`--extensions <extensions_flag>` flag to list all relevant options for a host/target.
Incompatible with the :ref:`--extensions <extensions_flag>` flag, but may be combined with any other flag.
.. _spec_flag:
.. option:: --spec <Specification>
@@ -79,12 +83,17 @@ List available versions of Qt, targets, extensions, modules, and architectures.
all versions of Qt for Windows Desktop beginning with 5.12.
May be combined with any other flag to filter the output of that flag.
.. _extensions_flag:
.. option:: --extensions (<Qt version> | latest)
Qt version in the format of "5.X.Y", or the keyword ``latest``.
When set, this prints all valid arguments for the ``--extension`` flag for
Qt 5.X.Y, or the latest version of Qt if ``latest`` is specified.
Incompatible with the ``--extension`` flag.
When set, this prints all valid arguments for the
:ref:`--extension <extension_flag>` flag for Qt 5.X.Y, or the latest
version of Qt if ``latest`` is specified.
Incompatible with the :ref:`--extension <extension_flag>` flag.
.. _list_qt_modules_flag:
.. option:: --modules (<Qt version> | latest)
@@ -92,6 +101,8 @@ List available versions of Qt, targets, extensions, modules, and architectures.
available for Qt 5.X.Y with a host/target/extension, or the latest version
of Qt if ``latest`` is specified.
.. _list_qt_arch_flag:
.. option:: --arch (<Qt version> | latest)
Qt version in the format of "5.X.Y". When set, this prints all architectures
@@ -101,7 +112,7 @@ List available versions of Qt, targets, extensions, modules, and architectures.
.. option:: --latest-version
Print only the newest version available
May be combined with the ``--extension`` and/or ``--spec`` flags.
May be combined with the :ref:`--extension <extension_flag>` and/or :ref:`--spec <spec_flag>` flags.
.. _list tool command:
@@ -140,6 +151,8 @@ List available tools
Display help text
.. _list_tool_long_flag:
.. option:: --long, -l
Long display: shows extra metadata associated with each tool variant.
@@ -214,6 +227,8 @@ There are various combinations to accept according to Qt version.
Display help text
.. _outputdir_flag:
.. option:: --outputdir, -O <Output Directory>
specify output directory.
@@ -228,6 +243,8 @@ There are various combinations to accept according to Qt version.
the connection timeout, in seconds, for the download site. (default: 5 sec)
.. _external_flag:
.. option:: --external, -E <7zip command>
Specify external 7zip command path. By default, aqt uses py7zr_ for this task.
@@ -242,6 +259,8 @@ There are various combinations to accept according to Qt version.
Keep downloaded archive when specified, otherwise remove after install
.. _modules_flag:
.. option:: --modules, -m (<list of modules> | all)
specify extra modules to install as a list.
@@ -270,7 +289,7 @@ instead of a list of modules, like this:
.. option:: --noarchives
[Advanced] Specify not to install all base packages.
This is advanced option and you should use it with ``--modules`` option.
This is advanced option and you should use it with :ref:`--modules <modules_flag>` option.
This allow you to add modules to existent Qt installation.

View File

@@ -60,7 +60,7 @@ Now that we know what versions of Qt are available, let's choose version 6.2.0.
The next thing we need to do is find out what architectures are available for
Qt 6.2.0 for Windows Desktop. To do this, we can use :ref:`aqt list-qt <list qt command>` with the
``--arch`` flag:
:ref:`--arch <list_qt_arch_flag>` flag:
.. code-block:: console
@@ -86,7 +86,7 @@ Installing Modules
Let's say we need to install some modules for Qt 5.15.2 on Windows Desktop.
First we need to find out what the modules are called, and we can do that
with :ref:`aqt list-qt <list qt command>` with the ``--modules`` flag.
with :ref:`aqt list-qt <list qt command>` with the :ref:`--modules <list_qt_modules_flag>` flag.
Each version of Qt has a different list of modules for each host OS/ target SDK
combination, so we will need to supply :ref:`aqt list-qt <list qt command>` with that information:
@@ -231,7 +231,7 @@ Installing Qt for WASM
----------------------
To find out how to install Qt for WASM, we need to tell :ref:`aqt list-qt <list qt command>` that we are
using the `wasm` architecture. We can do that by using the ``--extension wasm`` flag.
using the `wasm` architecture. We can do that by using the :ref:`--extension wasm <extension_flag>` flag.
.. code-block:: console
@@ -302,7 +302,7 @@ Let's see what tool variants are available in `tools_mingw`:
This gives us a list of things that we could install using
:ref:`aqt install-tool <tools installation command>`.
Let's see some more details, using the ``-l`` or ``--long`` flag:
Let's see some more details, using the :ref:`-l | --long <list_tool_long_flag>` flag:
.. code-block:: console
@@ -321,7 +321,7 @@ Let's see some more details, using the ``-l`` or ``--long`` flag:
qt.tools.win64_mingw730 7.3.0-1-202004170606 2020-04-17
qt.tools.win64_mingw810 8.1.0-1-202004170606 2020-04-17
The ``-l`` flag causes :ref:`aqt list-tool <list tool command>` to print a table
The :ref:`-l <list_tool_long_flag>` flag causes :ref:`aqt list-tool <list tool command>` to print a table
that shows plenty of data pertinent to each tool variant available in `tools_mingw`.
:ref:`aqt list-tool <list tool command>` additionally prints the 'Display Name'
and 'Description' for each tool if your terminal is wider than 95 characters;

View File

@@ -96,9 +96,9 @@ Some older operating systems may require you to specify Python version 3, like t
* For android and Qt 5.11 or below, choose one of: `android_x86`, `android_armv7`
* For android and Qt 5.12 or Qt 5.13 or Qt 6, choose one of:
`android_x86_64`, `android_arm64_v8a`, `android_x86`, `android_armv7`
* You can specify external 7zip command path instead of built-in extractor by using the ``-E`` or ``--external`` flag.
* You can specify an alternate output directory by using the ``-O`` or ``--outputdir`` flag.
* To install all available modules, you can use the option ``-m all``.
* You can specify external 7zip command path instead of built-in extractor by using the :ref:`-E | --external <external_flag>` flag.
* You can specify an alternate output directory by using the :ref:`-O | --outputdir <outputdir_flag>` flag.
* To install all available modules, you can use the option :ref:`-m all <modules_flag>`.
A full description of the options for ``aqt install-qt`` is available in the documentation
for the :ref:`Qt installation command`.
@@ -122,7 +122,7 @@ You can install tools and utilities using the :ref:`tools installation command`:
Target directory
----------------
You can change the installation directory by using the option ``--outputdir`` or ``-O``.
You can change the installation directory by using the option :ref:`-O | --outputdir <outputdir_flag>`.
This option works for ``aqt install-qt``, ``aqt install-tool``, and any other subcommand
that begins with ``install-``.