diff --git a/doc/sphinx/book/administration.rst b/doc/sphinx/book/administration.rst index f6417baf8825a2f29ce5dac65701495cc8577e24..67bab6bac14621e8c7644c13006e872c2a3666fb 100644 --- a/doc/sphinx/book/administration.rst +++ b/doc/sphinx/book/administration.rst @@ -261,7 +261,7 @@ and checking status. in the current directory (:codenormal:`$PWD/.tarantoolctl`). If that fails, it looks in the current user's home directory (:codenormal:`$HOME/.config/tarantool/tarantool`). If that fails, it looks in the SYSCONFDIR directory (usually :codenormal:`/etc/sysconfig/tarantool` -but it may be different on some platforms)." +but it may be different on some platforms). Most of the settings are similar to the settings used by ``box.cfg{...};`` however, tarantoolctl adjusts some of them by adding an application name. diff --git a/doc/sphinx/book/box/box_index.rst b/doc/sphinx/book/box/box_index.rst index d010e05f88a908577269768b28b4ca7759eeb473..8a695caa3994a6ba2b6130a5bad73fb7f5a423a3 100644 --- a/doc/sphinx/book/box/box_index.rst +++ b/doc/sphinx/book/box/box_index.rst @@ -1,3 +1,5 @@ +.. _box_index: + ------------------------------------------------------------------------------- Package `box.index` ------------------------------------------------------------------------------- diff --git a/doc/sphinx/book/box/box_space.rst b/doc/sphinx/book/box/box_space.rst index b972afa96af57534b49cf0df4eab644cce5637d0..9dc2b7df86af542e26f15fd22c0d5901b02f3252 100644 --- a/doc/sphinx/book/box/box_space.rst +++ b/doc/sphinx/book/box/box_space.rst @@ -63,13 +63,13 @@ A list of all ``box.space`` functions follows, then comes a list of all | :func:`space_object:truncate() | Delete all tuples | | <space_object.truncate>` | | +--------------------------------------+---------------------------------+ - | :func:`space_object:inc{} | Increment a tuple's counter | + | :func:`space_object:inc() | Increment a tuple's counter | | <space_object.inc>` | | +--------------------------------------+---------------------------------+ - | :func:`space_object:dec{} | Decrement a tuple's counter | + | :func:`space_object:dec() | Decrement a tuple's counter | | <space_object.dec>` | | +--------------------------------------+---------------------------------+ - | :func:`space_object:auto_increment{} | Generate key + Insert a tuple | + | :func:`space_object:auto_increment() | Generate key + Insert a tuple | | <space_object.auto_increment>` | | +--------------------------------------+---------------------------------+ | :func:`space_object:pairs() | Prepare for iterating | @@ -666,8 +666,8 @@ A list of all ``box.space`` functions follows, then comes a list of all .. data:: index - A container for all defined indexes. An index is a Lua object of type - :mod:`box.index` with methods to search tuples and iterate over them in + A container for all defined indexes. There is a Lua object of type + :ref:`box.index <box_index>` with methods to search tuples and iterate over them in predefined order. Parameters: :samp:`{space_object}` = an :ref:`object reference <object-reference>`. diff --git a/doc/sphinx/book/box/index.rst b/doc/sphinx/book/box/index.rst index 2c2419c1f6eb803c76528f8efa10c6e19d209be0..431d45f5216ac71d8103b3b412cb24b909c2eae3 100644 --- a/doc/sphinx/book/box/index.rst +++ b/doc/sphinx/book/box/index.rst @@ -360,7 +360,7 @@ is lost when the power goes off, Tarantool recovers it automatically when it starts up again, by reading the WAL files and redoing the requests (this is called the "recovery process"). Users can change the timing of the WAL writer, -or turn it off, by setting :confval:`wal_mode <wal_mode>`. +or turn it off, by setting :ref:`wal_mode <confval-wal-mode>`. Tarantool also maintains a set of snapshot files. A snapshot file is an on-disk copy of the entire data set for a given moment. @@ -625,8 +625,8 @@ introspection (inspecting contents of spaces, accessing server configuration). | | important than the others. | +-------------------+-----------------------------------------------------+ | WAL settings | The important setting for the write-ahead log is | - | | :ref:`wal_mode <wal_mode>`. If the setting causes | - | | no writing or | + | | :ref:`wal_mode <confval-wal-mode>`. If the setting | + | | causes no writing or | | | delayed writing, this factor is unimportant. If the | | | setting causes every data-change request to wait | | | for writing to finish on a slow device, this factor |