Skip to content

Polish tt reference: options formatting, terminology, code blocks #3749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Oct 3, 2023
Merged

Polish tt reference: options formatting, terminology, code blocks #3749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
4e01139
Fix options formatting in tt reference
p7nov Oct 2, 2023
6721961
Fix options formatting in tt reference
p7nov Oct 2, 2023
03fe521
Fix options formatting in tt reference
p7nov Oct 2, 2023
ae19df9
Fix options formatting in tt reference
p7nov Oct 2, 2023
f403f1f
Fix page name
p7nov Oct 2, 2023
46ec587
Fix links to renamed pages
p7nov Oct 2, 2023
3426309
Fix
p7nov Oct 2, 2023
07eedc0
Apply suggestions from code review
p7nov Oct 3, 2023
f58c032
test subheadings instead of tables
p7nov Oct 3, 2023
508c84b
test subheadings instead of tables
p7nov Oct 3, 2023
66d37d8
fix
p7nov Oct 3, 2023
c01689e
Convert H4 to H3 in cartridge.rst
p7nov Oct 3, 2023
451aaea
Fix article
p7nov Oct 3, 2023
f899181
fix
p7nov Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions doc/reference/tooling/tt_cli/arguments.rst
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions doc/reference/tooling/tt_cli/binaries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Showing a list of installed binaries
====================================

.. code-block:: bash
.. code-block:: console

tt binaries
$ tt binaries

``tt binaries`` shows a list of installed binaries and their versions.

Expand All @@ -14,9 +14,9 @@ Examples

Show a list of installed Tarantool versions:

.. code-block:: bash
.. code-block:: console

user@sample-server:~/test-env$ tt binaries
$ tt binaries
List of installed binaries:
• tarantool:
2.11.1 [active]
Expand Down
30 changes: 12 additions & 18 deletions doc/reference/tooling/tt_cli/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,19 @@
Building an application
=======================

.. code-block:: bash
.. code-block:: console

tt build [PATH] [flags]
$ tt build [PATH] [--spec SPEC_FILE_PATH]


``tt build`` builds a Tarantool application locally.

Flags
-----

.. container:: table

.. list-table::
:widths: 30 70
:header-rows: 0
Options
-------

* - ``--spec``
- Path to a ``.rockspec`` file to use for the current build
.. option:: --spec SPEC_FILE_PATH

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

Details
-------
Expand Down Expand Up @@ -68,18 +62,18 @@ Examples

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

.. code-block:: bash
.. code-block:: console

tt build
$ tt build

* Build the application ``app1`` from the ``simple_app`` directory inside the current directory:

.. code-block:: bash
.. code-block:: console

tt build simple_app
$ tt build simple_app

* Build the application ``app1`` from its directory explicitly specifying the rockspec file to use:

.. code-block:: bash
.. code-block:: console

tt build --spec app1-scm-1.rockspec
$ tt build --spec app1-scm-1.rockspec
Loading