From 9ee18a181392246844cffe7df474086303e24c8c Mon Sep 17 00:00:00 2001 From: Pavel Semyonov <p.semyonov@vk.team> Date: Fri, 13 Jan 2023 13:22:46 +0700 Subject: [PATCH] Proofread changelogs Fix grammar, wording, and formatting NO_CHANGELOG=changelog NO_DOC=changelog NO_TEST=changelog --- changelogs/unreleased/add-fiber_set_ctx.md | 4 ++-- changelogs/unreleased/decimal-lua-module-api.md | 2 +- changelogs/unreleased/drop-opensuse-ci-cd.md | 2 +- .../unreleased/gh-3012-yaml-prettier-multiline-output | 4 ---- .../unreleased/gh-3012-yaml-prettier-multiline-output.md | 5 +++++ changelogs/unreleased/gh-3159-recovery-triggers.md | 7 +++---- changelogs/unreleased/gh-3211-per-module-log_level.md | 2 +- changelogs/unreleased/gh-3682-uri-encode-decode.md | 3 ++- changelogs/unreleased/gh-4726-execute-field-in-box.md | 3 +-- .../unreleased/gh-5158-invalid-recovery-from-xlog.md | 2 +- changelogs/unreleased/gh-5665-get-rid-of-fiber_gc.md | 4 ++-- .../unreleased/gh-5869-remove-fiber-top-cpu_misses.md | 2 +- .../unreleased/gh-6011-follow-env-vars-on-log-cfg.md | 4 ++-- changelogs/unreleased/gh-6085-log-and-limit-iteration.md | 8 ++++---- changelogs/unreleased/gh-6126-retry-join-automatically.md | 8 ++++---- .../unreleased/gh-6200-lua_cjson-encode-escapes-slash.md | 5 +++-- changelogs/unreleased/gh-6251-operator-brackets.md | 2 +- .../gh-6506-allow-spurious-wakeups-in-wal_write.md | 2 +- changelogs/unreleased/gh-6530-netbox-opts-check.md | 4 ++-- changelogs/unreleased/gh-6572-nan-is-not-null.md | 2 +- changelogs/unreleased/gh-6575-assertion-in-modulo.md | 4 ++-- 21 files changed, 40 insertions(+), 39 deletions(-) delete mode 100644 changelogs/unreleased/gh-3012-yaml-prettier-multiline-output create mode 100644 changelogs/unreleased/gh-3012-yaml-prettier-multiline-output.md diff --git a/changelogs/unreleased/add-fiber_set_ctx.md b/changelogs/unreleased/add-fiber_set_ctx.md index a7fdc653b5..faca0599d3 100644 --- a/changelogs/unreleased/add-fiber_set_ctx.md +++ b/changelogs/unreleased/add-fiber_set_ctx.md @@ -1,4 +1,4 @@ ## feature/fiber -* Add fiber_set_ctx/fiber_get_ctx api functions to pass data to fibers without -yielding immediately. +* Add `fiber_set_ctx` and `fiber_get_ctx` C API functions to pass data to fibers without +yielding immediately (gh-7669). diff --git a/changelogs/unreleased/decimal-lua-module-api.md b/changelogs/unreleased/decimal-lua-module-api.md index 364de93a0d..6a68c6b65e 100644 --- a/changelogs/unreleased/decimal-lua-module-api.md +++ b/changelogs/unreleased/decimal-lua-module-api.md @@ -1,3 +1,3 @@ ## feature/decimal -* Added Lua/C accessors for decimals into the module API (gh-7228). +* Added Lua and C accessors for decimals into the module API (gh-7228). diff --git a/changelogs/unreleased/drop-opensuse-ci-cd.md b/changelogs/unreleased/drop-opensuse-ci-cd.md index 7ad6d1edbe..cc3bc0d73d 100644 --- a/changelogs/unreleased/drop-opensuse-ci-cd.md +++ b/changelogs/unreleased/drop-opensuse-ci-cd.md @@ -1,3 +1,3 @@ ## feature/build -* Drop support for OpenSUSE 15.1/15.2 builds. +* OpenSUSE 15.1 and 15.2 are no longer supported. diff --git a/changelogs/unreleased/gh-3012-yaml-prettier-multiline-output b/changelogs/unreleased/gh-3012-yaml-prettier-multiline-output deleted file mode 100644 index cf9e863d42..0000000000 --- a/changelogs/unreleased/gh-3012-yaml-prettier-multiline-output +++ /dev/null @@ -1,4 +0,0 @@ -## feature/yaml - -* Lua-yaml readability improvement is introduced as a new compat option: - multiline strings can be encoded in literal-scalar style (gh-3012). diff --git a/changelogs/unreleased/gh-3012-yaml-prettier-multiline-output.md b/changelogs/unreleased/gh-3012-yaml-prettier-multiline-output.md new file mode 100644 index 0000000000..bd0077541f --- /dev/null +++ b/changelogs/unreleased/gh-3012-yaml-prettier-multiline-output.md @@ -0,0 +1,5 @@ +## feature/yaml + +* Now `yaml.encode` can encode multiline strings in literal-scalar style + for better readability. A new `tarantool.compat` option `yaml_pretty_multiline` + is added for switching to the new behavior (gh-3012). diff --git a/changelogs/unreleased/gh-3159-recovery-triggers.md b/changelogs/unreleased/gh-3159-recovery-triggers.md index 645c97c037..f94b6f6e14 100644 --- a/changelogs/unreleased/gh-3159-recovery-triggers.md +++ b/changelogs/unreleased/gh-3159-recovery-triggers.md @@ -1,7 +1,6 @@ ## feature/box * It is now possible to register triggers for various recovery stages: use - `box.ctl.on_recovery_state()` before initial `box.cfg()` call. The trigger - receives one parameter - a string resembling reached recovery stage. Possible - values are "snapshot_recovered", "wal_recovered", "indexes_built", "synced" - (gh-3159). + `box.ctl.on_recovery_state()` before the initial `box.cfg()` call. + The trigger has one parameter – a string that shows the reached recovery stage: + `snapshot_recovered`, `wal_recovered`, `indexes_built`, or `synced` (gh-3159). diff --git a/changelogs/unreleased/gh-3211-per-module-log_level.md b/changelogs/unreleased/gh-3211-per-module-log_level.md index 664369f3a1..75ccbe317c 100644 --- a/changelogs/unreleased/gh-3211-per-module-log_level.md +++ b/changelogs/unreleased/gh-3211-per-module-log_level.md @@ -3,5 +3,5 @@ * **[Breaking change]** Now the log message contains the name of a module from which the logging function was called (gh-3211). -* Supported per-module log level setting via `log.cfg{modules = {...}}` or via +* Now the log level can be set for specific modules using `log.cfg{modules = {...}}` or `box.cfg{log_modules = {...}}` (gh-3211). diff --git a/changelogs/unreleased/gh-3682-uri-encode-decode.md b/changelogs/unreleased/gh-3682-uri-encode-decode.md index 1ab748ef05..547f8ec1d8 100644 --- a/changelogs/unreleased/gh-3682-uri-encode-decode.md +++ b/changelogs/unreleased/gh-3682-uri-encode-decode.md @@ -1,3 +1,4 @@ ## feature/lua/uri -* Added functions for percent-encoding and decoding of URI's parts (gh-3682). +* Added functions `uri.escape()` and `uri.unescape()` for percent-encoding + and decoding URI parts (gh-3682). diff --git a/changelogs/unreleased/gh-4726-execute-field-in-box.md b/changelogs/unreleased/gh-4726-execute-field-in-box.md index 2437b385d9..7794b7775e 100644 --- a/changelogs/unreleased/gh-4726-execute-field-in-box.md +++ b/changelogs/unreleased/gh-4726-execute-field-in-box.md @@ -1,4 +1,3 @@ ## bugfix/box -* **[Breaking change]** Now the "execute" field is not available until box is - configured (gh-4726). +* **[Breaking change]** Now `box.execute` cannot be called before `box.cfg` (gh-4726). diff --git a/changelogs/unreleased/gh-5158-invalid-recovery-from-xlog.md b/changelogs/unreleased/gh-5158-invalid-recovery-from-xlog.md index 9ab1dc1037..8bc61c62e9 100644 --- a/changelogs/unreleased/gh-5158-invalid-recovery-from-xlog.md +++ b/changelogs/unreleased/gh-5158-invalid-recovery-from-xlog.md @@ -1,4 +1,4 @@ ## bugfix/replication -* Fixed an assertion failure on master when replica resubscribes with a +* Fixed an assertion failure on master when a replica resubscribes with a smaller vclock than previously seen (gh-5158). diff --git a/changelogs/unreleased/gh-5665-get-rid-of-fiber_gc.md b/changelogs/unreleased/gh-5665-get-rid-of-fiber_gc.md index f1d04e42dd..3499e404c2 100644 --- a/changelogs/unreleased/gh-5665-get-rid-of-fiber_gc.md +++ b/changelogs/unreleased/gh-5665-get-rid-of-fiber_gc.md @@ -1,7 +1,7 @@ ## bugfix/core -* **[Breaking change]** `box_region_alloc` not paired with - `box_region_truncate` will produce leaks. Previously, one could +* **[Breaking change]** A `box_region_alloc` call that is not paired with + a `box_region_truncate` call produces leaks. Previously, one could rely on some C API functions (like executing a DML statement) truncating fiber region to 0. Now, none of the box C API functions truncates memory it doesn't own (gh-5665). diff --git a/changelogs/unreleased/gh-5869-remove-fiber-top-cpu_misses.md b/changelogs/unreleased/gh-5869-remove-fiber-top-cpu_misses.md index 60ec696c80..40a99b3660 100644 --- a/changelogs/unreleased/gh-5869-remove-fiber-top-cpu_misses.md +++ b/changelogs/unreleased/gh-5869-remove-fiber-top-cpu_misses.md @@ -1,4 +1,4 @@ ## feature/core -* **[Breaking change]** Removed `cpu_misses` entry from `fiber.top()` +* **[Breaking change]** Removed the `cpu_misses` entry from the `fiber.top()` output (gh-5869). diff --git a/changelogs/unreleased/gh-6011-follow-env-vars-on-log-cfg.md b/changelogs/unreleased/gh-6011-follow-env-vars-on-log-cfg.md index 39e4df5af0..2a6c57b29e 100644 --- a/changelogs/unreleased/gh-6011-follow-env-vars-on-log-cfg.md +++ b/changelogs/unreleased/gh-6011-follow-env-vars-on-log-cfg.md @@ -1,4 +1,4 @@ ## feature/box -* Env variables are taken into account if log is configured before box thru - log.cfg call (gh-6011). +* Environment variables (TT_LOG, TT_LOG_LEVEL, and other) are taken into account + if logging is configured using `log.cfg` before `box.cfg` is called (gh-6011). diff --git a/changelogs/unreleased/gh-6085-log-and-limit-iteration.md b/changelogs/unreleased/gh-6085-log-and-limit-iteration.md index dcb14b9bcd..09af999dd0 100644 --- a/changelogs/unreleased/gh-6085-log-and-limit-iteration.md +++ b/changelogs/unreleased/gh-6085-log-and-limit-iteration.md @@ -1,13 +1,13 @@ ## feature/core * **[Breaking change]** Introduced the mechanism for catching fibers running - without yield for too long. Now, box operations, such as `select` and + without yielding for too long. Now box operations, such as `select` and `replace`, will throw an error if the fiber execution time since yield exceeds the limit. The limit can also be checked from the application code - with `fiber.check_slice()`. The default limit is one second, but it can be - overwritten with `fiber.set_slice()` (gh-6085). + with `fiber.check_slice()`. The default limit is one second; you can + overwrite it with `fiber.set_slice()` (gh-6085). ---- -Breaking change: long running non-yielding fibers can be interrupted because of +Breaking change: long-running non-yielding fibers can be interrupted because of the fiber execution time slice limit. diff --git a/changelogs/unreleased/gh-6126-retry-join-automatically.md b/changelogs/unreleased/gh-6126-retry-join-automatically.md index a4e4d4b3bb..7beb8d813a 100644 --- a/changelogs/unreleased/gh-6126-retry-join-automatically.md +++ b/changelogs/unreleased/gh-6126-retry-join-automatically.md @@ -1,10 +1,10 @@ ## feature/core -* Now if join fails with some non-critical error, like `ER_READONLY`, - `ER_ACCESS_DENIED` or something network-related, the instance tries - to find a new master to join off and tries again (gh-6126). +* Now if a join fails with a non-critical error, such as `ER_READONLY`, + `ER_ACCESS_DENIED`, or a network-related error, the instance tries + to find a new master to join to and tries again (gh-6126). -* States when joining a replica are renamed. So now when querying +* Renamed replication states when a replica is joining. Now when querying `box.info.replication[id].upstream.status` during join, you will see either `wait_snapshot` or `fetch_snapshot` instead of `initial_join` (gh-6126). diff --git a/changelogs/unreleased/gh-6200-lua_cjson-encode-escapes-slash.md b/changelogs/unreleased/gh-6200-lua_cjson-encode-escapes-slash.md index 479a3af6fb..1bc57f699f 100644 --- a/changelogs/unreleased/gh-6200-lua_cjson-encode-escapes-slash.md +++ b/changelogs/unreleased/gh-6200-lua_cjson-encode-escapes-slash.md @@ -1,4 +1,5 @@ ## bugfix/lua/json -* Added `json_escape_forward_slash` option to tarantool.compat and implemented - corresponding changes in json and msgpuck built-in modules (gh-6200). +* Now the forward slash (`/`) is not escaped in `json.encode()` and msgpack. + A new `tarantool.compat` option `json_escape_forward_slash` is added for + switching to the new behavior (gh-6200). diff --git a/changelogs/unreleased/gh-6251-operator-brackets.md b/changelogs/unreleased/gh-6251-operator-brackets.md index 404da691f6..3af4fb19a0 100644 --- a/changelogs/unreleased/gh-6251-operator-brackets.md +++ b/changelogs/unreleased/gh-6251-operator-brackets.md @@ -1,3 +1,3 @@ ## feature/sql -* Introduced `[]` operator for `MAP` and `ARRAY` values (gh-6251). +* Introduced the `[]` (index access) operator for `MAP` and `ARRAY` values (gh-6251). diff --git a/changelogs/unreleased/gh-6506-allow-spurious-wakeups-in-wal_write.md b/changelogs/unreleased/gh-6506-allow-spurious-wakeups-in-wal_write.md index 012556cb58..ec70872688 100644 --- a/changelogs/unreleased/gh-6506-allow-spurious-wakeups-in-wal_write.md +++ b/changelogs/unreleased/gh-6506-allow-spurious-wakeups-in-wal_write.md @@ -1,4 +1,4 @@ ## bugfix/core -* Allowed spurious wakeup of a fiber, which is waiting for WAL write completion +* Allowed spurious wakeup of a fiber that is waiting for WAL write completion (gh-6506). diff --git a/changelogs/unreleased/gh-6530-netbox-opts-check.md b/changelogs/unreleased/gh-6530-netbox-opts-check.md index 72d46a09e7..a71e9c5c8f 100644 --- a/changelogs/unreleased/gh-6530-netbox-opts-check.md +++ b/changelogs/unreleased/gh-6530-netbox-opts-check.md @@ -1,5 +1,5 @@ ## bugfix/core -* Added type checking for options in net.box's remote queries and - connect method. Now graceful errors are thrown in case of incorrect +* Added type checking for options in `net.box` remote queries and + `connect` method. Now graceful errors are thrown in case of incorrect options (gh-6063, gh-6530). diff --git a/changelogs/unreleased/gh-6572-nan-is-not-null.md b/changelogs/unreleased/gh-6572-nan-is-not-null.md index b6e73bd8ad..ce47834514 100644 --- a/changelogs/unreleased/gh-6572-nan-is-not-null.md +++ b/changelogs/unreleased/gh-6572-nan-is-not-null.md @@ -1,3 +1,3 @@ ## bugfix/sql -* Now NaN is always considered NULL (gh-6572). +* Now `NaN` is always considered `NULL` (gh-6572). diff --git a/changelogs/unreleased/gh-6575-assertion-in-modulo.md b/changelogs/unreleased/gh-6575-assertion-in-modulo.md index 1558b27a3a..7d6e68659c 100644 --- a/changelogs/unreleased/gh-6575-assertion-in-modulo.md +++ b/changelogs/unreleased/gh-6575-assertion-in-modulo.md @@ -1,4 +1,4 @@ ## bugfix/sql -* Fixed assertion due to the % operation when the left value is negative and the - result is 0 (gh-6575). +* Fixed assertion in the `%` (modulo) operation when the left value is negative + and the result is 0 (gh-6575). -- GitLab