Skip to content

Commit f27ce91

Browse files
authored
Update tt install doc to the new syntax (#3525)
Resolves #3514 * Update tt install/uninstall docs to the new syntax * Update tt install and search flags in docs
1 parent fb9033b commit f27ce91

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

doc/reference/tooling/tt_cli/install.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Installing Tarantool software
55

66
.. code-block:: bash
77
8-
tt install PROGRAM_NAME[=version] [flags]
8+
tt install PROGRAM_NAME [version] [flags]
99
1010
``tt install`` installs the latest or an explicitly specified version of Tarantool
1111
or ``tt``. The possible values of ``PROGRAM_NAME`` are:
@@ -29,6 +29,8 @@ Flags
2929
:widths: 20 80
3030
:header-rows: 0
3131

32+
* - ``--dynamic``
33+
- (``tarantool`` and ``tarantool-ee``) Use dynamic linking for building Tarantool
3234
* - ``-f``
3335

3436
``--force``
@@ -42,7 +44,7 @@ Flags
4244
* - ``--reinstall``
4345
- Reinstall a previously installed program
4446
* - ``--use-docker``
45-
- Build Tarantool in an Ubuntu 16.04 Docker container
47+
- (``tarantool`` and ``tarantool-ee``) Build Tarantool in an Ubuntu 18.04 Docker container
4648

4749
Details
4850
-------
@@ -72,14 +74,14 @@ Example
7274
7375
tt install tarantool
7476
75-
* Install Tarantool 2.10.5 from the local repository:
77+
* Install Tarantool 2.11.0 from the local repository:
7678

7779
.. code-block:: bash
7880
79-
tt install tarantool=2.10.5 --local-repo
81+
tt install tarantool 2.11.0 --local-repo
8082
81-
* Reinstall Tarantool 2.10.5:
83+
* Reinstall Tarantool 2.10.7:
8284

8385
.. code-block:: bash
8486
85-
tt install tarantool=2.10.5 --reinstall
87+
tt install tarantool 2.10.7 --reinstall

doc/reference/tooling/tt_cli/search.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,14 @@ Flags
2929
:widths: 20 80
3030
:header-rows: 0
3131

32+
* - ``--debug``
33+
- (``tarantool-ee`` only) Search for debug builds of Tarantool Enterprise SDK
3234
* - ``--local-repo``
3335
- Search in the local repository, which is specified in the
3436
:ref:`repo section <tt-config_file_repo>` of the ``tt``
35-
configuration file.
37+
configuration file
38+
* - ``--version``
39+
- (``tarantool-ee`` only) Tarantool Enterprise version
3640

3741
Example
3842
--------

doc/reference/tooling/tt_cli/uninstall.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Uninstalling Tarantool software
55

66
.. code-block:: bash
77
8-
tt uninstall PROGRAM_NAME
8+
tt uninstall PROGRAM_NAME [version]
99
1010
``tt uninstall`` uninstalls a previously :doc:`installed <install>` Tarantool version.
1111

@@ -16,4 +16,4 @@ Uninstall Tarantool 2.10.4:
1616

1717
.. code-block:: bash
1818
19-
tt uninstall tarantool=2.10.4
19+
tt uninstall tarantool 2.10.4

0 commit comments

Comments
 (0)