Fix formatting in box.cfg reference (#4091)

tarantool · Mar 13, 2024 · d5639d8 · d5639d8
1 parent 30125ad
commit d5639d8
Show file tree

Hide file tree

Showing 12 changed files with 104 additions and 3 deletions.
diff --git a/doc/reference/configuration/cfg_authentication.rst b/doc/reference/configuration/cfg_authentication.rst
@@ -35,6 +35,7 @@
         box.cfg{ auth_delay = 5 }
 
 
+    |
     | Type: number
     | Default: 0
     | Environment variable: TT_AUTH_DELAY
@@ -53,6 +54,7 @@
     For example, if a client tries to authenticate fewer than ``auth_retries`` times within ``auth_delay`` seconds, no authentication delay is enforced.
     The retry counter is also reset after any successful authentication attempt.
 
+    |
     | Type: number
     | Default: 0
     | Environment variable: TT_AUTH_RETRIES
@@ -76,6 +78,7 @@
     :doc:`box.schema.user.passwd </reference/reference_lua/box_schema/user_passwd>`
     to use the new authentication protocol.
 
+    |
     | Type: string
     | Default value: 'chap-sha1'
     | Environment variable: TT_AUTH_TYPE
@@ -94,6 +97,7 @@
     :doc:`net.box </reference/reference_lua/net_box>` and
     :ref:`replication <replication-master_replica_bootstrap>` connections.
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_DISABLE_GUEST
@@ -113,6 +117,7 @@
 
         box.cfg{ password_min_length = 10 }
 
+    |
     | Type: integer
     | Default: 0
     | Environment variable: TT_PASSWORD_MIN_LENGTH
@@ -127,6 +132,7 @@
 
     If **true**, a password should contain uppercase letters (A-Z).
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_PASSWORD_ENFORCE_UPPERCASE
@@ -141,6 +147,7 @@
 
     If **true**, a password should contain lowercase letters (a-z).
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_PASSWORD_ENFORCE_LOWERCASE
@@ -155,6 +162,7 @@
 
     If **true**, a password should contain digits (0-9).
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_PASSWORD_ENFORCE_DIGITS
@@ -169,6 +177,7 @@
 
     If **true**, a password should contain at least one special character (such as ``&|?!@$``).
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_PASSWORD_ENFORCE_SPECIALCHARS
@@ -195,6 +204,7 @@
 
         box.cfg{ password_lifetime_days = 365 }
 
+    |
     | Type: integer
     | Default: 0
     | Environment variable: TT_PASSWORD_LIFETIME_DAYS
@@ -215,6 +225,7 @@
 
         box.cfg{ password_history_length = 3 }
 
+    |
     | Type: integer
     | Default: 0
     | Environment variable: TT_PASSWORD_HISTORY_LENGTH

diff --git a/doc/reference/configuration/cfg_basic.rst b/doc/reference/configuration/cfg_basic.rst
@@ -24,6 +24,7 @@
     and :ref:`pid_file <cfg_basic-pid_file>` parameters must be non-null for
     this to work.
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_BACKGROUND
@@ -55,6 +56,7 @@
         $ ps -ef | grep tarantool
         1000     14939 14188  1 10:53 pts/2    00:00:16 tarantool <running>: sessions
 
+    |
     | Type: string
     | Default: null
     | Environment variable: TT_CUSTOM_PROC_TITLE
@@ -89,6 +91,7 @@
     Starting from version 2.10.0, you can specify :ref:`several URIs <index-uri-several>`,
     and the port number is always stored as an integer value.
 
+    |
     | Type: integer or string
     | Default: null
     | Environment variable: TT_LISTEN
@@ -107,6 +110,7 @@
     However, you can set different values for the ``memtx_dir`` and :ref:`wal_dir <cfg_basic-wal_dir>` options
     to store them on different physical disks for performance matters.
 
+    |
     | Type: string
     | Default: "."
     | Environment variable: TT_MEMTX_DIR
@@ -121,6 +125,7 @@
     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`”.
 
+    |
     | Type: string
     | Default: null
     | Environment variable: TT_PID_FILE
@@ -141,6 +146,7 @@
     Although read-only mode prevents the server from writing to the :ref:`WAL <internals-wal>`,
     it does not prevent writing diagnostics with the :ref:`log module <log-module>`.
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_READ_ONLY
@@ -174,6 +180,7 @@
     (The number of bytes that are actually used can be seen with
     :ref:`box.info.sql().cache.size <box_introspection-box_info>`.)
 
+    |
     | Type: number
     | Default: 5242880
     | Environment variable: TT_SQL_CACHE_SIZE
@@ -189,6 +196,7 @@
     relative to :ref:`work_dir <cfg_basic-work_dir>`. If not specified, defaults
     to ``work_dir``.
 
+    |
     | Type: string
     | Default: "."
     | Environment variable: TT_VINYL_DIR
@@ -209,6 +217,7 @@
     Compaction can also be ordered manually with
     :doc:`/reference/reference_lua/box_index/compact`.
 
+    |
     | Type: float
     | Default: 60
     | Environment variable: TT_VINYL_TIMEOUT
@@ -222,6 +231,7 @@
 
     UNIX user name to switch to after start.
 
+    |
     | Type: string
     | Default: null
     | Environment variable: TT_USERNAME
@@ -240,6 +250,7 @@
     However, you can set different values for the ``wal_dir`` and :ref:`memtx_dir <cfg_basic-memtx_dir>` options
     to store them on different physical disks for performance matters.
 
+    |
     | Type: string
     | Default: "."
     | Environment variable: TT_WAL_DIR
@@ -268,6 +279,7 @@
     will put xlog files in ``/home/user/A/B``, snapshot files in ``/home/user/A/C``,
     and all other files or subdirectories in ``/home/user/A``.
 
+    |
     | Type: string
     | Default: null
     | Environment variable: TT_WORK_DIR
@@ -285,6 +297,7 @@
     :ref:`socket.getaddrinfo() <socket-getaddrinfo>` and
     :ref:`coio_call() <c_api-coio-coio_call>`).
 
+    |
     | Type: integer
     | Default: 4
     | Environment variable: TT_WORKER_POOL_THREADS
@@ -301,6 +314,7 @@
     Setting to ``true`` means "do not include".
     In an older version of Tarantool the default value of this parameter was ``false``.
 
+    |
     | Type: boolean
     | Default: true
     | Environment variable: TT_STRIP_CORE
@@ -312,8 +326,9 @@
 
     Since version :doc:`2.6.1 </release/2.6.1>`.
 
-    Enables :ref:`transactional manager <txn_mode_transaction-manager>` if set to ``true``.
+    Enable :ref:`transactional manager <txn_mode_transaction-manager>` if set to ``true``.
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_MEMTX_USE_MVCC_ENGINE

diff --git a/doc/reference/configuration/cfg_binary_logging_snapshots.rst b/doc/reference/configuration/cfg_binary_logging_snapshots.rst
@@ -24,6 +24,7 @@
 
     Otherwise, Tarantool aborts recovery if there is an error while reading.
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_FORCE_RECOVERY
@@ -39,6 +40,7 @@
     When a request would cause an ``.xlog`` file to become larger than
     ``wal_max_size``, Tarantool creates a new WAL file.
 
+    |
     | Type: integer
     | Default: 268435456 (256 * 1024 * 1024) bytes
     | Environment variable: TT_WAL_MAX_SIZE
@@ -60,6 +62,7 @@
     :ref:`box.stat.vinyl().regulator <box_introspection-box_stat_vinyl_regulator>`
     may show for the write rate of dumps to ``.run`` and ``.index`` files.
 
+    |
     | Type: float
     | Default: null
     | Environment variable: TT_SNAP_IO_RATE_LIMIT
@@ -82,6 +85,7 @@
     *   ``fsync``: fibers wait for their data, :manpage:`fsync(2)`
         follows each :manpage:`write(2)`.
 
+    |
     | Type: string
     | Default: "write"
     | Environment variable: TT_WAL_MODE
@@ -97,6 +101,7 @@
     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>`.
 
+    |
     | Type: float
     | Default: 2
     | Environment variable: TT_WAL_DIR_RESCAN_DELAY
@@ -119,6 +124,7 @@
         You might consider increasing the ``wal_queue_max_size`` value in case of
         large tuples (approximately one megabyte or larger).
 
+    |
     | Type: number
     | Default: 16777216 bytes
     | Environment variable: TT_WAL_QUEUE_MAX_SIZE
@@ -144,6 +150,7 @@
         The ``wal_cleanup_delay`` option has no effect on nodes running as
         :ref:`anonymous replicas <cfg_replication-replication_anon>`.
 
+    |
     | Type: number
     | Default: 14400 seconds
     | Environment variable: TT_WAL_CLEANUP_DELAY
@@ -193,6 +200,7 @@
     *   If a replica doesn't support the extended format configured on a master, auxiliary fields are skipped.
     *   If a replica and master have different configurations for WAL records, the master's configuration is ignored.
 
+    |
     | Type: map
     | Default: nil
     | Environment variable: TT_WAL_EXT
@@ -208,6 +216,7 @@
     (**Enterprise Edition only**) If **true**, forces Tarantool to overwrite a data file a few times before deletion to render recovery of a deleted file impossible.
     The option applies to both ``.xlog`` and ``.snap`` files as well as Vinyl data files.
 
+    |
     | Type: boolean
     | Default: false
     | Environment variable: TT_SECURE_ERASING

diff --git a/doc/reference/configuration/cfg_deprecated.rst b/doc/reference/configuration/cfg_deprecated.rst
@@ -23,6 +23,7 @@ These parameters are deprecated since Tarantool version 1.7.4:
 
     **Deprecated**, do not use.
 
+    |
     | Type: boolean
     | Default: false
     | Dynamic: no
@@ -53,6 +54,7 @@ These parameters are deprecated since Tarantool version 1.7.4:
     If there is an error while reading a snapshot file
     (at server instance start), abort.
 
+    |
     | Type: boolean
     | Default: true
     | Dynamic: no
@@ -64,6 +66,7 @@ These parameters are deprecated since Tarantool version 1.7.4:
     **Deprecated** in favor of
     :ref:`force_recovery <cfg_binary_logging_snapshots-force_recovery>`.
 
+    |
     | Type: boolean
     | Default: true
     | Dynamic: yes
@@ -91,6 +94,7 @@ These parameters are deprecated since Tarantool version 1.7.4:
     indexes and connection information. Depending on actual configuration and
     workload, Tarantool can consume up to 20% more than the limit set here.
 
+    |
     | Type: float
     | Default: 1.0
     | Dynamic: no
@@ -160,6 +164,7 @@ These parameters are deprecated since Tarantool version 1.7.4:
     Setting to ``false`` is equivalent to setting the ``off``
     :ref:`election_fencing_mode <cfg_replication-election_fencing_mode>`.
 
+    |
     | Type: boolean
     | Default: true
     | Environment variable: TT_ELECTION_FENCING_ENABLED

diff --git a/doc/reference/configuration/cfg_feedback.rst b/doc/reference/configuration/cfg_feedback.rst
@@ -22,6 +22,7 @@ adjust or turn off this feature.
     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
@@ -36,6 +37,7 @@ adjust or turn off this feature.
     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
@@ -49,6 +51,7 @@ adjust or turn off this feature.
 
     The number of seconds between sendings, usually 3600 (1 hour).
 
+    |
     | Type: float
     | Default: 3600
     | Environment variable: TT_FEEDBACK_INTERVAL