box.cfg: make 'Since version' and 'Dynamic: yes' consistent

andreyaksenov · andreyaksenov · commit 7974ade83816 · 2024-01-22T11:24:35.000+03:00
diff --git a/doc/reference/configuration/cfg_basic.rst b/doc/reference/configuration/cfg_basic.rst
@@ -19,6 +19,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.
@@ -33,6 +34,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).
@@ -97,6 +99,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>`.
@@ -111,6 +114,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`”.
 
@@ -124,6 +128,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
@@ -160,6 +165,7 @@
 .. confval:: sql_cache_size
 
     Since version 2.3.1.
+
     The maximum number of bytes in the cache for
     :ref:`SQL prepared statements <box-sql_box_prepare>`.
     (The number of bytes that are actually used can be seen with
@@ -175,6 +181,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``.
@@ -189,6 +196,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.
@@ -207,7 +215,9 @@
 
 .. confval:: username
 
-    Since version 1.4.9. 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
@@ -219,6 +229,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
@@ -235,6 +246,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
@@ -263,6 +275,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
@@ -277,7 +290,9 @@
 
 .. confval:: strip_core
 
-    Since version 2.2.2. 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``.
@@ -292,6 +307,7 @@
 .. confval:: memtx_use_mvcc_engine
 
     Since version :doc:`2.6.1 </release/2.6.1>`.
+
     Enables :ref:`transactional manager <txn_mode_transaction-manager>` if set to ``true``.
 
     | Type: boolean
diff --git a/doc/reference/configuration/cfg_binary_logging_snapshots.rst b/doc/reference/configuration/cfg_binary_logging_snapshots.rst
@@ -63,7 +63,7 @@
     | Type: float
     | Default: null
     | Environment variable: TT_SNAP_IO_RATE_LIMIT
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_binary_logging_snapshots-wal_mode:
 
@@ -120,7 +120,7 @@
     | Type: number
     | Default: 16777216 bytes
     | Environment variable: TT_WAL_QUEUE_MAX_SIZE
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_binary_logging_snapshots-wal_cleanup_delay:
 
@@ -146,7 +146,7 @@
     | Type: number
     | Default: 14400 seconds
     | Environment variable: TT_WAL_CLEANUP_DELAY
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 
 .. _cfg_binary_logging_snapshots-wal_ext:
@@ -195,7 +195,7 @@
     | Type: map
     | Default: nil
     | Environment variable: TT_WAL_EXT
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 
 .. _cfg_binary_logging_secure_erasing:
@@ -210,4 +210,4 @@
     | Type: boolean
     | Default: false
     | Environment variable: TT_SECURE_ERASING
-    | Dynamic: **yes**
+    | Dynamic: yes
diff --git a/doc/reference/configuration/cfg_feedback.rst b/doc/reference/configuration/cfg_feedback.rst
@@ -15,35 +15,41 @@ adjust or turn off this feature.
 
 .. confval:: feedback_enabled
 
-    Since version 1.10.1. 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.
 
     | Type: boolean
     | Default: true
     | Environment variable: TT_FEEDBACK_ENABLED
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_logging-feedback_host:
 
 .. confval:: feedback_host
 
-    Since version 1.10.1. 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
     | Default: ``https://feedback.tarantool.io``
     | Environment variable: TT_FEEDBACK_HOST
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_logging-feedback_interval:
 
 .. confval:: feedback_interval
 
-    Since version 1.10.1. 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
     | Environment variable: TT_FEEDBACK_INTERVAL
-    | Dynamic: **yes**
+    | Dynamic: yes
diff --git a/doc/reference/configuration/cfg_hot_standby.rst b/doc/reference/configuration/cfg_hot_standby.rst
@@ -1,6 +1,8 @@
 .. confval:: hot_standby
 
-    Since version 1.7.4. 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>`.
diff --git a/doc/reference/configuration/cfg_logging.rst b/doc/reference/configuration/cfg_logging.rst
@@ -16,6 +16,7 @@ application.
 .. confval:: log_level
 
     Since version 1.6.2.
+
     Specifies the level of detail the :ref:`log <admin-logs>` has. There are seven levels:
 
     * 1 – ``SYSERROR``
@@ -34,7 +35,7 @@ application.
     | Type: integer
     | Default: 5
     | Environment variable: TT_LOG_LEVEL
-    | Dynamic: **yes**
+    | Dynamic: yes
 
     ..  note::
         Prior to Tarantool 1.7.5 there were only six levels and ``DEBUG`` was
@@ -47,6 +48,7 @@ application.
 .. confval:: log
 
     Since version 1.7.4.
+
     By default, Tarantool sends the log to the standard error stream
     (``stderr``). If ``log`` is specified, Tarantool can send the log to a:
 
@@ -130,6 +132,7 @@ application.
 .. 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
@@ -158,20 +161,23 @@ application.
 .. 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 greater than or equal to 4 (WARNING).
 
     | Type: float
     | Default: 0.5
     | Environment variable: TT_TOO_LONG_THRESHOLD
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_logging-log_format:
 
 .. confval:: log_format
 
-    Since version 1.7.6. 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).
@@ -207,14 +213,15 @@ application.
     | Type: string
     | Default: 'plain'
     | Environment variable: TT_LOG_FORMAT
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 
 .. _cfg_logging-log_modules:
 
 .. confval:: log_modules
 
     Since version :doc:`2.11.0 </release/2.11.0>`.
+
     Configure the specified log levels (:ref:`log_level <cfg_logging-log_level>`) for different modules.
 
     You can specify a logging level for the following module types:
@@ -231,7 +238,7 @@ application.
     | Type: table
     | Default: blank
     | Environment variable: TT_LOG_MODULES
-    | Dynamic: **yes**
+    | Dynamic: yes
     |
 
 
diff --git a/doc/reference/configuration/cfg_networking.rst b/doc/reference/configuration/cfg_networking.rst
@@ -8,6 +8,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
@@ -16,13 +17,15 @@
     | Type: float
     | Default: null
     | Environment variable: TT_IO_COLLECT_INTERVAL
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_networking-net_msg_max:
 
 .. confval:: net_msg_max
 
-    Since version 1.10.1. 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.
@@ -53,13 +56,14 @@
     | Type: integer
     | Default: 768
     | Environment variable: TT_NET_MSG_MAX
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_networking-readahead:
 
 .. 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
@@ -72,13 +76,14 @@
     | Type: integer
     | Default: 16320
     | Environment variable: TT_READAHEAD
-    | Dynamic: **yes**
+    | Dynamic: yes
 
 .. _cfg_networking-iproto_threads:
 
 ..  confval:: iproto_threads
 
     Since version :doc:`2.8.1 </release/2.8.1>`.
+
     The number of :ref:`network threads <thread_model>`.
     There can be unusual workloads where the network thread
     is 100% loaded and the transaction processor thread is not, so the network
diff --git a/doc/reference/configuration/cfg_replication.rst b/doc/reference/configuration/cfg_replication.rst
diff --git a/doc/reference/configuration/cfg_snapshot_daemon.rst b/doc/reference/configuration/cfg_snapshot_daemon.rst
diff --git a/doc/reference/configuration/cfg_storage.rst b/doc/reference/configuration/cfg_storage.rst
