Skip to content
Snippets Groups Projects
Commit a1fee55c authored by Konstantin Osipov's avatar Konstantin Osipov
Browse files

Manually merge latest changes in the manual with RST docs.

parent 4c877485
No related branches found
No related tags found
No related merge requests found
......@@ -47,9 +47,9 @@ Tarantool is started by entering the command:
scheme, in which ``<major>`` number is changed only rarely, ``<minor>`` is
incremented for each new milestone and indicates possible incompatible
changes, and ``<patch>`` stands for the number of bug fix releases made after
the start of the milestone. The optional commit number and commit SHA1 are
output for non-released versions only, and indicate how much this particular
build has diverged from the last release.
the start of the milestone. For non-released versions only, there may be a
commit number and commit SHA1 to indicate how much this particular build has
diverged from the last release.
“Target” is the platform tarantool was built on. Some platform-specific details
may follow this line.
......@@ -61,7 +61,7 @@ Tarantool is started by entering the command:
`git repository`_.
.. _git describe: http://www.kernel.org/pub/software/scm/git/docs/git-describe.html
.. _git repository: git://github.com/tarantool/tarantool.git
.. _git repository: http://github.com/tarantool/tarantool.git
......@@ -75,10 +75,9 @@ Some configuration parameters and some functions depend on a URI, or
for login, a password, a host name or host IP address, and a port number. Only
the port number is always mandatory. The password is mandatory if the user
name is specified, unless the user name is 'guest'. So, formally, the URI
syntax is ``[host:]port`` or ``[username:password@]host:port`` or if
``username='guest'`` it may be ``[username@]host:port``. If host is omitted,
then 'localhost' is assumed. If username:password is omitted, then 'guest'
is assumed. Some examples:
syntax is ``[host:]port`` or ``[username:password@]host:port``
If host is omitted, then 'localhost' is assumed.
If username:password is omitted, then 'guest' is assumed. Some examples:
.. _generic syntax for a URI schema: http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
......@@ -91,8 +90,6 @@ is assumed. Some examples:
+-----------------------------+------------------------------+
| host:port | 127.0.0.1:3301 |
+-----------------------------+------------------------------+
| guest@host:port | guest@mail.ru:3301 |
+-----------------------------+------------------------------+
| username:password@host:port | notguest:sesame@mail.ru:3301 |
+-----------------------------+------------------------------+
......@@ -121,6 +118,7 @@ server will be used or if ports need to be opened. For example, suppose
}
print('Starting ',arg[1])
and suppose the environment variable LISTEN_URI contains 3301,
and suppose the command line is ``~/tarantool/src/tarantool script.lua ARG``.
Then the screen might look like this:
......@@ -131,7 +129,6 @@ Then the screen might look like this:
... main/101/script.lua C> version 1.6.3-439-g7e1011b
... main/101/script.lua C> log level 5
... main/101/script.lua I> mapping 107374184 bytes for a shared arena...
... main/101/spawner C> initialized
... main/101/script.lua I> recovery start
... main/101/script.lua I> recovering from `./00000000000000000000.snap'
... main/101/script.lua I> primary: bound to 0.0.0.0:3301
......@@ -459,7 +456,7 @@ for binary logging and snapshots, for replication, for networking, and for loggi
Local hot standby is a feature which provides a simple form of failover without
replication. To initiate it, start a second instance of the Tarantool server on
the same computer with the same :func:`box.cfg` configuration settings -
including the same directories and same URIs. A warning should appear with a
including the same directories and same non-null URIs. A warning should appear with a
message like
.. code-block:: lua
......
......@@ -51,7 +51,7 @@ will print “Connection refused”.
0 => {
name => 'primary', fields => [ 'field1' ] } } } } );
$tnt->insert('tester' => [ 99999, 'BB' ]);
$tnt->insert('examples' => [ 99999, 'BB' ]);
The example program only shows one command and does not show all that's
necessary for good practice. For that, please see `DR::Tarantool`_ CPAN repository.
......
......@@ -29,7 +29,7 @@ directory and tell PHP where to find the ``php.ini`` file that contains that lin
cd ~
cp ./tarantool-php/modules/tarantool.so .
export PHP_INI_SCAN_DIR=~/tarantool-php/tests/shared
export PHP_INI_SCAN_DIR=~/tarantool-php/test/shared
Here is a complete PHP program that inserts [99999,'BB'] into a space named 'examples'
via the PHP API. Before trying to run, check that the server is listening and that
......
......@@ -11,7 +11,7 @@ This chapter documents APIs for various programming languages.
Protocol
=====================================================================
Tarantool protocol was designed with focus on asynchronous I/O and easy integration
Tarantool protocol was designed with a focus on asynchronous I/O and easy integration
with proxies. Each client request starts with a variable-length binary header,
containing request id, request type, server id, log sequence number, and so on.
......@@ -33,10 +33,8 @@ in the source tree: please see `doc/box-protocol.html`_.
The Tarantool API exists so that a client program can send a request packet to
the server, and receive a response. Here is an example of a what the client
would send for ``box.space[513]:insert{'A', 'BB'}``. The BNF description of the
components is in file `doc/box-protocol.html`_. A third-party contribution
written in Lua for unpacking Tarantool messages is in file `Tnt-dissector`_.
components is in file `doc/box-protocol.html`_.
.. _Tnt-dissector: https://github.com/negram/Tnt-dissector/blob/master/tarantool.dis.lua
.. _Language-specific drivers: `Connectors`_
.. _doc/box-protocol.html: :doc:`../../dev_guide/box-protocol.rst`
......@@ -64,7 +62,7 @@ Now, one could send that packet to the tarantool server, and interpret the respo
(`doc/box-protocol.html`_ has a description of the packet format for responses as
well as requests). But it would be easier, and less error-prone, if one could invoke
a routine that formats the packet according to typed parameters. Something like
``response=tarantool_routine("insert",0,"A","B");``. And that is why APIs exist for
``response=tarantool_routine("insert",513,"A","B");``. And that is why APIs exist for
drivers for Perl, Python, PHP, and so on.
====================================================================
......
......@@ -71,7 +71,7 @@ For those who like to see things run, here are the exact steps to get
expirationd through the test.
1. Get ``expirationd.lua``. There are standard ways - it is after all part
of a standard rock_ - but for this purpose just copy the contents of
of a standard rock - but for this purpose just copy the contents of
expirationd.lua_ to a default directory.
2. Start the Tarantool server as described before.
3. Execute these requests:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment