From cea69199646c54828e9cfbf9025f5bcbd8243406 Mon Sep 17 00:00:00 2001
From: Pavel Semyonov
Date: Fri, 12 Jan 2024 15:23:43 +0700
Subject: [PATCH 1/5] Update tt commands reference for tt 1.3
---
doc/reference/tooling/tt_cli/install.rst | 52 ++++++++++++++++++++++--
doc/reference/tooling/tt_cli/pack.rst | 9 +++-
doc/reference/tooling/tt_cli/rocks.rst | 2 +
3 files changed, 58 insertions(+), 5 deletions(-)
diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/reference/tooling/tt_cli/install.rst
index dfde673c73..40ddca02c9 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,42 @@ 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. The sources for such version can be either stored locally
+or exist on GitHub (specific commits or pull requests).
+
+To build Tarantool from a local source, use the ``tarantool-dev`` program name and
+provide a path to the source:
+
+.. code-block:: console
+
+ $ tt install tarantool-dev ~/src/tarantool/build
+
+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
+
+
+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
@@ -98,3 +129,16 @@ Example
.. code-block:: console
$ tt install tarantool-dev ~/src/tarantool/build
+
+
+* 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 hash ``00a9e59`` on the `tarantool/tt GitHub repository `__:
+
+ .. code-block:: console
+
+ $ tt install tt 40e696e
\ 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``
From 6c3126f125fbaeb805c7d1316f81032bf38f3c36 Mon Sep 17 00:00:00 2001
From: Pavel Semyonov
Date: Mon, 15 Jan 2024 16:40:36 +0700
Subject: [PATCH 2/5] Fix typos
---
doc/book/connectors/java.rst | 2 +-
doc/how-to/getting_started_go.rst | 2 +-
doc/reference/tooling/tcm/tcm_connect_clusters.rst | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
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
From 87d9322d9c156cd09c266a411d3cc4af86d66f47 Mon Sep 17 00:00:00 2001
From: Pavel Semyonov
Date: Mon, 15 Jan 2024 18:17:37 +0700
Subject: [PATCH 3/5] Fix tarantool-dev description
---
doc/reference/tooling/tt_cli/install.rst | 30 +++++++++++-------------
1 file changed, 14 insertions(+), 16 deletions(-)
diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/reference/tooling/tt_cli/install.rst
index 40ddca02c9..b98bf8b404 100644
--- a/doc/reference/tooling/tt_cli/install.rst
+++ b/doc/reference/tooling/tt_cli/install.rst
@@ -75,15 +75,7 @@ Development versions
~~~~~~~~~~~~~~~~~~~~
``tt install`` can be used to build custom Tarantool and ``tt`` versions for
-development purposes. The sources for such version can be either stored locally
-or exist on GitHub (specific commits or pull requests).
-
-To build Tarantool from a local source, use the ``tarantool-dev`` program name and
-provide a path to the source:
-
-.. code-block:: console
-
- $ tt install tarantool-dev ~/src/tarantool/build
+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
@@ -95,6 +87,13 @@ a PR as a source, provide a ``pr/`` argument:
$ 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
~~~~~~~~~~~~~~~~~~
@@ -124,21 +123,20 @@ Example
$ tt install tarantool 2.10.8 --reinstall
-* Install Tarantool :ref:`built from sources `:
+* Install Tarantool from a PR #1234 on the `tarantool/tarantool GitHub repository `__:
.. code-block:: console
- $ tt install tarantool-dev ~/src/tarantool/build
-
+ $ tt install tarantool pr/1234
-* Install Tarantool from a PR #1234 on the `tarantool/tarantool GitHub repository `__:
+* Install ``tt`` from a commit with hash ``00a9e59`` on the `tarantool/tt GitHub repository `__:
.. code-block:: console
- $ tt install tarantool pr/1234
+ $ tt install tt 40e696e
-* Install ``tt`` from a commit with hash ``00a9e59`` on the `tarantool/tt GitHub repository `__:
+* Install Tarantool :ref:`built from sources `:
.. code-block:: console
- $ tt install tt 40e696e
\ No newline at end of file
+ $ tt install tarantool-dev ~/src/tarantool/build
\ No newline at end of file
From 7195aa337d8d69b4f7086e59917d291bf5ba08ff Mon Sep 17 00:00:00 2001
From: Pavel Semyonov
Date: Mon, 15 Jan 2024 20:09:55 +0700
Subject: [PATCH 4/5] Apply suggestions from code review
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
---
doc/reference/tooling/tt_cli/install.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/reference/tooling/tt_cli/install.rst
index b98bf8b404..3be9ee0d3c 100644
--- a/doc/reference/tooling/tt_cli/install.rst
+++ b/doc/reference/tooling/tt_cli/install.rst
@@ -129,7 +129,7 @@ Example
$ tt install tarantool pr/1234
-* Install ``tt`` from a commit with hash ``00a9e59`` on the `tarantool/tt GitHub repository `__:
+* Install ``tt`` from a commit with a hash ``00a9e59`` on the `tarantool/tt GitHub repository `__:
.. code-block:: console
From cfe53a9fdf3fdbffa9d33cdba4e99d6a82691110 Mon Sep 17 00:00:00 2001
From: Pavel Semyonov
Date: Tue, 16 Jan 2024 10:57:28 +0700
Subject: [PATCH 5/5] fix markup
---
doc/reference/tooling/tt_cli/install.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/reference/tooling/tt_cli/install.rst
index 3be9ee0d3c..6343abcd47 100644
--- a/doc/reference/tooling/tt_cli/install.rst
+++ b/doc/reference/tooling/tt_cli/install.rst
@@ -123,13 +123,13 @@ Example
$ tt install tarantool 2.10.8 --reinstall
-* Install Tarantool from a PR #1234 on the `tarantool/tarantool GitHub repository `__:
+* 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 ``00a9e59`` on the `tarantool/tt GitHub repository `__:
+* Install ``tt`` from a commit with a hash ``40e696e`` on the `tarantool/tt `__ GitHub repository:
.. code-block:: console