diff --git a/doc/book/connectors/java.rst b/doc/book/connectors/java.rst index d13784fb31..fc6d3d81f3 100644 --- a/doc/book/connectors/java.rst +++ b/doc/book/connectors/java.rst @@ -19,7 +19,7 @@ There are two Java connectors available: The following modules support Java libraries and frameworks: * `TestContainers Tarantool module `__ - adds support for the popular `TestСontainers framework `__ + adds support for the popular `TestContainers framework `__ used for integration testing of Java applications. * `Spring Data Tarantool module `__ adds support for the `Spring framework `__. diff --git a/doc/how-to/getting_started_go.rst b/doc/how-to/getting_started_go.rst index 64fe7b907a..63b1169ba0 100644 --- a/doc/how-to/getting_started_go.rst +++ b/doc/how-to/getting_started_go.rst @@ -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 diff --git a/doc/reference/tooling/tcm/tcm_connect_clusters.rst b/doc/reference/tooling/tcm/tcm_connect_clusters.rst index 5f2c3e83e7..c6828ce564 100644 --- a/doc/reference/tooling/tcm/tcm_connect_clusters.rst +++ b/doc/reference/tooling/tcm/tcm_connect_clusters.rst @@ -1,6 +1,6 @@ .. _tcm_connect_clusters: -Сonnecting clusters +Connecting clusters =================== .. include:: index.rst diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/reference/tooling/tt_cli/install.rst index dfde673c73..6343abcd47 100644 --- a/doc/reference/tooling/tt_cli/install.rst +++ b/doc/reference/tooling/tt_cli/install.rst @@ -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: @@ -21,6 +21,11 @@ or ``tt``. The possible values of ``PROGRAM_NAME`` are: (see the :ref:`ee section ` 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 `. + Options ------- @@ -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/`` argument: + + +.. code-block:: console + + $ tt install tarantool 03c184d + $ tt install tt pr/50 + +If you :ref:`build Tarantool from sources `, 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 ` 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 `. - Example -------- -* Install the latest available version of Tarantool: +* Install the latest available version of Tarantool CE: .. code-block:: console @@ -93,8 +123,20 @@ Example $ tt install tarantool 2.10.8 --reinstall +* Install Tarantool from a PR #1234 on the `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 `__ GitHub repository: + + .. code-block:: console + + $ tt install tt 40e696e + * Install Tarantool :ref:`built from sources `: .. code-block:: console - $ tt install tarantool-dev ~/src/tarantool/build + $ tt install tarantool-dev ~/src/tarantool/build \ No newline at end of file diff --git a/doc/reference/tooling/tt_cli/pack.rst b/doc/reference/tooling/tt_cli/pack.rst index 6084ef4c4e..31aa2cdf6c 100644 --- a/doc/reference/tooling/tt_cli/pack.rst +++ b/doc/reference/tooling/tt_cli/pack.rst @@ -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 diff --git a/doc/reference/tooling/tt_cli/rocks.rst b/doc/reference/tooling/tt_cli/rocks.rst index 7f2a80cd5e..d84ef5eb82 100644 --- a/doc/reference/tooling/tt_cli/rocks.rst +++ b/doc/reference/tooling/tt_cli/rocks.rst @@ -72,6 +72,8 @@ Commands :widths: 20 80 :header-rows: 0 + * - ``admin`` + - Use the `luarocks-admin `__ tool * - ``build`` - Build and compile a rock * - ``config``