From 77be138d7ae71f327410d15a2deab99f757ab479 Mon Sep 17 00:00:00 2001
From: Pavel Semyonov <p.semyonov@vk.team>
Date: Mon, 20 Feb 2023 19:19:23 +0700
Subject: [PATCH] doc: proofread 2.11.0-rc changelogs, part 3
Proofread changelogs for 2.11.0-rc, part 3
Fix grammar, punctuation, and wording
NO_CHANGELOG=changelog
NO_DOC=changelog
NO_TEST=changelog
---
changelogs/unreleased/downgrade.md | 4 +-
...2867-raise-on-raw-modifications-box.cfg.md | 7 ++--
.../gh-4726-execute-field-in-box.md | 2 +-
.../gh-5272-bootstrap-strategy-auto.md | 38 ++++++++++---------
.../gh-5272-sync-timeout-default.md | 20 +++++-----
.../unreleased/gh-5541-proxy-luajit-flags.md | 6 +--
.../gh-6986-drop-fk-parsing-rules.md | 5 ++-
.../gh-7031-configure-eos-in-lua-console.md | 4 +-
.../unreleased/gh-7202-options-in-atomic.md | 3 +-
.../gh-7456-console-debugger-option.md | 31 +++++++--------
changelogs/unreleased/gh-7726-embed-checks.md | 3 +-
changelogs/unreleased/gh-7747-seqscan.md | 6 +--
.../unreleased/gh-7790-cmd-up-down-swapped.md | 4 +-
.../gh-7790-debugger-breakpoints.md | 10 +++--
.../gh-7845-httpc-stream-io-interface.md | 2 +-
...7901-iproto-request-handlers-overriding.md | 4 +-
.../gh-7972-func-def-wrong-options-err-msg.md | 2 +-
.../gh-8182-module-search-next-to-script.md | 2 +-
.../gh-8249-lual_checkcdata-with-upvalues.md | 4 +-
.../unreleased/gh_8192_feedback_metrics.md | 5 ++-
changelogs/unreleased/module-override.md | 2 +-
21 files changed, 88 insertions(+), 76 deletions(-)
diff --git a/changelogs/unreleased/downgrade.md b/changelogs/unreleased/downgrade.md
index 51df8423ba..21253bfa13 100644
--- a/changelogs/unreleased/downgrade.md
+++ b/changelogs/unreleased/downgrade.md
@@ -1,4 +1,4 @@
## feature/box
-* Added support for downgrading system spaces to state compatible with older
- releases of Tarantool (gh-7718).
+* Added the support for downgrading system spaces to make them compatible with
+ older Tarantool versions (gh-7718).
diff --git a/changelogs/unreleased/gh-2867-raise-on-raw-modifications-box.cfg.md b/changelogs/unreleased/gh-2867-raise-on-raw-modifications-box.cfg.md
index b55d1420a6..c09a8db42e 100644
--- a/changelogs/unreleased/gh-2867-raise-on-raw-modifications-box.cfg.md
+++ b/changelogs/unreleased/gh-2867-raise-on-raw-modifications-box.cfg.md
@@ -1,5 +1,6 @@
## bugfix/core
-* Fixed an incorrect behaviour when assigning a value to parameter in `box.cfg`
- changes nothing. Fix raises an error on change `box.cfg` parameters using
- standard Lua table interface: `box.cfg.background = true` (gh-7350).
+* Fixed a bug when direct assignments of `box.cfg` parameters (such as
+ `box.cfg.background = true`) were silently ignored. Now such assignments
+ result in errors. The correct way to set `box.cfg` parameters is this:
+ `box.cfg{ background=true }` (gh-7350).
diff --git a/changelogs/unreleased/gh-4726-execute-field-in-box.md b/changelogs/unreleased/gh-4726-execute-field-in-box.md
index 7794b7775e..dbc7a4ea18 100644
--- a/changelogs/unreleased/gh-4726-execute-field-in-box.md
+++ b/changelogs/unreleased/gh-4726-execute-field-in-box.md
@@ -1,3 +1,3 @@
## bugfix/box
-* **[Breaking change]** Now `box.execute` cannot be called before `box.cfg` (gh-4726).
+* Now `box.execute` cannot be called before `box.cfg` (gh-4726).
diff --git a/changelogs/unreleased/gh-5272-bootstrap-strategy-auto.md b/changelogs/unreleased/gh-5272-bootstrap-strategy-auto.md
index e2265872f5..0713e406b3 100644
--- a/changelogs/unreleased/gh-5272-bootstrap-strategy-auto.md
+++ b/changelogs/unreleased/gh-5272-bootstrap-strategy-auto.md
@@ -1,33 +1,35 @@
## feature/replication
-* Introduce new configuration option `bootstrap_strategy`. The default value of
- this option - "auto" - brings new replica behaviour on replica set bootstrap,
- replica join to an existing replica set, recovery and replication
- reconfiguration. The user may set the option to "legacy" to fully return to
- old behaviour.
+* Introduced the new configuration option `bootstrap_strategy`. The default
+ value of this option - "auto" - brings the new behavior of replica on:
+ * replica set bootstrap
+ * replica join to an existing replica set
+ * recovery
+ * replication reconfiguration.
- The new option value - "auto" - will be in effect only when no value for
- `replication_connect_quorum` is passed. If the user passes any value of
- `replication_connect_quorum`, `bootstrap_strategy` is automatically set to
- "legacy" for backward compatibility reasons.
+ To return to the old behavior, set the option to "legacy".
- Note, that if you leave the options untouched (that is, `bootstrap_strategy`
- defaults to "auto"), the following behaviour will noticeably change: during
+ The new value "auto" will be in effect only when no value for
+ `replication_connect_quorum` is passed. If a value is present,
+ `bootstrap_strategy` is automatically set to "legacy" to preserve backward
+ compatibility.
+
+ Note that if you leave the options untouched (that is, `bootstrap_strategy`
+ defaults to "auto"), the following behavior will noticeably change: during
the recovery from local files and during replication reconfiguration
`box.cfg{replication = ...}` will not fail even if some (or all) of the remote
- peers listed in `box.cfg.replication` are unavailable. Instead the node will
- try to establish a connection to everyone for a period of
- `replication_connect_timeout` and then transition to
- `box.info.status == "running"` as soon as it syncs with all the reached peers.
- (gh-5272).
+ peers listed in `box.cfg.replication` are unavailable. Instead, the node will
+ try to connect to them for a period of `replication_connect_timeout` and then
+ transition to `box.info.status == "running"` as soon as it syncs with all the
+ reached peers (gh-5272).
* **[Breaking change]** Joining a new replica to a working replica set.
If neither of the configuration options `bootstrap_strategy` and
`replication_connect_quorum` is passed explicitly, or if `bootstrap_strategy`
is set to "auto", bootstrapping a new replica in an existing replica set will
- only succeed if all the replica set members are listed in replica's
+ only succeed if all the replica set members are listed in the replica's
`box.cfg.replication`. For example, when joining a fresh replica to a replica
- set of 3 nodes, all 3 node URIs must be present in replica's
+ set of 3 nodes, all 3 node URIs must be present in the replica's
`box.cfg.replication` parameter. When joining 2 new replicas to a single
master, both replicas must have each other's URIs (alongside with master's
URI) in their `box.cfg.replication` (gh-5272).
diff --git a/changelogs/unreleased/gh-5272-sync-timeout-default.md b/changelogs/unreleased/gh-5272-sync-timeout-default.md
index 62d270f52d..32716180a5 100644
--- a/changelogs/unreleased/gh-5272-sync-timeout-default.md
+++ b/changelogs/unreleased/gh-5272-sync-timeout-default.md
@@ -1,13 +1,13 @@
## feature/replication
-* Added a compat option "box_cfg_replication_sync_timeout" to control the
- default value of "replication_sync_timeout" box.cfg option. Old default is 300
- seconds and new default is 0. The noticeable difference in new behavior is
- that `box.cfg{replication = ""}` call returns before the node is synced with
- remote instances. If one expects the node to be writable once `box.cfg`
- returns, this can be achieved with new behavior by calling `box.ctl.wait_rw()`
- after `box.cfg{replication=...}`.
+* A new `compat` option `box_cfg_replication_sync_timeout` was added to
+ control the default value of `replication_sync_timeout` option of `box.cfg`.
+ The old default is 300 seconds, and new default is 0. The noticeable difference
+ in the new behavior is that `box.cfg{replication = ""}` call now returns
+ before the node is synced with remote instances. If you need the node to be
+ writable once `box.cfg` returns, you can achieve it with new behavior by
+ calling `box.ctl.wait_rw()` after `box.cfg{replication=...}`.
- By default the option is "old" and will be switched to "new" in the next major
- release. If you wish to try out the new behaviour, you have to set the option
- to "new" before the initial `box.cfg{}` call in your application (gh-5272).
+ By default, the option value is "old" and will be switched to "new" in the
+ next major release. To switch to the new behavior, set the option to "new"
+ **before** the initial `box.cfg{}` call in your application (gh-5272).
diff --git a/changelogs/unreleased/gh-5541-proxy-luajit-flags.md b/changelogs/unreleased/gh-5541-proxy-luajit-flags.md
index 7e99ca9767..10d68175da 100644
--- a/changelogs/unreleased/gh-5541-proxy-luajit-flags.md
+++ b/changelogs/unreleased/gh-5541-proxy-luajit-flags.md
@@ -1,5 +1,5 @@
## feature/lua
-* Introduce [`-b`](http://luajit.org/running.html#opt_b) and
- [`-j`](http://luajit.org/running.html#opt_j) flags to be passed to LuaJIT
- runtime for debugging and runtime configuration purposes (gh-5541).
+* Introduced the [`-b`](http://luajit.org/running.html#opt_b) and
+ [`-j`](http://luajit.org/running.html#opt_j) flags that can be passed to
+ LuaJIT runtime for debugging and runtime configuration purposes (gh-5541).
diff --git a/changelogs/unreleased/gh-6986-drop-fk-parsing-rules.md b/changelogs/unreleased/gh-6986-drop-fk-parsing-rules.md
index 136b109e71..e66ed36921 100644
--- a/changelogs/unreleased/gh-6986-drop-fk-parsing-rules.md
+++ b/changelogs/unreleased/gh-6986-drop-fk-parsing-rules.md
@@ -1,4 +1,5 @@
## bugfix/sql
-* Dropped the session setting `sql_defer_foreign_keys` and rules `reference
- trigger action`, `constraint check time`, and `match type` (gh-6986).
+* **[Breaking change in the SQL engine]** Dropped the session setting
+ `sql_defer_foreign_keys` and rules `reference trigger action`,
+ `constraint check time`, and `match type` (gh-6986).
diff --git a/changelogs/unreleased/gh-7031-configure-eos-in-lua-console.md b/changelogs/unreleased/gh-7031-configure-eos-in-lua-console.md
index f81e294b5c..91eb6cb957 100644
--- a/changelogs/unreleased/gh-7031-configure-eos-in-lua-console.md
+++ b/changelogs/unreleased/gh-7031-configure-eos-in-lua-console.md
@@ -1,4 +1,4 @@
## feature/console
-* Introduced a way to configure printed End Of Stream symbol in Lua console.
- Changed default printed EOS to '' (gh-7031).
+* Introduced a way to configure the printed `End Of Stream` (EOS) symbol in the
+ Lua console. Changed the default printed EOS from ';' to '' (gh-7031).
diff --git a/changelogs/unreleased/gh-7202-options-in-atomic.md b/changelogs/unreleased/gh-7202-options-in-atomic.md
index d945ece569..87662bf651 100644
--- a/changelogs/unreleased/gh-7202-options-in-atomic.md
+++ b/changelogs/unreleased/gh-7202-options-in-atomic.md
@@ -1,3 +1,4 @@
## feature/box
-* Introduced transaction options in box.atomic() by analogy with box.begin() (gh-7202).
+* Introduced transaction options in `box.atomic()` by analogy with `box.begin()`
+ (gh-7202).
diff --git a/changelogs/unreleased/gh-7456-console-debugger-option.md b/changelogs/unreleased/gh-7456-console-debugger-option.md
index 88b9508a1d..085bb8f37c 100644
--- a/changelogs/unreleased/gh-7456-console-debugger-option.md
+++ b/changelogs/unreleased/gh-7456-console-debugger-option.md
@@ -1,18 +1,19 @@
## feature/debugger
-* Introduced command-line option which runs debugger console
- instead of standard interactive console (gh-7456).
+* Introduced the `-d` command-line option which runs the debugger console
+ instead of the standard interactive console (gh-7456).
-```sh
-$ tarantool -d debug-target.lua
-Tarantool debugger 2.11.0-entrypoint-852-g9e6ed28ae
-type 'help' for interactive help
-luadebug: Loaded for 2.11.0-entrypoint-852-g9e6ed28ae
-break via debug-target.lua => debug-target.lua:1 in chunk at debug-target.lua:0
- 1 => local date = require 'datetime'
- 4
-luadebug>
-```
-This is more convenient way to initiate debugger session, instead
-of an older, more invasive approach of instrumenting code with
-`require 'luadebug'()` call.
+ ```sh
+ $ tarantool -d debug-target.lua
+ Tarantool debugger 2.11.0-entrypoint-852-g9e6ed28ae
+ type 'help' for interactive help
+ luadebug: Loaded for 2.11.0-entrypoint-852-g9e6ed28ae
+ break via debug-target.lua => debug-target.lua:1 in chunk at debug-target.lua:0
+ 1 => local date = require 'datetime'
+ 4
+ luadebug>
+ ```
+
+ This is a more convenient way to initiate a debugger session instead
+ of an older, more invasive approach of instrumenting the code with a
+ `require 'luadebug'()` call.
diff --git a/changelogs/unreleased/gh-7726-embed-checks.md b/changelogs/unreleased/gh-7726-embed-checks.md
index 1ebada108f..e81ea0cc62 100644
--- a/changelogs/unreleased/gh-7726-embed-checks.md
+++ b/changelogs/unreleased/gh-7726-embed-checks.md
@@ -1,3 +1,4 @@
## feature/lua
-* Embed tarantool/checks module for function input validation (gh-7726).
+* Embedded the `tarantool/checks` module for function input validation
+ (gh-7726).
diff --git a/changelogs/unreleased/gh-7747-seqscan.md b/changelogs/unreleased/gh-7747-seqscan.md
index 0f25f5ac41..01cf2e8bd1 100644
--- a/changelogs/unreleased/gh-7747-seqscan.md
+++ b/changelogs/unreleased/gh-7747-seqscan.md
@@ -2,6 +2,6 @@
* Introduced the new keyword `SEQSCAN` for SQL `SELECT` queries. You may now
use a scanning SQL `SELECT` query without the `SEQSCAN` keyword only if the
- `sql_seq_scan` session setting is set to `true`. The default session setting
- value is controlled by the new `compat` option `sql_seq_scan_default`
- (gh-7747).
+ `sql_seq_scan` session setting is set to `true`. A new `compat` option
+ `sql_seq_scan_default` is added for managing the default value of
+ `sql_seq_scan` (gh-7747).
diff --git a/changelogs/unreleased/gh-7790-cmd-up-down-swapped.md b/changelogs/unreleased/gh-7790-cmd-up-down-swapped.md
index 1379386f73..b8c497f247 100644
--- a/changelogs/unreleased/gh-7790-cmd-up-down-swapped.md
+++ b/changelogs/unreleased/gh-7790-cmd-up-down-swapped.md
@@ -1,4 +1,4 @@
## feature/debugger
-* Swapped 'up' and 'down' commands in debugger - to make them behave more
- like in `gdb`/`lldb`.
+* Swapped 'up' and 'down' commands in the debugger to make them behave similar
+ to those in `gdb` and `lldb`.
diff --git a/changelogs/unreleased/gh-7790-debugger-breakpoints.md b/changelogs/unreleased/gh-7790-debugger-breakpoints.md
index a053135154..5dd0ecc021 100644
--- a/changelogs/unreleased/gh-7790-debugger-breakpoints.md
+++ b/changelogs/unreleased/gh-7790-debugger-breakpoints.md
@@ -1,10 +1,14 @@
## feature/debugger
-* Added breakpoints support to the builtin console debugger `luadebug.lua`;
-* To support easier debugging of files with the same name (i.e. `init.lua`)
- breakpoints handle partial path lookup in a form:
+* Added the support for breakpoints to the builtin console debugger
+ `luadebug.lua`.
+* Made is easier to debug files with the same name (such as `init.lua`)
+ by handling partial path lookup in breakpoints:
+
+ ```
break B/init.lua:10
break A/init.lua:20
break ./main.lua:30
break ../a/b/c/leaf.lua:40
+ ```
diff --git a/changelogs/unreleased/gh-7845-httpc-stream-io-interface.md b/changelogs/unreleased/gh-7845-httpc-stream-io-interface.md
index 8741726839..a131478269 100644
--- a/changelogs/unreleased/gh-7845-httpc-stream-io-interface.md
+++ b/changelogs/unreleased/gh-7845-httpc-stream-io-interface.md
@@ -1,3 +1,3 @@
## feature/lua/http client
-* Introduce stream input/output interface for http.client (gh-7845).
+* Introduced stream input/output interface for ``http.client`` (gh-7845).
diff --git a/changelogs/unreleased/gh-7901-iproto-request-handlers-overriding.md b/changelogs/unreleased/gh-7901-iproto-request-handlers-overriding.md
index 1d6b32ee32..d628885691 100644
--- a/changelogs/unreleased/gh-7901-iproto-request-handlers-overriding.md
+++ b/changelogs/unreleased/gh-7901-iproto-request-handlers-overriding.md
@@ -1,4 +1,4 @@
## feature/box
-* Added the feature to set IPROTO request handler callbacks from Lua using
- `box.iproto.override` and from C using `box_iproto_override` (gh-7901).
+* It is now possible to set IPROTO request handler callbacks from Lua (using
+ `box.iproto.override`) and from C (using `box_iproto_override`) (gh-7901).
diff --git a/changelogs/unreleased/gh-7972-func-def-wrong-options-err-msg.md b/changelogs/unreleased/gh-7972-func-def-wrong-options-err-msg.md
index 98d0e39c4c..52ee244ff4 100644
--- a/changelogs/unreleased/gh-7972-func-def-wrong-options-err-msg.md
+++ b/changelogs/unreleased/gh-7972-func-def-wrong-options-err-msg.md
@@ -1,4 +1,4 @@
## bugfix/box
-* Fixed error message for wrong options provided to function definition
+* Fixed the error message for wrong options provided to a function definition
(gh-7972).
diff --git a/changelogs/unreleased/gh-8182-module-search-next-to-script.md b/changelogs/unreleased/gh-8182-module-search-next-to-script.md
index 42fb277f0d..4895eef6b6 100644
--- a/changelogs/unreleased/gh-8182-module-search-next-to-script.md
+++ b/changelogs/unreleased/gh-8182-module-search-next-to-script.md
@@ -1,3 +1,3 @@
## feature/lua
-* Default module search paths now include the main script directory (gh-8182).
+* Default module search paths now include the main script directory (gh-8182).
diff --git a/changelogs/unreleased/gh-8249-lual_checkcdata-with-upvalues.md b/changelogs/unreleased/gh-8249-lual_checkcdata-with-upvalues.md
index 69f55233d7..dd9421d45c 100644
--- a/changelogs/unreleased/gh-8249-lual_checkcdata-with-upvalues.md
+++ b/changelogs/unreleased/gh-8249-lual_checkcdata-with-upvalues.md
@@ -1,5 +1,5 @@
## bugfix/lua
-* Fixed a bug that prevents using C module API methods `luaL_iscallable()`,
- `luaL_checkcdata()` and `luaL_setcdatagc()` with the upvalue indexes
+* Fixed a bug that prevented using C module API methods `luaL_iscallable()`,
+ `luaL_checkcdata()`, and `luaL_setcdatagc()` with the upvalue indexes
(gh-8249).
diff --git a/changelogs/unreleased/gh_8192_feedback_metrics.md b/changelogs/unreleased/gh_8192_feedback_metrics.md
index 53748421d5..844ba902af 100644
--- a/changelogs/unreleased/gh_8192_feedback_metrics.md
+++ b/changelogs/unreleased/gh_8192_feedback_metrics.md
@@ -1,4 +1,5 @@
## feature/box
-* Now feedback daemon collects metrics if module metrics of required
- version is installed (gh-8192). Feedback version is bumped.
+* The feedback daemon now collects metrics if the required version of the
+ ``metrics`` module is installed (gh-8192). ``feedback_version`` is updated
+ to 8.
diff --git a/changelogs/unreleased/module-override.md b/changelogs/unreleased/module-override.md
index 16429752cd..6ad56775cb 100644
--- a/changelogs/unreleased/module-override.md
+++ b/changelogs/unreleased/module-override.md
@@ -1,3 +1,3 @@
## feature/lua
-* Added ability to override a built-in module by an external one (gh-7774).
+* Added the ability to override a built-in module by an external one (gh-7774).
--
GitLab