Fix formatting and code in release notes; fix #1941 (#1942)

Author: NickVolynkin

doc/release.rst

@@ -10,7 +10,7 @@ Tarantool version numbers consist of three parts:
 
     MAJOR_VERSION.RELEASE_SERIES.RELEASE
 
-Third number :
+Third number distinguishes between alpha, beta and release versions:
 
 *   ``x.y.0`` is an **alpha version**, just a base for adding new features.
     We use alpha versions internally and don't release them as distributions.
@@ -120,6 +120,11 @@ Release notes for series before 1.10 are also available:
     release/2.2.2
     release/2.2.1
     release/2.1.2
+    release/1.10.9
+    release/1.10.8
+    release/1.10.7
+    release/1.10.6
+    release/1.10.5
     release/1.10
     release/1.9
     release/1.8

doc/release/1.10.5.rst

@@ -1,3 +1,6 @@
+Tarantool 1.10.5
+================
+
 Date: 2020-01-14 Tag: 1.10.5-0-g83a2ae9
 
 Overview
@@ -86,22 +89,29 @@ Replication
 
 -   Prefer to bootstrap a replica from a fully bootstrapped instance
     rather than from an instance that is in the process of bootstrapping.
-    gh-4527. This change enables the case when two nodes (B, C) are being
+    gh-4527.
+
+    This change enables the case when two nodes (B, C) are being
     bootstrapped simultaneously using the one that is already
     bootstrapped (A), while A is configured to replicate from {B, C} and
     B – from {A, C}.
 -   Return immediately from ``box.cfg{<...>}`` when an instance is
-    reconfigured with ``replication_connect_quorum = 0``. gh-3760 This
-    change also fixes the behaviour of reconfiguration with non-zero
+    reconfigured with ``replication_connect_quorum = 0``. gh-3760
+
+    This change also fixes the behaviour of reconfiguration with non-zero
     ``replication_connect_quorum``: ``box.cfg{<...>}`` returns
     immediately regardless of whether connections to upstreams are
     established.
 -   Auto reconnect a replica if password is invalid. gh-4550
 -   Use empty password when a URI in ``box.cfg{replication = <...>}`` is
-    like ``login@host:port``. gh-4605. This behaviour matches the
-    net.box’s one now. Explicit ``login:@host:port`` was necessary
-    before, otherwise a replica displayed the following error: > Missing
-    mandatory field ‘tuple’ in request
+    like ``login@host:port``. gh-4605.
+
+    This behaviour matches the net.box’s one now.
+    Explicit ``login:@host:port`` was necessary
+    before, otherwise a replica displayed the following error:
+
+        Missing mandatory field 'tuple' in request
+
 -   Fix segfault during replication configuration
     (``box.cfg{replication = <...>}`` call). gh-4440, gh-4576, gh-4586,
     gh-4643
@@ -120,11 +130,11 @@ Lua
     from ``lua_newthread()``. gh-4556 There are several cases when a new
     Lua thread is created:
 
-   -    Start executing a Lua function call or an eval request (from a
+    -   Start executing a Lua function call or an eval request (from a
         binary protocol, SQL or with ``box.func.<...>:call()``).
-   -    Create of a new fiber.
-   -    Start execution of a trigger.
-   -    Start of encoding into a YAML format (``yaml.encode()``).
+    -   Create of a new fiber.
+    -   Start execution of a trigger.
+    -   Start of encoding into a YAML format (``yaml.encode()``).
 
 -   Fix stack-use-after-scope in ``json.decode()``. gh-4637
 -   Allow to use ``cdata<struct ibuf *>`` (e.g. buffer.IBUF_SHARED) as
@@ -134,7 +144,9 @@ Lua
     not the corresponding pointer type.
 -   A pointer returned by ``msgpack.decode*(cdata<[char] const *>)``
     functions can be assigned to buffer.rpos now (and the same for
-    msgpackffi), gh-3926. All those functions now return
+    msgpackffi), gh-3926.
+
+    All those functions now return
     ``cdata<char *>`` or ``cdata<const char *>`` depending of a passed
     argument. Example of the code that did not work:
     ``res, buf.rpos = msgpack.decode(buf.rpos, buf:size())``.
@@ -158,8 +170,9 @@ LuaJIT
     gh-4537
 -   fold: keep type of emitted CONV in sync with its mode.
     `LuaJIT#524 <https://github.com/LuaJIT/LuaJIT/issues/524>`__ This
-    fixes the following assertion fail: > asm_conv: Assertion
-    \`((IRType)((ir->t).irt & IRT_TYPE)) != st’ failed
+    fixes the following assertion fail:
+
+        asm_conv: Assertion \`((IRType)((ir->t).irt & IRT_TYPE)) != st’ failed
 
 ..  _misc-1:
 

doc/release/1.10.6.rst

@@ -1,3 +1,6 @@
+Tarantool 1.10.6
+================
+
 Date: 2020-04-20 Tag: 1.10.6-1-g47c009a
 
 Overview
@@ -86,14 +89,14 @@ LuaJIT
     ``libluajit``, otherwise loading fails. The extension provides the
     following commands:
 
-   -  ``lj-arch`` dumps values of LJ_64 and LJ_GC64 macro definitions
-   -  ``lj-tv`` dumps the type and GCobj info related to the given
-      TValue
-   -  ``lj-str`` dumps the contents of the given GCstr
-   -  ``lj-tab`` dumps the contents of the given GCtab
-   -  ``lj-stack`` dumps Lua stack of the given lua_State
-   -  ``lj-state`` shows current VM, GC and JIT states
-   -  ``lj-gc`` shows current GC stats
+    -   ``lj-arch`` dumps values of LJ_64 and LJ_GC64 macro definitions
+    -   ``lj-tv`` dumps the type and GCobj info related to the given
+        TValue
+    -   ``lj-str`` dumps the contents of the given GCstr
+    -   ``lj-tab`` dumps the contents of the given GCtab
+    -   ``lj-stack`` dumps Lua stack of the given lua_State
+    -   ``lj-state`` shows current VM, GC and JIT states
+    -   ``lj-gc`` shows current GC stats
 
 -   Fix string to number conversion: current implementation respects the
     buffer length (gh-4773).

doc/release/1.10.7.rst

@@ -1,3 +1,6 @@
+Tarantool 1.10.7
+================
+
 Date: 2019-07-17 Tag: 1.10.7-1-gb93a33a
 
 Overview

doc/release/1.10.8.rst

@@ -1,3 +1,6 @@
+Tarantool 1.10.8
+================
+
 Date: 2020-10-22 Tag: 1.10.8-1-ge69e130
 
 Overview

doc/release/1.10.9.rst

@@ -1,3 +1,6 @@
+Tarantool 1.10.9
+================
+
 Date: 2020-12-30 Tag: 1.10.9-0-g720ffdd23
 
 Overview
@@ -43,7 +46,7 @@ Misc
     but isn’t enabled by default and not started anymore. You can enable
     and start it with the following commands:
 
-   ..   code:: bash
+    ..  code:: bash
 
         ln -s /etc/tarantool/instances.available/example.lua \
             /etc/tarantool/instances.enabled/example.lua
@@ -53,7 +56,7 @@ Misc
     update. If you don’t the need example instance, you can stop and
     disable it with the following commands:
 
-   ..   code:: bash
+    ..  code:: bash
 
         systemctl stop tarantool@example
         rm /etc/tarantool/instances.enabled/example.lua

doc/release/2.2.2.rst

@@ -37,13 +37,13 @@ is to bring attention to the things that have been changed.
 Core
 ~~~~
 
--  **[Breaking change]** Drop ``rows_per_wal`` ``box.cfg()`` option in
+-   **[Breaking change]** Drop ``rows_per_wal`` ``box.cfg()`` option in
     favor of ``wal_max_size``, gh-3762
 
 Lua
 ~~~
 
--  **[Breaking change]** json and msgpack serializers now raise an error
+-   **[Breaking change]** json and msgpack serializers now raise an error
     when a depth of data nesting exceeds ``encode_max_depth`` option
     value. The default value of the option is increased from 32 to 128.
     ``encode_deep_as_nil`` option was added to give ability to set the
@@ -56,7 +56,7 @@ Lua
     ``msgpack.cfg({<...>})``. Note: ``box.tuple.new()``,
     ``space:update()``, ``space:upsert()`` and several other functions
     did not follow ``encode_max_depth`` option, now they do (see also
-   ‘Bug fixes’). Note: ``json.cfg`` and ``msgpack.cfg`` tables did not
+    ‘Bug fixes’). Note: ``json.cfg`` and ``msgpack.cfg`` tables did not
     updated when an option is changed, now they show actual values (see
     also ‘Bug fixes’).
 -   Show line and column in json.decode() errors, gh-3316
@@ -79,9 +79,9 @@ Misc
     gh-4435
 -   Add package builds and deployment for the following Linux distros:
 
-   -  Ubuntu 19.10 Eoan Ermine, gh-4583
-   -  CentOS 8, gh-4543
-   -  Fedora 31, gh-4612
+    -   Ubuntu 19.10 Eoan Ermine, gh-4583
+    -   CentOS 8, gh-4543
+    -   Fedora 31, gh-4612
 
 Bugs fixed
 ----------
@@ -138,9 +138,9 @@ Core
 -   Fix error message for incorrect return value of functional index
     extractor function, gh-4553
 
-   -  Was: "Key format doesn’t match one defined in functional index ‘’
-      of space ‘’: supplied key type is invalid: expected boolean’
-   -  Now: “<…>: expected array”
+    -   Was: "Key format doesn’t match one defined in functional index ‘’
+        of space ‘’: supplied key type is invalid: expected boolean’
+    -   Now: “<…>: expected array”
 
 -   JSON path index did ignore is_nullable property when a space had a
     format, gh-4520
@@ -211,7 +211,6 @@ Replication
     (``box.cfg{replication = <...>}`` call), gh-4440, gh-4576, gh-4586,
     gh-4643
 
-..  _lua-1:
 
 Lua
 ~~~
@@ -233,11 +232,11 @@ Lua
     ``lua_newthread()``, gh-4556 There are several places where a new Lua
     thread is created:
 
-   -  Start execution a Lua function call or an eval request (from a
-      binary protocol, SQL or with ``box.func.<...>:call()``).
-   -  Create of a new fiber.
-   -  Start execution of a trigger.
-   -  Start of encoding into a YAML format (``yaml.encode()``).
+    -   Start execution a Lua function call or an eval request (from a
+        binary protocol, SQL or with ``box.func.<...>:call()``).
+    -   Create of a new fiber.
+    -   Start execution of a trigger.
+    -   Start of encoding into a YAML format (``yaml.encode()``).
 
 -   Fix stack-use-after-scope in json.decode(), gh-4637
 
@@ -270,12 +269,12 @@ flaws, but we are working to make it rich and stable.
     ``\set output lua[,block]`` command, part of gh-3834. In order to
     overcome it two changes were made:
 
-   -  Parse ``\set output lua[,block]`` command on a client prior to
-      sending it to a server, store current responses delimiter (EOS)
-      and use it to determine end of responses.
-   -  Send ``\set output <...>`` command with a default output mode when
-      establishing a connection (it is matter if different default modes
-      are set).
+    -   Parse ``\set output lua[,block]`` command on a client prior to
+        sending it to a server, store current responses delimiter (EOS)
+        and use it to determine end of responses.
+    -   Send ``\set output <...>`` command with a default output mode when
+        establishing a connection (it is matter if different default modes
+        are set).
 
 -   Provide ability to get or set current responses delimiter using
     ``console.eos([<...>])``, part of gh-3834
@@ -293,8 +292,6 @@ LuaJIT
     fixes the following assertion fail: > asm_conv: Assertion
     \`((IRType)((ir->t).irt & IRT_TYPE)) != st’ failed
 
-..  _misc-1:
-
 Misc
 ~~~~
 

doc/release/2.2.3.rst

@@ -119,26 +119,26 @@ LuaJIT
     ``libluajit``, otherwise loading fails. The extension provides the
     following commands:
 
-   -  ``lj-arch`` dumps values of LJ_64 and LJ_GC64 macro definitions
-   -  ``lj-tv`` dumps the type and GCobj info related to the given
-      TValue
-   -  ``lj-str`` dumps the contents of the given GCstr
-   -  ``lj-tab`` dumps the contents of the given GCtab
-   -  ``lj-stack`` dumps Lua stack of the given lua_State
-   -  ``lj-state`` shows current VM, GC and JIT states
-   -  ``lj-gc`` shows current GC stats
+    -   ``lj-arch`` dumps values of LJ_64 and LJ_GC64 macro definitions
+    -   ``lj-tv`` dumps the type and GCobj info related to the given
+        TValue
+    -   ``lj-str`` dumps the contents of the given GCstr
+    -   ``lj-tab`` dumps the contents of the given GCtab
+    -   ``lj-stack`` dumps Lua stack of the given lua_State
+    -   ``lj-state`` shows current VM, GC and JIT states
+    -   ``lj-gc`` shows current GC stats
 
 -   Fix string to number conversion: current implementation respects the
     buffer length (gh-4773).
 
--  “FFI sandwich”(*) detection is introduced. If sandwich is detected
+-  “FFI sandwich”(\*) detection is introduced. If sandwich is detected
     while trace recording the recording is aborted. The sandwich detected
     while mcode execution leads to the platform panic.
 
 -   luaJIT_setmode call is prohibited while mcode execution and leads to
     the platform panic.
 
-(*) The following stack mix is called FFI sandwich:
+(\*) The following stack mix is called FFI sandwich:
 
     Lua-FFI -> C routine -> Lua-C API -> Lua VM