Update tt commands descriptions to 2.1.2

p7nov · p7nov · commit c8d3d46abd44 · 2024-02-13T16:35:40.000+07:00
diff --git a/doc/reference/tooling/tt_cli/check.rst b/doc/reference/tooling/tt_cli/check.rst
@@ -5,52 +5,40 @@ Checking an application file
 
 ..  code-block:: console
 
-    $ tt check {INSTANCE | APPLICATION[:APP_INSTANCE]}
+    $ tt check {APPLICATION[:APP_INSTANCE] | SINGLE_INSTANCE}
 
-``tt check`` checks the specified Tarantool application or instance for syntax errors.
+``tt check`` checks the syntax correctness of Lua files within Tarantool applications
+or separate Lua scripts. The files must be stored inside the ``instances_enabled``
+directory specified in the :ref:`tt configuration file <tt-config_file_app>`.
 
-Details
--------
+Cluster applications
+--------------------
 
-``tt`` searches for ``APP_FILE`` inside the ``instances_enabled`` directory
-specified in the :ref:`tt configuration file <tt-config_file_app>`. ``APP_FILE`` can be:
+To check all Lua files in an application directory at once, specify the directory name:
 
-*   the name of an application file without the ``.lua`` extension.
-*   the name of a directory containing the ``init.lua`` file. In this case, ``init.lua`` is checked.
-
-
-Examples
---------
-
-Single instance
-~~~~~~~~~~~~~~~
-
-*   Check the syntax of the ``app.lua`` file from the ``instances_enabled`` directory:
-
-    ..  code-block:: console
+..  code-block:: console
 
-        $ tt check app
+    $ tt check app
 
+To check a single Lua file from an application directory, add the path to this file:
 
-*   Check the syntax of the ``init.lua`` file from the ``instance1/`` directory inside ``instances_enabled``:
+..  code-block:: console
 
-    ..  code-block:: console
+    $ tt check app/router
+    # or
+    $ tt check app/router.lua
 
-        $ tt check instance1
+.. note::
 
-Multiple instances
-~~~~~~~~~~~~~~~~~~
+    The ``.lua`` extension can be omitted.
 
-*   Check all source files of the application stored in the ``app/`` directory inside
-    ``instances_enabled`` in accordance with the :ref:`instances configuration <tt-instances>`:
+Single instances
+----------------
 
-    ..  code-block:: console
+To check the syntax of a single Lua file, specify the path from ``instances_enabled`` to this file:
 
-        $ tt check app
+..  code-block:: console
 
-*   Check the source of the ``master`` instance of the application stored in the
-    ``app/`` directory inside ``instances_enabled``:
+    $ tt check app.lua
 
-    ..  code-block:: console
 
-        $ tt check app:master
diff --git a/doc/reference/tooling/tt_cli/clean.rst b/doc/reference/tooling/tt_cli/clean.rst
@@ -5,12 +5,15 @@ Cleaning instance files
 
 ..  code-block:: console
 
-    $ tt clean {INSTANCE | APPLICATION[:APP_INSTANCE]} [OPTION ...]
+    $ tt clean {APPLICATION[:APP_INSTANCE]} [OPTION ...]
 
 ``tt clean`` cleans stored files of Tarantool instances: logs, snapshots, and
 other files. To avoid accidental deletion of files, ``tt clean`` shows
 the files it is going to delete and asks for confirmation.
 
+When called without arguments, cleans files of all applications in the current environment.
+
+
 Options
 -------
 
@@ -22,18 +25,6 @@ Options
 Examples
 --------
 
-Single instance
-~~~~~~~~~~~~~~~
-
-*   Clean the files of the ``app`` instance:
-
-    ..  code-block:: console
-
-        $ tt clean app
-
-Multiple instances
-~~~~~~~~~~~~~~~~~~
-
 *   Clean the files of all instances of the ``app`` application:
 
     ..  code-block:: console
diff --git a/doc/reference/tooling/tt_cli/connect.rst b/doc/reference/tooling/tt_cli/connect.rst
@@ -5,7 +5,7 @@ Connecting to a Tarantool instance
 
 ..  code-block:: console
 
-    $ tt connect {URI|INSTANCE} [OPTION ...]
+    $ tt connect {URI|INSTANCE_NAME} [OPTION ...]
 
 
 ``tt connect`` connects to a Tarantool instance by its URI or instance name specified
diff --git a/doc/reference/tooling/tt_cli/create.rst b/doc/reference/tooling/tt_cli/create.rst
@@ -176,32 +176,32 @@ flag to disable the interactive input. In this case, the values are searched in
         version=2
 
 If a variable isn't initialized in any of these ways, the default value
-from the manifest will be used.
+from the manifest is used.
 
 You can combine different ways of passing variables in a single call of ``tt create``.
 
 Application directory
 ~~~~~~~~~~~~~~~~~~~~~
 
-By default, the application will appear in the directory named after the provided
+By default, the application appears in the directory named after the provided
 application name (``--name`` value).
 
 To change the application location, use the ``-dst`` flag.
 
 Examples
 --------
 
-*   Create the application ``app1`` from the ``simple_app`` template in the current directory:
+*   Create the application ``app1`` from the ``simple_app`` user-defined template in the current directory:
 
     ..  code-block:: console
 
         $ tt create simple_app --name app1
 
 
-*   Create the ``app1`` application in ``/opt/tt/apps/``, set the ``user_name``
-    variable to ``admin``, force rewrite the application directory if it already exists.
+*   Create the ``app1`` application in ``/opt/tt/apps/`` from the built-in ``vshard_cluster`` template,
+    force rewrite the application directory if it already exists.
     User interaction is disabled.
 
     ..  code-block:: console
 
-        $ tt create cartridge --name app1 --var user_name=admin -f --non-interactive -dst /opt/tt/apps/
+        $ tt create vshard_cluster --name app1 -f --non-interactive -dst /opt/tt/apps/
diff --git a/doc/reference/tooling/tt_cli/export.rst b/doc/reference/tooling/tt_cli/export.rst
@@ -11,7 +11,7 @@ Exporting data
 
 ..  code-block:: console
 
-    $ tt [crud] export URI FILE SPACE [EXPORT_OPTION ...]
+    $ tt [crud] export URI SPACE:FILE ... [EXPORT_OPTION ...]
 
 ``tt [crud] export`` exports a space's data to a file.
 The ``crud`` command is optional and can be used to export a cluster's data by using the `CRUD <https://github.com/tarantool/crud>`_ module. Without ``crud``, data is exported using the :ref:`box.space <box_space>` API.
@@ -43,7 +43,7 @@ The command below exports data of the ``customers`` space to the ``customers.csv
 
 .. code-block:: console
 
-    $ tt crud export localhost:3301 customers.csv customers
+    $ tt crud export localhost:3301 customers:customers.csv
 
 If the ``customers`` space has five fields (``id``, ``bucket_id``, ``firstname``, ``lastname``, and ``age``), the file with exported data might look like this:
 
@@ -70,7 +70,7 @@ To export data with a space's field names in the first row, use the ``--header``
 
 .. code-block:: console
 
-    $ tt crud export localhost:3301 customers.csv customers \
+    $ tt crud export localhost:3301 customers:customers.csv  \
                      --header
 
 In this case, field values start from the second row, for example:
@@ -95,7 +95,7 @@ For example, the command below exports compound values serialized in JSON:
 
 .. code-block:: console
 
-    $ tt crud export localhost:3301 customers.csv customers \
+    $ tt crud export localhost:3301 customers:customers.csv  \
                      --compound-value-format json
 
 
diff --git a/doc/reference/tooling/tt_cli/import.rst b/doc/reference/tooling/tt_cli/import.rst
@@ -11,9 +11,9 @@ Importing data
 
 .. code-block:: console
 
-    $ tt [crud] import URI FILE SPACE [IMPORT_OPTION ...]
+    $ tt [crud] import URI FILE:SPACE [IMPORT_OPTION ...]
     # or
-    $ tt [crud] import URI - SPACE < FILE [IMPORT_OPTION ...]
+    $ tt [crud] import URI :SPACE < FILE [IMPORT_OPTION ...]
 
 ``tt [crud] import`` imports data from a file to a space.
 The ``crud`` command is optional and can be used to import data to a cluster by using the `CRUD <https://github.com/tarantool/crud>`_ module. Without ``crud``, data is imported using the :ref:`box.space <box_space>` API.
@@ -62,7 +62,7 @@ If the target ``customers`` space has fields with the same names, you can import
 
 .. code-block:: console
 
-    $ tt crud import localhost:3301 customers.csv customers \
+    $ tt crud import localhost:3301 customers.csv:customers \
                      --header \
                      --match=header
 
@@ -92,15 +92,15 @@ you can configure mapping as follows:
 
 .. code-block:: console
 
-    $ tt crud import localhost:3301 customers.csv customers \
+    $ tt crud import localhost:3301 customers.csv:customers \
                      --header \
                      --match "id=customer_id;firstname=name;lastname=surname;age=customer_age"
 
 Similarly, you can configure mapping using numeric field positions in the input file:
 
 .. code-block:: console
 
-    $ tt crud import localhost:3301 customers.csv customers \
+    $ tt crud import localhost:3301 customers.csv:customers \
                      --header \
                      --match "id=1;firstname=2;lastname=3;age=4"
 
@@ -119,7 +119,7 @@ In the example below, values already existing in the space are replaced with new
 
 .. code-block:: console
 
-    $ tt crud import localhost:3301 customers.csv customers \
+    $ tt crud import localhost:3301 customers.csv:customers \
                      --on-exist replace
 
 .. _tt-import-parsing-error:
@@ -131,7 +131,7 @@ To skip rows whose data cannot be parsed correctly, use the ``--on-error`` optio
 
 .. code-block:: console
 
-    $ tt crud import localhost:3301 customers.csv customers \
+    $ tt crud import localhost:3301 customers.csv:customers \
                      --on-error skip
 
 
@@ -156,7 +156,7 @@ Options
 
     .. code-block:: console
 
-        $ tt crud import localhost:3301 customers.csv customers \
+        $ tt crud import localhost:3301 customers.csv:customers \
                          --delimiter tab
 
     .. NOTE::
diff --git a/doc/reference/tooling/tt_cli/instances.rst b/doc/reference/tooling/tt_cli/instances.rst
@@ -7,7 +7,8 @@ Listing enabled applications
 
     $ tt instances
 
-``tt instances`` shows the list of enabled applications.
+``tt instances`` shows the list of enabled applications and their instances
+in the current environment.
 
 .. note::
 
@@ -19,7 +20,7 @@ Listing enabled applications
 Example
 --------
 
-*   Show the list of enabled applications:
+*   Show the list of enabled applications and their instances:
 
     ..  code-block:: console
 
diff --git a/doc/reference/tooling/tt_cli/logrotate.rst b/doc/reference/tooling/tt_cli/logrotate.rst
@@ -5,7 +5,7 @@ Rotating instance logs
 
 ..  code-block:: console
 
-    $ tt logrotate {INSTANCE | APPLICATION[:APP_INSTANCE]}
+    $ tt logrotate {APPLICATION[:APP_INSTANCE] | SINGLE_INSTANCE}
 
 ``tt logrotate`` rotates logs of a Tarantool application or specific instances,
 and the ``tt`` log. For example, you need to call this function to continue logging
diff --git a/doc/reference/tooling/tt_cli/restart.rst b/doc/reference/tooling/tt_cli/restart.rst
@@ -5,43 +5,43 @@ Restarting a Tarantool instance
 
 ..  code-block:: console
 
-    $ tt restart {INSTANCE | APPLICATION[:APP_INSTANCE]} [OPTION ...]
+    $ tt restart {APPLICATION[:APP_INSTANCE] | SINGLE_INSTANCE} [OPTION ...]
 
 ``tt restart`` restarts the specified running Tarantool instance.
 A ``tt restart`` call is equivalent to consecutive calls of
 :doc:`tt stop <stop>` and :doc:`tt start <start>`.
 
-Options
--------
+When called without arguments, restarts all running applications in the current environment.
 
-..  option:: -y, --yes
+Cluster application
+-------------------
 
-    Automatic "Yes" to confirmation prompt.
+To restart all instances of the application stored in the ``app/`` directory inside
+``instances_enabled`` in accordance with the :ref:`instances configuration <tt-instances>`:
 
-Examples
---------
+..  code-block:: console
 
-Single instance
-~~~~~~~~~~~~~~~
+    $ tt restart app
 
-Restart the ``app`` instance with automatic confirmation:
+To restart only the ``master`` instance of the application stored in the ``app/`` directory inside ``instances_enabled``:
 
 ..  code-block:: console
 
-    $ tt restart app -y
+    $ tt restart app:master
 
-Multiple instances
-~~~~~~~~~~~~~~~~~~
+Single instance
+---------------
 
-*   Restart all instances of the application stored in the ``app/`` directory inside
-    ``instances_enabled`` in accordance with the :ref:`instances configuration <tt-instances>`:
+Restart the ``instance1`` instance with automatic confirmation:
 
-    ..  code-block:: console
+..  code-block:: console
+
+    $ tt restart instance1 -y
 
-        $ tt restart app
+Options
+-------
 
-*   Restart only the ``master`` instance of the application stored in the ``app/`` directory inside ``instances_enabled``:
+..  option:: -y, --yes
 
-    ..  code-block:: console
+    Automatic "Yes" to confirmation prompt.
 
-        $ tt restart app:master
diff --git a/doc/reference/tooling/tt_cli/run.rst b/doc/reference/tooling/tt_cli/run.rst
@@ -7,7 +7,7 @@ Running code in a Tarantool instance
 
     $ tt run [SCRIPT|-e EXPR] [OPTION ...]
 
-``tt run`` executes Lua code in a Tarantool instance.
+``tt run`` executes Lua code in a new Tarantool instance.
 
 Options
 -------
diff --git a/doc/reference/tooling/tt_cli/start.rst b/doc/reference/tooling/tt_cli/start.rst
diff --git a/doc/reference/tooling/tt_cli/status.rst b/doc/reference/tooling/tt_cli/status.rst
diff --git a/doc/reference/tooling/tt_cli/stop.rst b/doc/reference/tooling/tt_cli/stop.rst
