@@ -5,7 +5,7 @@ Installing Tarantool software
5
5
6
6
.. code-block :: console
7
7
8
- $ tt install PROGRAM_NAME [VERSION] [OPTION ...]
8
+ $ tt install PROGRAM_NAME [VERSION|COMMIT_OR_PR ] [OPTION ...]
9
9
10
10
``tt install `` installs the latest or an explicitly specified version of Tarantool
11
11
or ``tt ``. The possible values of ``PROGRAM_NAME `` are:
@@ -21,6 +21,11 @@ or ``tt``. The possible values of ``PROGRAM_NAME`` are:
21
21
(see the :ref: `ee section <tt-config_file_ee >` of the configuration file) or
22
22
provide them interactively.
23
23
24
+ Additionally, ``tt install `` can build open source programs ``tarantool `` and ``tt ``
25
+ from a specific commit or a pull request on their GitHub repositories.
26
+
27
+ To uninstall a Tarantool or ``tt `` version, use :doc: `tt uninstall <uninstall >`.
28
+
24
29
Options
25
30
-------
26
31
@@ -66,16 +71,42 @@ dependencies, such as a C compiler. Make sure they are available in the system.
66
71
67
72
Tarantool Enterprise Edition is installed from prebuilt packages.
68
73
74
+ Development versions
75
+ ~~~~~~~~~~~~~~~~~~~~
76
+
77
+ ``tt install `` can be used to build custom Tarantool and ``tt `` versions for
78
+ development purposes. The sources for such version can be either stored locally
79
+ or exist on GitHub (specific commits or pull requests).
80
+
81
+ To build Tarantool from a local source, use the ``tarantool-dev `` program name and
82
+ provide a path to the source:
83
+
84
+ .. code-block :: console
85
+
86
+ $ tt install tarantool-dev ~/src/tarantool/build
87
+
88
+ To build Tarantool or ``tt `` from a specific commit on their GitHub repository,
89
+ pass the commit hash (7 or more characters) after the program name. If you want to use
90
+ a PR as a source, provide a ``pr/<PR_ID> `` argument:
91
+
92
+
93
+ .. code-block :: console
94
+
95
+ $ tt install tarantool 03c184d
96
+ $ tt install tt pr/50
97
+
98
+
99
+ Local repositories
100
+ ~~~~~~~~~~~~~~~~~~
101
+
69
102
You can also set up a local repository with installation files you need.
70
103
To use it, specify its location in the :ref: `repo section <tt-config_file_repo >`
71
104
of the ``tt `` configuration file and run ``tt install `` with the ``--local-repo `` flag.
72
105
73
- To uninstall a Tarantool or ``tt `` version, use :doc: `tt uninstall <uninstall >`.
74
-
75
106
Example
76
107
--------
77
108
78
- * Install the latest available version of Tarantool:
109
+ * Install the latest available version of Tarantool CE :
79
110
80
111
.. code-block :: console
81
112
@@ -98,3 +129,16 @@ Example
98
129
.. code-block :: console
99
130
100
131
$ tt install tarantool-dev ~/src/tarantool/build
132
+
133
+
134
+ * Install Tarantool from a PR #1234 on the `tarantool/tarantool GitHub repository <https://github.com/tarantool/tarantool >`__:
135
+
136
+ .. code-block :: console
137
+
138
+ $ tt install tarantool pr/1234
139
+
140
+ * Install ``tt `` from a commit with hash ``00a9e59 `` on the `tarantool/tt GitHub repository <https://github.com/tarantool/tt >`__:
141
+
142
+ .. code-block :: console
143
+
144
+ $ tt install tt 40e696e
0 commit comments