@@ -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_HASH|PR_ID ] [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,41 @@ 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 from commits and pull requests on their GitHub repositories.
79
+
80
+ To build Tarantool or ``tt `` from a specific commit on their GitHub repository,
81
+ pass the commit hash (7 or more characters) after the program name. If you want to use
82
+ a PR as a source, provide a ``pr/<PR_ID> `` argument:
83
+
84
+
85
+ .. code-block :: console
86
+
87
+ $ tt install tarantool 03c184d
88
+ $ tt install tt pr/50
89
+
90
+ If you :ref: `build Tarantool from sources <building_from_source >`, you can install
91
+ local builds to the current ``tt `` environment by running ``tt install `` with
92
+ the ``tarantool-dev `` program name and the path to the build:
93
+
94
+ .. code-block :: console
95
+
96
+ $ tt install tarantool-dev ~/src/tarantool/build
97
+
98
+ Local repositories
99
+ ~~~~~~~~~~~~~~~~~~
100
+
69
101
You can also set up a local repository with installation files you need.
70
102
To use it, specify its location in the :ref: `repo section <tt-config_file_repo >`
71
103
of the ``tt `` configuration file and run ``tt install `` with the ``--local-repo `` flag.
72
104
73
- To uninstall a Tarantool or ``tt `` version, use :doc: `tt uninstall <uninstall >`.
74
-
75
105
Example
76
106
--------
77
107
78
- * Install the latest available version of Tarantool:
108
+ * Install the latest available version of Tarantool CE :
79
109
80
110
.. code-block :: console
81
111
@@ -93,8 +123,20 @@ Example
93
123
94
124
$ tt install tarantool 2.10.8 --reinstall
95
125
126
+ * Install Tarantool from a PR #1234 on the `tarantool/tarantool <https://github.com/tarantool/tarantool >`__ GitHub repository:
127
+
128
+ .. code-block :: console
129
+
130
+ $ tt install tarantool pr/1234
131
+
132
+ * Install ``tt `` from a commit with a hash ``40e696e `` on the `tarantool/tt <https://github.com/tarantool/tt >`__ GitHub repository:
133
+
134
+ .. code-block :: console
135
+
136
+ $ tt install tt 40e696e
137
+
96
138
* Install Tarantool :ref: `built from sources <building_from_source >`:
97
139
98
140
.. code-block :: console
99
141
100
- $ tt install tarantool-dev ~/src/tarantool/build
142
+ $ tt install tarantool-dev ~/src/tarantool/build
0 commit comments