gh-1415 add versions to cfg parameters + gh-1485

doc/reference/configuration/cfg_basic.rst

@@ -16,6 +16,7 @@
 
 .. confval:: background
 
+    Since version 1.6.2.
     Run the server as a background task. The :ref:`log <cfg_logging-log>`
     and :ref:`pid_file <cfg_basic-pid_file>` parameters must be non-null for
     this to work.
@@ -28,6 +29,7 @@
 
 .. confval:: custom_proc_title
 
+    Since version 1.6.7.
     Add the given string to the server's process title
     (what’s shown in the COMMAND column for
     ``ps -ef`` and ``top -c`` commands).
@@ -56,6 +58,7 @@
 
 .. confval:: listen
 
+    Since version 1.6.4.
     The read/write data port number or :ref:`URI <index-uri>` (Universal
     Resource Identifier) string. Has no default value, so **must be specified**
     if connections will occur from remote clients that do not use the
@@ -78,6 +81,7 @@
 
 .. confval:: memtx_dir
 
+    Since version 1.7.4.
     A directory where memtx stores snapshot (.snap) files. Can be relative to
     :ref:`work_dir <cfg_basic-work_dir>`. If not specified, defaults to
     ``work_dir``. See also :ref:`wal_dir <cfg_basic-wal_dir>`.
@@ -90,6 +94,7 @@
 
 .. confval:: pid_file
 
+    Since version 1.4.9.
     Store the process id in this file. Can be relative to :ref:`work_dir
     <cfg_basic-work_dir>`. A typical value is “:file:`tarantool.pid`”.
 
@@ -101,6 +106,7 @@
 
 .. confval:: read_only
 
+    Since version 1.7.1.
     Say ``box.cfg{read_only=true...}`` to put the server instance in read-only
     mode. After this, any requests that try to change persistent data will fail with error
     :errcode:`ER_READONLY`. Read-only mode should be used for master-replica
@@ -133,6 +139,7 @@
 
 .. confval:: vinyl_dir
 
+    Since version 1.7.1.
     A directory where vinyl files or subdirectories will be stored. Can be
     relative to :ref:`work_dir <cfg_basic-work_dir>`. If not specified, defaults
     to ``work_dir``.
@@ -145,6 +152,7 @@
 
 .. confval:: vinyl_timeout
 
+    Since version 1.7.5.
     The vinyl storage engine has a scheduler which does compaction.
     When vinyl is low on available memory, the compaction scheduler
     may be unable to keep up with incoming update requests.
@@ -162,7 +170,7 @@
 
 .. confval:: username
 
-    UNIX user name to switch to after start.
+    Since version 1.4.9. UNIX user name to switch to after start.
 
     | Type: string
     | Default: null
@@ -172,6 +180,7 @@
 
 .. confval:: wal_dir
 
+    Since version 1.6.2.
     A directory where write-ahead log (.xlog) files are stored. Can be relative
     to :ref:`work_dir <cfg_basic-work_dir>`. Sometimes ``wal_dir`` and
     :ref:`memtx_dir <cfg_basic-memtx_dir>` are specified with different values, so
@@ -186,6 +195,7 @@
 
 .. confval:: work_dir
 
+    Since version 1.4.9.
     A directory where database working files will be stored. The server instance
     switches to ``work_dir`` with :manpage:`chdir(2)` after start. Can be
     relative to the current directory. If not specified, defaults to
@@ -212,6 +222,7 @@
 
 .. confval:: worker_pool_threads
 
+    Since version 1.7.5.
     The maximum number of threads to use during execution
     of certain internal processes (currently
     :ref:`socket.getaddrinfo() <socket-getaddrinfo>` and
@@ -225,7 +236,7 @@
 
 .. confval:: strip_core
 
-    Whether coredump files should include memory allocated for tuples.
+    Since version 2.2.2. Whether coredump files should include memory allocated for tuples.
     (This can be large if Tarantool runs under heavy load.)
     Setting to ``true`` means "do not include".
     In an older version of Tarantool the default value of this parameter was ``false``.

doc/reference/configuration/cfg_binary_logging_snapshots.rst

@@ -1,5 +1,4 @@
 * :ref:`force_recovery <cfg_binary_logging_snapshots-force_recovery>`,
-* :ref:`rows_per_wal <cfg_binary_logging_snapshots-rows_per_wal>`,
 * :ref:`wal_max_size <cfg_binary_logging_snapshots-wal_max_size>`,
 * :ref:`snap_io_rate_limit <cfg_binary_logging_snapshots-snap_io_rate_limit>`,
 * :ref:`wal_mode <cfg_binary_logging_snapshots-wal_mode>`,
@@ -9,6 +8,7 @@
 
 .. confval:: force_recovery
 
+    Since version 1.7.4.
     If ``force_recovery`` equals true, Tarantool tries to continue if there is
     an error while reading a :ref:`snapshot file<index-box_persistence>`
     (at server instance start) or a :ref:`write-ahead log file<internals-wal>`
@@ -23,29 +23,14 @@
     | Default: false
     | Dynamic: no
 
-.. _cfg_binary_logging_snapshots-rows_per_wal:
-
-.. confval:: rows_per_wal
-
-    How many log records to store in a single write-ahead log file.
-    When this limit is reached, Tarantool creates another WAL file
-    named :samp:`{<first-lsn-in-wal>}.xlog`. This can be useful for
-    simple rsync-based backups.
-
-    | Type: integer
-    | Default: 500000
-    | Dynamic: no
-
 .. _cfg_binary_logging_snapshots-wal_max_size:
 
 .. confval:: wal_max_size
 
+    Since version 1.7.4.
     The maximum number of bytes in a single write-ahead log file.
     When a request would cause an .xlog file to become larger than
-    ``wal_max_size``, Tarantool creates another WAL file --
-    the same effect that happens when the
-    :ref:`rows_per_wal <cfg_binary_logging_snapshots-rows_per_wal>`
-    limit is reached.
+    ``wal_max_size``, Tarantool creates another WAL file.
 
     | Type: integer
     | Default: 268435456 (256 * 1024 * 1024)
@@ -55,6 +40,7 @@
 
 .. confval:: snap_io_rate_limit
 
+    Since version 1.4.9.
     Reduce the throttling effect of :ref:`box.snapshot <box-snapshot>` on
     INSERT/UPDATE/DELETE performance by setting a limit on how many
     megabytes per second it can write to disk. The same can be
@@ -73,7 +59,7 @@
 
 .. confval:: wal_mode
 
-    Specify fiber-WAL-disk synchronization mode as:
+    Since version 1.6.2. Specify fiber-WAL-disk synchronization mode as:
 
     * ``none``: write-ahead log is not maintained;
     * ``write``: :ref:`fibers <fiber-fibers>` wait for their data to be written to
@@ -89,6 +75,7 @@
 
 .. confval:: wal_dir_rescan_delay
 
+    Since version 1.6.2.
     Number of seconds between periodic scans of the write-ahead-log
     file directory, when checking for changes to write-ahead-log
     files for the sake of :ref:`replication <replication>` or :ref:`hot standby <index-hot_standby>`.

doc/reference/configuration/cfg_deprecated.rst

@@ -15,6 +15,7 @@ These parameters are deprecated since Tarantool version 1.7.4:
 * :ref:`snap_dir <cfg_basic-snap_dir_deprecated>`
 * :ref:`snapshot_count <cfg_checkpoint_daemon-snapshot_count_deprecated>`
 * :ref:`snapshot_period <cfg_checkpoint_daemon-snapshot_period_deprecated>`
+* :ref:`rows_per_wal <cfg_binary_logging_snapshots-rows_per_wal>`
 
 .. _cfg_basic-coredump_deprecated:
 
@@ -152,3 +153,11 @@ These parameters are deprecated since Tarantool version 1.7.4:
     :ref:`checkpoint_count <cfg_checkpoint_daemon-checkpoint_count>`.
     The parameter was only renamed,
     while the type, values and semantics remained intact.
+
+.. _cfg_binary_logging_snapshots-rows_per_wal:
+
+.. confval:: rows_per_wal
+
+    **Deprecated** in favour of
+    :ref:`wal_max_size <cfg_binary_logging_snapshots-wal_max_size>`.
+    The parameter does not allow to properly limit size of WAL logs.

doc/reference/configuration/cfg_hot_standby.rst

@@ -1,6 +1,6 @@
 .. confval:: hot_standby
 
-    Whether to start the server in **hot standby** mode.
+    Since version 1.7.4. Whether to start the server in **hot standby** mode.
 
     Hot standby is a feature which provides a simple form of failover without
     :ref:`replication <replication>`.

doc/reference/configuration/cfg_logging.rst

@@ -10,6 +10,7 @@
 
 .. confval:: log_level
 
+    Since version 1.6.2.
     What level of detail the :ref:`log <admin-logs>` will have. There are seven levels:
 
     * 1 – ``SYSERROR``
@@ -38,6 +39,7 @@
 
 .. confval:: log
 
+    Since version 1.7.4.
     By default, Tarantool sends the log to the standard error stream
     (``stderr``). If ``log`` is specified, Tarantool sends the log to a file,
     or to a pipe, or to the system logger.
@@ -115,6 +117,7 @@
 
 .. confval:: log_nonblock
 
+    Since version 1.7.4.
     If ``log_nonblock`` equals true, Tarantool does not block during logging
     when the system is not ready for writing, and drops the message
     instead. If :ref:`log_level <cfg_logging-log_level>` is high, and many
@@ -139,6 +142,7 @@
 
 .. confval:: too_long_threshold
 
+    Since version 1.6.2.
     If processing a request takes longer than the given value (in seconds),
     warn about it in the log. Has effect only if :ref:`log_level
     <cfg_logging-log_level>` is more than or equal to 4 (WARNING).
@@ -151,7 +155,7 @@
 
 .. confval:: log_format
 
-    Log entries have two possible formats:
+    Since version 1.7.6. Log entries have two possible formats:
 
     * 'plain' (the default), or
     * 'json' (with more detail and with JSON labels).
@@ -283,7 +287,7 @@ adjust or turn off this feature.
 
 .. confval:: feedback_enabled
 
-    Whether to send feedback.
+    Since version 1.10.1 Whether to send feedback.
 
     If this is set to ``true``, feedback will be sent as described above.
     If this is set to ``false``, no feedback will be sent.
@@ -296,7 +300,7 @@ adjust or turn off this feature.
 
 .. confval:: feedback_host
 
-    The address to which the packet is sent.
+    Since version 1.10.1. The address to which the packet is sent.
     Usually the recipient is Tarantool, but it can be any URL.
 
     | Type: string
@@ -307,7 +311,7 @@ adjust or turn off this feature.
 
 .. confval:: feedback_interval
 
-    The number of seconds between sendings, usually 3600 (1 hour).
+    Since version 1.10.1. The number of seconds between sendings, usually 3600 (1 hour).
 
     | Type: float
     | Default: 3600

doc/reference/configuration/cfg_networking.rst

@@ -6,6 +6,7 @@
 
 .. confval:: io_collect_interval
 
+    Since version 1.4.9.
     The instance will sleep for io_collect_interval seconds between iterations
     of the event loop. Can be used to reduce CPU load in deployments in which
     the number of client connections is large, but requests are not so frequent
@@ -19,7 +20,7 @@
 
 .. confval:: net_msg_max
 
-    To handle messages, Tarantool allocates fibers.
+    Since version 1.10.1. To handle messages, Tarantool allocates fibers.
     To prevent fiber overhead from affecting the whole system,
     Tarantool restricts how many messages the fibers handle,
     so that some pending requests are blocked.
@@ -55,6 +56,7 @@
 
 .. confval:: readahead
 
+    Since version 1.6.2.
     The size of the read-ahead buffer associated with a client connection. The
     larger the buffer, the more memory an active connection consumes and the
     more requests can be read from the operating system buffer in a single

doc/reference/configuration/cfg_replication.rst

@@ -12,6 +12,7 @@
 
 .. confval:: replication
 
+    Since version 1.7.4.
     If ``replication`` is not an empty string, the instance is considered to be
     a Tarantool :ref:`replica <replication>`. The replica will
     try to connect to the master specified in ``replication`` with a
@@ -49,6 +50,7 @@
 
 .. confval:: replication_connect_timeout
 
+    Since version 1.9.0.
     The number of seconds that a replica will wait when trying to
     connect to a master in a cluster.
     See :ref:`orphan status <replication-orphan_status>` for details.
@@ -66,6 +68,7 @@
 
 .. confval:: replication_connect_quorum
 
+    Since version 1.9.0.
     By default a replica will try to connect to all the masters,
     or it will not start. (The default is recommended so that all replicas
     will receive the same replica set UUID.)
@@ -94,6 +97,7 @@
 
 .. confval:: replication_skip_conflict
 
+    Since version 1.10.1.
     By default, if a replica adds a unique key that another replica has
     added, replication :ref:`stops <replication-replication_stops>`
     with error = ER_TUPLE_FOUND.
@@ -122,6 +126,7 @@
 
 .. confval:: replication_sync_lag
 
+    Since version 1.9.0.
     The maximum :ref:`lag <box_info_replication_upstream_lag>` allowed for a replica.
     When a replica :ref:`syncs <replication-orphan_status>`
     (gets updates from a master), it may not catch up completely.
@@ -145,6 +150,7 @@
 
 .. confval:: replication_sync_timeout
 
+    Since version 1.10.2.
     The number of seconds that a replica will wait when trying to
     sync with a master in a cluster,
     or a :ref:`quorum <cfg_replication-replication_connect_quorum>` of masters,
@@ -162,6 +168,7 @@
 
 .. confval:: replication_timeout
 
+    Since version 1.8.2.
     If the master has no updates to send to the replicas, it sends heartbeat messages
     every ``replication_timeout`` seconds, and each replica sends an ACK packet back.
 
@@ -179,7 +186,7 @@
 
 .. confval:: replicaset_uuid
 
-    As described in section
+    Since version 1.9.0. As described in section
     :ref:`"Replication architecture" <replication-architecture>`,
     each replica set is identified by a
     `universally unique identifier <https://en.wikipedia.org/wiki/Universally_unique_identifier>`_
@@ -228,6 +235,7 @@
 
 .. confval:: instance_uuid
 
+    Since version 1.9.0.
     For replication administration purposes, it is possible to set the
     `universally unique identifiers <https://en.wikipedia.org/wiki/Universally_unique_identifier>`_
     of the instance (``instance_uuid``) and the replica set