Skip to content

Commit d64ca9b

Browse files
p7novandreyaksenov
andauthored
Polish tt reference: options formatting, terminology, code blocks (#3749)
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
1 parent 80751a5 commit d64ca9b

32 files changed

+697
-619
lines changed

doc/reference/tooling/tt_cli/arguments.rst

Lines changed: 0 additions & 33 deletions
This file was deleted.

doc/reference/tooling/tt_cli/binaries.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Showing a list of installed binaries
44
====================================
55

6-
.. code-block:: bash
6+
.. code-block:: console
77
8-
tt binaries
8+
$ tt binaries
99
1010
``tt binaries`` shows a list of installed binaries and their versions.
1111

@@ -14,9 +14,9 @@ Examples
1414

1515
Show a list of installed Tarantool versions:
1616

17-
.. code-block:: bash
17+
.. code-block:: console
1818
19-
user@sample-server:~/test-env$ tt binaries
19+
$ tt binaries
2020
List of installed binaries:
2121
• tarantool:
2222
2.11.1 [active]

doc/reference/tooling/tt_cli/build.rst

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,19 @@
33
Building an application
44
=======================
55

6-
.. code-block:: bash
6+
.. code-block:: console
77
8-
tt build [PATH] [flags]
8+
$ tt build [PATH] [--spec SPEC_FILE_PATH]
99
1010
1111
``tt build`` builds a Tarantool application locally.
1212

13-
Flags
14-
-----
15-
16-
.. container:: table
17-
18-
.. list-table::
19-
:widths: 30 70
20-
:header-rows: 0
13+
Options
14+
-------
2115

22-
* - ``--spec``
23-
- Path to a ``.rockspec`` file to use for the current build
16+
.. option:: --spec SPEC_FILE_PATH
2417

18+
Path to a ``.rockspec`` file to use for the current build
2519

2620
Details
2721
-------
@@ -68,18 +62,18 @@ Examples
6862

6963
* Build the application ``app1`` from its directory:
7064

71-
.. code-block:: bash
65+
.. code-block:: console
7266
73-
tt build
67+
$ tt build
7468
7569
* Build the application ``app1`` from the ``simple_app`` directory inside the current directory:
7670

77-
.. code-block:: bash
71+
.. code-block:: console
7872
79-
tt build simple_app
73+
$ tt build simple_app
8074
8175
* Build the application ``app1`` from its directory explicitly specifying the rockspec file to use:
8276

83-
.. code-block:: bash
77+
.. code-block:: console
8478
85-
tt build --spec app1-scm-1.rockspec
79+
$ tt build --spec app1-scm-1.rockspec

0 commit comments

Comments
 (0)