Skip to content

Commit

Permalink
Update tt commands reference for tt 1.3 (#3986)
Browse files Browse the repository at this point in the history
Resolves #3755 #3756 #3649

Co-authored-by: Andrey Aksenov <[email protected]>
  • Loading branch information
p7nov and andreyaksenov authored Jan 16, 2024
1 parent 8fee77b commit 4cd1251
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/book/connectors/java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ There are two Java connectors available:
The following modules support Java libraries and frameworks:

* `TestContainers Tarantool module <http://github.com/tarantool/cartridge-java-testcontainers/>`__
adds support for the popular `TestСontainers framework <https://www.testcontainers.org/>`__
adds support for the popular `TestContainers framework <https://www.testcontainers.org/>`__
used for integration testing of Java applications.
* `Spring Data Tarantool module <http://github.com/tarantool/cartridge-springdata/>`__
adds support for the `Spring framework <https://projects.spring.io/spring-data/>`__.
Expand Down
2 changes: 1 addition & 1 deletion doc/how-to/getting_started_go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ doesn't exist.
Deleting data
********************************************************************************

To delete a tuple, use ``сonnection.Delete``:
To delete a tuple, use ``connection.Delete``:

.. code-block:: go
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/tooling/tcm/tcm_connect_clusters.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _tcm_connect_clusters:

Сonnecting clusters
Connecting clusters
===================

.. include:: index.rst
Expand Down
52 changes: 47 additions & 5 deletions doc/reference/tooling/tt_cli/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Installing Tarantool software

.. code-block:: console
$ tt install PROGRAM_NAME [VERSION] [OPTION ...]
$ tt install PROGRAM_NAME [VERSION|COMMIT_HASH|PR_ID] [OPTION ...]
``tt install`` installs the latest or an explicitly specified version of Tarantool
or ``tt``. The possible values of ``PROGRAM_NAME`` are:
Expand All @@ -21,6 +21,11 @@ or ``tt``. The possible values of ``PROGRAM_NAME`` are:
(see the :ref:`ee section <tt-config_file_ee>` of the configuration file) or
provide them interactively.

Additionally, ``tt install`` can build open source programs ``tarantool`` and ``tt``
from a specific commit or a pull request on their GitHub repositories.

To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.

Options
-------

Expand Down Expand Up @@ -66,16 +71,41 @@ dependencies, such as a C compiler. Make sure they are available in the system.

Tarantool Enterprise Edition is installed from prebuilt packages.

Development versions
~~~~~~~~~~~~~~~~~~~~

``tt install`` can be used to build custom Tarantool and ``tt`` versions for
development purposes from commits and pull requests on their GitHub repositories.

To build Tarantool or ``tt`` from a specific commit on their GitHub repository,
pass the commit hash (7 or more characters) after the program name. If you want to use
a PR as a source, provide a ``pr/<PR_ID>`` argument:


.. code-block:: console
$ tt install tarantool 03c184d
$ tt install tt pr/50
If you :ref:`build Tarantool from sources <building_from_source>`, you can install
local builds to the current ``tt`` environment by running ``tt install`` with
the ``tarantool-dev`` program name and the path to the build:

.. code-block:: console
$ tt install tarantool-dev ~/src/tarantool/build
Local repositories
~~~~~~~~~~~~~~~~~~

You can also set up a local repository with installation files you need.
To use it, specify its location in the :ref:`repo section <tt-config_file_repo>`
of the ``tt`` configuration file and run ``tt install`` with the ``--local-repo`` flag.

To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.

Example
--------

* Install the latest available version of Tarantool:
* Install the latest available version of Tarantool CE:

.. code-block:: console
Expand All @@ -93,8 +123,20 @@ Example
$ tt install tarantool 2.10.8 --reinstall
* Install Tarantool from a PR #1234 on the `tarantool/tarantool <https://github.com/tarantool/tarantool>`__ GitHub repository:

.. code-block:: console
$ tt install tarantool pr/1234
* Install ``tt`` from a commit with a hash ``40e696e`` on the `tarantool/tt <https://github.com/tarantool/tt>`__ GitHub repository:

.. code-block:: console
$ tt install tt 40e696e
* Install Tarantool :ref:`built from sources <building_from_source>`:

.. code-block:: console
$ tt install tarantool-dev ~/src/tarantool/build
$ tt install tarantool-dev ~/src/tarantool/build
9 changes: 8 additions & 1 deletion doc/reference/tooling/tt_cli/pack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,16 @@ Options
$ tt pack deb --postinst post.sh
.. option:: --tarantool-version

Specify a Tarantool version for packaging in a Docker container.
For use with ``--use-docker`` only.

.. option:: --use-docker

Build a package in an Ubuntu 18.04 Docker container.
Build a package in an Ubuntu 18.04 Docker container. To specify a Tarantool
version to use in the container, add the ``--tarantool-version`` option.

Before executing ``tt pack`` with this option, make sure Docker is running.

.. option:: --version PACKAGE_VERSION
Expand Down
2 changes: 2 additions & 0 deletions doc/reference/tooling/tt_cli/rocks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Commands
:widths: 20 80
:header-rows: 0

* - ``admin``
- Use the `luarocks-admin <https://github.com/luarocks/luarocks/wiki/luarocks-admin>`__ tool
* - ``build``
- Build and compile a rock
* - ``config``
Expand Down

0 comments on commit 4cd1251

Please sign in to comment.