Skip to content

Commit e203b62

Browse files
committed
Update tt commands reference for tt 1.3
1 parent 745169d commit e203b62

File tree

3 files changed

+58
-5
lines changed

3 files changed

+58
-5
lines changed

doc/reference/tooling/tt_cli/install.rst

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

66
.. code-block:: console
77
8-
$ tt install PROGRAM_NAME [VERSION] [OPTION ...]
8+
$ tt install PROGRAM_NAME [VERSION|COMMIT_OR_PR] [OPTION ...]
99
1010
``tt install`` installs the latest or an explicitly specified version of Tarantool
1111
or ``tt``. The possible values of ``PROGRAM_NAME`` are:
@@ -21,6 +21,11 @@ or ``tt``. The possible values of ``PROGRAM_NAME`` are:
2121
(see the :ref:`ee section <tt-config_file_ee>` of the configuration file) or
2222
provide them interactively.
2323

24+
Additionally, ``tt install`` can build open source programs ``tarantool`` and ``tt``
25+
from a specific commit or a pull request on their GitHub repositories.
26+
27+
To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.
28+
2429
Options
2530
-------
2631

@@ -66,16 +71,42 @@ dependencies, such as a C compiler. Make sure they are available in the system.
6671

6772
Tarantool Enterprise Edition is installed from prebuilt packages.
6873

74+
Development versions
75+
~~~~~~~~~~~~~~~~~~~~
76+
77+
``tt install`` can be used to build custom Tarantool and ``tt`` versions for
78+
development purposes. The sources for such version can be either stored locally
79+
or exist on GitHub (specific commits or pull requests).
80+
81+
To build Tarantool from a local source, use the ``tarantool-dev`` program name and
82+
provide a path to the source:
83+
84+
.. code-block:: console
85+
86+
$ tt install tarantool-dev ~/src/tarantool/build
87+
88+
To build Tarantool or ``tt`` from a specific commit on their GitHub repository,
89+
pass the commit hash (7 or more characters) after the program name. If you want to use
90+
a PR as a source, provide a ``pr/<PR_ID>`` argument:
91+
92+
93+
.. code-block:: console
94+
95+
$ tt install tarantool 03c184d
96+
$ tt install tt pr/50
97+
98+
99+
Local repositories
100+
~~~~~~~~~~~~~~~~~~
101+
69102
You can also set up a local repository with installation files you need.
70103
To use it, specify its location in the :ref:`repo section <tt-config_file_repo>`
71104
of the ``tt`` configuration file and run ``tt install`` with the ``--local-repo`` flag.
72105

73-
To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.
74-
75106
Example
76107
--------
77108

78-
* Install the latest available version of Tarantool:
109+
* Install the latest available version of Tarantool CE:
79110

80111
.. code-block:: console
81112
@@ -98,3 +129,16 @@ Example
98129
.. code-block:: console
99130
100131
$ tt install tarantool-dev ~/src/tarantool/build
132+
133+
134+
* Install Tarantool from a PR #1234 on the `tarantool/tarantool GitHub repository <https://github.com/tarantool/tarantool>`__:
135+
136+
.. code-block:: console
137+
138+
$ tt install tarantool pr/1234
139+
140+
* Install ``tt`` from a commit with hash ``00a9e59`` on the `tarantool/tt GitHub repository <https://github.com/tarantool/tt>`__:
141+
142+
.. code-block:: console
143+
144+
$ tt install tt 40e696e

doc/reference/tooling/tt_cli/pack.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,16 @@ Options
126126
127127
$ tt pack deb --postinst post.sh
128128
129+
.. option:: --tarantool-version
130+
131+
Specify a Tarantool version for packaging in a Docker container.
132+
For use with ``--use-docker`` only.
133+
129134
.. option:: --use-docker
130135

131-
Build a package in an Ubuntu 18.04 Docker container.
136+
Build a package in an Ubuntu 18.04 Docker container. To specify a Tarantool
137+
version to use in the container, add the ``--tarantool-version option``.
138+
132139
Before executing ``tt pack`` with this option, make sure Docker is running.
133140

134141
.. option:: --version PACKAGE_VERSION

doc/reference/tooling/tt_cli/rocks.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ Commands
7272
:widths: 20 80
7373
:header-rows: 0
7474

75+
* - ``admin``
76+
- Use the `luarocks-admin <https://github.com/luarocks/luarocks/wiki/luarocks-admin>`__ tool
7577
* - ``build``
7678
- Build and compile a rock
7779
* - ``config``

0 commit comments

Comments
 (0)