fixes gh-1685 Split all box topics for version 2.6 (#1766)

* cherry-pick unchanged files from 1.10

successfully cherry-picked

* box_txn_management,

* box_ctl,

* box_backup

* files with :doc: links

* split box_error + translate + replace :ref: with :doc:

* split box_slab + translate + replace :ref: with :doc:

* split box_info + translate + replace :ref: with :doc:

* split box_session + translate + replace :ref: with :doc:

* split box_schema_sequence + translate + replace :ref: with :doc:

* split box_schema

* add missing functions for box_ctl

* box_schema translate + replace :ref: with :doc:

* split box_index

* box_index translate + replace :ref: with :doc:

* small fixes

* split box_tuple

* box_tuple translate + replace :ref: with :doc:

* split box_space + replace :ref: with :doc: (!!) a lot of fuzzy statements are left

* split SQL functions + replace :ref: with :doc:

* bugfix

* remove unnecessary sphinx directive

Author: Onvember

doc/book/admin/backups.rst

@@ -15,12 +15,12 @@ any time, with minimal overhead on database performance.
 
 Two functions are helpful for backups in certain situations:
 
-* :ref:`box.backup.start() <reference_lua-box_backup-backup_start>` informs
+* :doc:`/reference/reference_lua/box_backup/start` informs
   the server that activities related to the removal of outdated backups must
   be suspended and returns a table with the names of snapshot and vinyl files
   that should be copied.
 
-* :ref:`box.backup.stop() <reference_lua-box_backup-backup_stop>` later informs
+* :doc:`/reference/reference_lua/box_backup/stop` later informs
   the server that normal operations may resume.
 
 .. _admin-backups-hot_backup_memtx:
@@ -60,15 +60,17 @@ checkpoint.
 
 To take a mixed backup:
 
-1. Issue :ref:`box.backup.start() <reference_lua-box_backup-backup_start>` on the
+1. Issue :doc:`/reference/reference_lua/box_backup/start` on the
    :ref:`administrative console <admin-security>`. This will return a list of
-   files to back up and suspend garbage collection for them till the next ``box.backup.stop()``.
+   files to back up and suspend garbage collection for them till the next
+   ``box.backup.stop()``.
 
 2. Copy the files from the list to a safe location. This will include memtx
    snapshot files, vinyl run and index files, at a state consistent with the
    last checkpoint.
 
-3. Issue ``box.backup.stop()`` so the garbage collector can continue as usual.
+3. Issue :doc:`/reference/reference_lua/box_backup/stop` so the garbage
+   collector can continue as usual.
 
 .. _admin-backups-cont_remote_backup_memtx:
 

doc/book/admin/daemon_supervision.rst

@@ -26,7 +26,7 @@ processor thread:
     |                     | reference on Tarantool logging parameters.           |
     +---------------------+------------------------------------------------------+
     | SIGUSR1             | May cause a database checkpoint. See                 |
-    |                     | :ref:`box.snapshot <box-snapshot>`.                  |
+    |                     | :doc:`/reference/reference_lua/box_snapshot`.        |
     +---------------------+------------------------------------------------------+
     | SIGTERM             | May cause graceful shutdown (information will be     |
     |                     | saved first).                                        |

doc/book/admin/disaster_recovery.rst

@@ -113,9 +113,9 @@ The following steps are applicable only to data in memtx storage engine.
 Your actions:
 
 1. Put all nodes in :ref:`read-only mode <cfg_basic-read_only>` and disable
-   deletion of expired checkpoints with :ref:`box.backup.start() <reference_lua-box_backup-backup_start>`.
+   deletion of expired checkpoints with :doc:`/reference/reference_lua/box_backup/start`.
    This will prevent the Tarantool garbage collector from removing files
-   made with older checkpoints until :ref:`box.backup.stop() <reference_lua-box_backup-backup_stop>` is called.
+   made with older checkpoints until :doc:`/reference/reference_lua/box_backup/stop` is called.
 
 2. Get the latest valid :ref:`.snap file <internals-snapshot>` and
    use ``tarantoolctl cat`` command to calculate at which lsn the data loss occurred.

doc/book/admin/instance_config.rst

@@ -76,7 +76,7 @@ file is often provided by a developer, in a Lua rock or an rpm/deb package.
 
 An instance file is designed to not differ in any way from a Lua application.
 It must, however, configure the database, i.e. contain a call to
-:ref:`box.cfg{} <box_introspection-box_cfg>` somewhere in it, because it’s the
+:doc:`box.cfg{} </reference/reference_lua/box_cfg>` somewhere in it, because it’s the
 only way to turn a Tarantool script into a background process, and
 ``tarantoolctl`` is a tool to manage background processes. Other than that, an
 instance file may contain arbitrary Lua code, and, in theory, even include the
@@ -99,7 +99,7 @@ the method described in section
 default settings.
 
 Most of the parameters are similar to those used by
-:ref:`box.cfg{} <box_introspection-box_cfg>`. Here are the default settings
+:doc:`box.cfg{} </reference/reference_lua/box_cfg>`. Here are the default settings
 (possibly installed in ``/etc/default/tarantool`` or ``/etc/sysconfig/tarantool``
 as part of Tarantool distribution -- see OS-specific default paths in
 :ref:`Notes for operating systems <admin-os_notes>`):

doc/book/admin/server_introspection.rst

@@ -113,16 +113,16 @@ To check the boot log, on systems with ``systemd``, say:
 
 For more details, use the reports provided by functions in the following submodules:
 
-* :ref:`box.cfg <box_introspection-box_cfg>` submodule (check and specify all
+* :doc:`/reference/reference_lua/box_cfg` (check and specify all
   configuration parameters for the Tarantool server)
 
-* :ref:`box.slab <box_introspection-box_slab>` submodule (monitor the total use
+* :doc:`/reference/reference_lua/box_slab` (monitor the total use
   and fragmentation of memory allocated for storing data in Tarantool)
 
-* :ref:`box.info <box_introspection-box_info>` submodule (introspect Tarantool
+* :doc:`/reference/reference_lua/box_info` (introspect Tarantool
   server variables, primarily those related to replication)
 
-* :ref:`box.stat <box_introspection-box_stat>` submodule (introspect Tarantool
+* :doc:`/reference/reference_lua/box_stat` (introspect Tarantool
   request and network statistics)
 
 You can also try `prometheus <https://github.com/tarantool/metrics/tree/master/metrics/plugins/prometheus>`_,
@@ -132,7 +132,8 @@ Prometheus protocol.
 
 **Example**
 
-A very popular administrator request is :ref:`box.slab.info() <box_slab_info>`,
+A very popular administrator request is
+:doc:`/reference/reference_lua/box_slab/slab_info`,
 which displays detailed memory usage statistics for a Tarantool instance.
 
 .. code-block:: tarantoolsession
@@ -165,7 +166,7 @@ fragmentation by calling the Lua garbage collector via the
 
 Ordinarily this does not affect performance.
 But, to force Tarantool to release memory, you can
-call :ref:`box.snapshot <box-snapshot>`, stop the server instance,
+call :doc:`box.snapshot() </reference/reference_lua/box_snapshot>`, stop the server instance,
 and restart it.
 
 .. _admin-profiling_performance_issues:

doc/book/admin/start_stop_instance.rst

@@ -34,7 +34,7 @@ Here is what ``tarantoolctl`` does when you issue the command:
    ``tarantoolctl`` takes the instance name, prepends the instance directory and
    appends ".lua" extension to the instance file.
 
-4. Override :ref:`box.cfg{} <box_introspection-box_cfg>` function to pre-process
+4. Override :doc:`box.cfg{} </reference/reference_lua/box_cfg>` function to pre-process
    its parameters and ensure that instance paths are pointing to the paths
    defined in the ``tarantoolctl`` configuration file. For example, if the
    configuration file specifies that instance work directory must be in

doc/book/admin/troubleshoot.rst

@@ -14,7 +14,7 @@ Problem: INSERT/UPDATE-requests result in ER_MEMORY_ISSUE error
 **Possible reasons**
 
 * Lack of RAM (parameters ``arena_used_ratio`` and ``quota_used_ratio`` in
-  :ref:`box.slab.info() <box_slab_info>` report are getting close to 100%).
+  :doc:`/reference/reference_lua/box_slab/slab_info` report are getting close to 100%).
 
   To check these parameters, say:
 
@@ -77,7 +77,7 @@ over 60% CPU.
 **Solution**
 
 Attach to the Tarantool instance with :ref:`tarantoolctl <tarantoolctl>` utility,
-analyze the query statistics with :ref:`box.stat() <box_introspection-box_stat>`
+analyze the query statistics with :doc:`box.stat() </reference/reference_lua/box_stat>`
 and spot the CPU consumption leader. The following commands can help:
 
 .. code-block:: console
@@ -175,7 +175,7 @@ Problem: Replication "lag" and "idle" contain negative values
 
 This is about ``box.info.replication.(upstream.)lag`` and
 ``box.info.replication.(upstream.)idle`` values in
-:ref:`box.info.replication <box_info_replication>` section.
+:doc:`/reference/reference_lua/box_info/replication` section.
 
 **Possible reasons**
 
@@ -198,7 +198,7 @@ Problem: Replication "idle" keeps growing, but no related log messages appear
 --------------------------------------------------------------------------------
 
 This is about ``box.info.replication.(upstream.)idle`` value in
-:ref:`box.info.replication <box_info_replication>` section.
+:doc:`/reference/reference_lua/box_info/replication` section.
 
 **Possible reasons**
 
@@ -221,7 +221,7 @@ Problem: Replication statistics differ on replicas within a replica set
 
 This is about a replica set that consists of one master and several replicas.
 In a replica set of this type, values in
-:ref:`box.info.replication <box_info_replication>` section, like
+:doc:`/reference/reference_lua/box_info/replication` section, like
 ``box.info.replication.lsn``, come from the master and must be the same on all
 replicas within the replica set. The problem is that they get different.
 
@@ -239,7 +239,8 @@ Replication is broken.
 Problem: Master-master replication is stopped
 --------------------------------------------------------------------------------
 
-This is about :ref:`box.info.replication(.upstream).status <box_info_replication>`
+This is about
+:doc:`box.info.replication(.upstream).status </reference/reference_lua/box_info/replication>`
 = stopped.
 
 **Possible reasons**

doc/book/admin/upgrades.rst

@@ -99,7 +99,7 @@ parameters are supported. The full list of breaking changes is available in
    `download page <http://tarantool.org/download.html>`_.
 
 5. Update the Tarantool database. Put the request ``box.schema.upgrade()``
-   inside a :ref:`box.once() <box-once>` function in your Tarantool
+   inside a :doc:`box.once() </reference/reference_lua/box_once>` function in your Tarantool
    :ref:`initialization file <index-init_label>`.
    On startup, this will create new system spaces, update data type names (e.g.
    num -> unsigned, str -> string) and options in Tarantool system spaces.

doc/book/app_server/cookbook.rst

@@ -46,7 +46,7 @@ The standard example of a simple program.
 console_start.lua
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use :ref:`box.once() <box-once>` to initialize a database
+Use :doc:`box.once() </reference/reference_lua/box_once>` to initialize a database
 (creating spaces) if this is the first time the server has been run.
 Then use :ref:`console.start() <console-start>` to start interactive mode.
 

doc/book/app_server/creating_app.rst

@@ -468,7 +468,7 @@ Index iterators
 By our gameplay, all caught pokémons are returned back to the map. We do this
 for all pokémons on the map every 60 seconds using ``respawn()`` method.
 We iterate through pokémons by status using Tarantool index iterator function
-:ref:`index:pairs <box_index-index_pairs>` and reset the statuses of all
+:doc:`/reference/reference_lua/box_index/pairs` and reset the statuses of all
 "caught" pokémons back to "active" using ``box.space.pokemons:update()``.
 
 .. code-block:: lua