Skip to content

Commit 4cd1251

Browse files
p7novandreyaksenov
andauthored
Update tt commands reference for tt 1.3 (#3986)
Resolves #3755 #3756 #3649 Co-authored-by: Andrey Aksenov <[email protected]>
1 parent 8fee77b commit 4cd1251

File tree

6 files changed

+60
-9
lines changed

6 files changed

+60
-9
lines changed

doc/book/connectors/java.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ There are two Java connectors available:
1919
The following modules support Java libraries and frameworks:
2020

2121
* `TestContainers Tarantool module <http://github.com/tarantool/cartridge-java-testcontainers/>`__
22-
adds support for the popular `TestСontainers framework <https://www.testcontainers.org/>`__
22+
adds support for the popular `TestContainers framework <https://www.testcontainers.org/>`__
2323
used for integration testing of Java applications.
2424
* `Spring Data Tarantool module <http://github.com/tarantool/cartridge-springdata/>`__
2525
adds support for the `Spring framework <https://projects.spring.io/spring-data/>`__.

doc/how-to/getting_started_go.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ doesn't exist.
186186
Deleting data
187187
********************************************************************************
188188

189-
To delete a tuple, use ``сonnection.Delete``:
189+
To delete a tuple, use ``connection.Delete``:
190190

191191
.. code-block:: go
192192

doc/reference/tooling/tcm/tcm_connect_clusters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _tcm_connect_clusters:
22

3-
Сonnecting clusters
3+
Connecting clusters
44
===================
55

66
.. include:: index.rst

doc/reference/tooling/tt_cli/install.rst

Lines changed: 47 additions & 5 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_HASH|PR_ID] [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,41 @@ 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 from commits and pull requests on their GitHub repositories.
79+
80+
To build Tarantool or ``tt`` from a specific commit on their GitHub repository,
81+
pass the commit hash (7 or more characters) after the program name. If you want to use
82+
a PR as a source, provide a ``pr/<PR_ID>`` argument:
83+
84+
85+
.. code-block:: console
86+
87+
$ tt install tarantool 03c184d
88+
$ tt install tt pr/50
89+
90+
If you :ref:`build Tarantool from sources <building_from_source>`, you can install
91+
local builds to the current ``tt`` environment by running ``tt install`` with
92+
the ``tarantool-dev`` program name and the path to the build:
93+
94+
.. code-block:: console
95+
96+
$ tt install tarantool-dev ~/src/tarantool/build
97+
98+
Local repositories
99+
~~~~~~~~~~~~~~~~~~
100+
69101
You can also set up a local repository with installation files you need.
70102
To use it, specify its location in the :ref:`repo section <tt-config_file_repo>`
71103
of the ``tt`` configuration file and run ``tt install`` with the ``--local-repo`` flag.
72104

73-
To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.
74-
75105
Example
76106
--------
77107

78-
* Install the latest available version of Tarantool:
108+
* Install the latest available version of Tarantool CE:
79109

80110
.. code-block:: console
81111
@@ -93,8 +123,20 @@ Example
93123
94124
$ tt install tarantool 2.10.8 --reinstall
95125
126+
* Install Tarantool from a PR #1234 on the `tarantool/tarantool <https://github.com/tarantool/tarantool>`__ GitHub repository:
127+
128+
.. code-block:: console
129+
130+
$ tt install tarantool pr/1234
131+
132+
* Install ``tt`` from a commit with a hash ``40e696e`` on the `tarantool/tt <https://github.com/tarantool/tt>`__ GitHub repository:
133+
134+
.. code-block:: console
135+
136+
$ tt install tt 40e696e
137+
96138
* Install Tarantool :ref:`built from sources <building_from_source>`:
97139

98140
.. code-block:: console
99141
100-
$ tt install tarantool-dev ~/src/tarantool/build
142+
$ tt install tarantool-dev ~/src/tarantool/build

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)