diff --git a/doc/sphinx/book/app_a_errcodes.rst b/doc/sphinx/book/app_a_errcodes.rst index e89a7c33ea6171344e1a4bd689bfb93ae6d84596..cdcdadbdddc4131019794a11515415457f4528eb 100644 --- a/doc/sphinx/book/app_a_errcodes.rst +++ b/doc/sphinx/book/app_a_errcodes.rst @@ -27,7 +27,7 @@ ER_ILLEGAL_PARAMS Illegal parameters. Malformed protocol message. ER_MEMORY_ISSUE - Out of memory: :ref:`slab_alloc_arena` limit is reached. + Out of memory: :ref:`slab_alloc_arena <slab_alloc_arena>` limit is reached. ER_WAL_IO Failed to write to disk. May mean: failed to record a change in the diff --git a/doc/sphinx/book/app_d_plugins.rst b/doc/sphinx/book/app_d_plugins.rst index 8fc5f0ce5248a23e6d9495321ac37233ada65201..b5f4b055c8b7096a5bd343ad48f468b240ae375c 100644 --- a/doc/sphinx/book/app_d_plugins.rst +++ b/doc/sphinx/book/app_d_plugins.rst @@ -49,7 +49,7 @@ This example assumes that MySQL 5.5 or MySQL 5.6 has been installed (recent MariaDB versions should also work). The example was run on a Linux machine where the base directory had a copy of -he Tarantool source on ~/tarantool, and a copy of MySQL on ~/mysql-5.5. The +the Tarantool source on ~/tarantool, and a copy of MySQL on ~/mysql-5.5. The mysqld server is already running on the local host 127.0.0.1. :: @@ -74,14 +74,12 @@ mysqld server is already running on the local host 127.0.0.1. ... Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - mysql> - # Insert a row in database test, and quit. mysql> CREATE TABLE IF NOT EXISTS test (s1 INT, s2 VARCHAR(50)); Query OK, 0 rows affected (0.13 sec) mysql> INSERT INTO test.test VALUES (1,'MySQL row'); Query OK, 1 row affected (0.02 sec) - mysql> QUIT + mysql> **QUIT** Bye # Build the Tarantool server. Make certain that "cmake" gets the right diff --git a/doc/sphinx/book/box/box_space.rst b/doc/sphinx/book/box/box_space.rst index 6e4d4e9b38ad6dee4f0a12d30edc22fb43d34e60..d8f2c69f043e7365fe1ff5097b95ad8aae4ac1f3 100644 --- a/doc/sphinx/book/box/box_space.rst +++ b/doc/sphinx/book/box/box_space.rst @@ -148,7 +148,7 @@ A list of all ``box.space`` functions follows, then comes a list of all - [2, 'D'] ... - For examples of complex ``select``s, where one can specify which index to + For examples of complex ``select`` requests, where one can specify which index to search and what condition to use (for example "greater than" instead of "equal to") and how many tuples to return, see the later section ``box.space.space-name[.index.index-name]:select``. diff --git a/doc/sphinx/book/box/triggers.rst b/doc/sphinx/book/box/triggers.rst index da039f234ffcb429abd4d7e1aa7a25d8980059f3..0735e9542c239b19ad80a692c928ab6875991a29 100644 --- a/doc/sphinx/book/box/triggers.rst +++ b/doc/sphinx/book/box/triggers.rst @@ -16,7 +16,7 @@ All triggers have the following characteristics. * They associate a function with an `event`. The request to "define a trigger" consists of passing the name of the trigger's function to one of the - "on_``event-name...``" functions: ``on_connect()``, ``on_disconnect()``, + "on_event-name..." functions: ``on_connect()``, ``on_disconnect()``, or ``on_replace()``. * They are `defined by any user`. There are no privilege requirements for defining triggers. @@ -38,7 +38,7 @@ All triggers have the following characteristics. outside the event context. * They are `replaceable`. The request to "redefine a trigger" consists of passing the names of a new trigger function and an old trigger function to one of the - "on_``event-name...``" functions. + "on_event-name..." functions. =========================================================== Connection triggers diff --git a/doc/sphinx/book/intro.rst b/doc/sphinx/book/intro.rst index 64a093dda00359c67a00bb45afc7b5839437c76b..ff67fadbb150de5f0bee12e8b6e6d952a802c6fe 100644 --- a/doc/sphinx/book/intro.rst +++ b/doc/sphinx/book/intro.rst @@ -15,7 +15,7 @@ is an established NoSQL DBMS. Thus it serves all the purposes that have made nod and Twisted popular in other environments, with the additional twist that it has a data persistence level. -The code is free. The open-source license is *`BSD license`_*. The supported platforms +The code is free. The open-source license is `BSD license`_. The supported platforms are GNU/Linux, Mac OS and FreeBSD. Tarantool database is deeply integrated with the application server. On diff --git a/doc/sphinx/faq.rst b/doc/sphinx/faq.rst index 54161b0faaf2b9e878eb57d1e5a384a5322e93d9..b717708ef1a1d1d55206c823416b9f420aeae982 100644 --- a/doc/sphinx/faq.rst +++ b/doc/sphinx/faq.rst @@ -16,15 +16,15 @@ :Q: Why Lua? - :A: Lua is a ligthweight, fast, extensible multi-paradigm language. Lua also happens + :A: Lua is a lightweight, fast, extensible multi-paradigm language. Lua also happens to be very easy to embed. Lua coroutines relate very closely to Tarantool fibers, - and Lua architecture works well with Tarantool internals. Lua is the first, but, - hopefully, not the last stored program language for Tarantool. + and Lua architecture works well with Tarantool internals. Lua is the first, but + hopefully not the last, stored program language for Tarantool. :Q: What's the key advantage of Tarantool? :A: Tarantool provides a rich database feature set (HASH, TREE, RTREE, BITSET indexes, - secondary indexes, composite indexes, transactions, triggres, asynchronous replication) + secondary indexes, composite indexes, transactions, triggers, asynchronous replication) in a flexible environment of a Lua interpreter. These two properties make it possible to code fast, atomic and reliable in-memory @@ -41,17 +41,17 @@ :Q: Who is developing Tarantool? - :A: There is a small engineering team employed by Mail.ru -- check out our commit + :A: There is a small engineering team employed by Mail.Ru -- check out our commit logs on github. The development is fully open, and most of the connectors - authors and maintainers in different distributions are from the community. + authors and maintainers for different distributions are from the community. :Q: How serious is Mail.Ru about Tarantool? :A: Tarantool is an open source project, distributed under a BSD license, and as - such does not depend on any one sponsor. However, it is currently and integral - part of Mail.Ru backbone, so it gets a lot of support from Mail.ru. + such does not depend on any one sponsor. However, it is currently an integral + part of Mail.Ru backbone, so it gets a lot of support from Mail.Ru. :Q: What happens when Tarantool runs out of memory? :A: The server stops accepting updates until more memory is available. Read and - delete requests are served just fine. + delete requests continue to be served without difficulty. diff --git a/doc/sphinx/intro.rst b/doc/sphinx/intro.rst index ca69eeb2b2f723b3aec0463231b4c367b9a1e7b0..652f5d28333e1fc92c793053a8cdcaf702bc03be 100644 --- a/doc/sphinx/intro.rst +++ b/doc/sphinx/intro.rst @@ -12,7 +12,7 @@ is an established NoSQL DBMS. Thus it serves all the purposes that have made nod and Twisted popular in other environments, with the additional twist that it has a data persistence level. -The code is free. The open-source license is *`BSD license`_*. The supported platforms +The code is free. The open-source license is `BSD license`_. The supported platforms are GNU/Linux, Mac OS and FreeBSD. Tarantool database is deeply integrated with the application server. On