From 259caf942dd2b74ad629ba4d12d00cdeba58a973 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Fri, 30 Aug 2024 14:58:32 +0200 Subject: [PATCH] cleanup changelogs --- changelog/unreleased/issue-2004 | 10 +++++----- changelog/unreleased/issue-4795 | 7 ++++--- changelog/unreleased/issue-4934 | 12 +++++++----- changelog/unreleased/issue-4944 | 7 ++++--- changelog/unreleased/issue-4945 | 6 ++++-- changelog/unreleased/issue-4953 | 4 ++-- changelog/unreleased/issue-4957 | 8 ++++---- changelog/unreleased/issue-4969 | 4 ++-- changelog/unreleased/issue-4970 | 9 +++++---- changelog/unreleased/issue-4975 | 3 ++- changelog/unreleased/issue-5004 | 2 +- changelog/unreleased/issue-5005 | 15 +++++++++------ changelog/unreleased/pull-4958 | 6 +++--- changelog/unreleased/pull-4959 | 6 +++--- changelog/unreleased/pull-4977 | 17 +++++++++-------- changelog/unreleased/pull-4980 | 13 ++++++------- changelog/unreleased/pull-5018 | 8 ++++---- 17 files changed, 74 insertions(+), 63 deletions(-) diff --git a/changelog/unreleased/issue-2004 b/changelog/unreleased/issue-2004 index 45bc07ca8..a15651d75 100644 --- a/changelog/unreleased/issue-2004 +++ b/changelog/unreleased/issue-2004 @@ -1,15 +1,15 @@ -Bugfix: Correctly handle passing volume name to `backup` command +Bugfix: Correctly handle volume names in `backup` command on Windows On Windows, when the specified backup target only included the volume name without a trailing slash, for example, `C:`, then restoring the resulting snapshot would result in an error. Note that using `C:\` as backup target worked correctly. -Specifying volume names now works correctly. +Specifying volume names is now handled correctly. -To restore snapshots created before this bugfix, use the `:` -syntax. For a snapshot with ID `12345678` and a backup of `C:`, the following -command can be used: +To restore snapshots created before this bugfix, use the : +syntax. For example, to restore a snapshot with ID `12345678` that backed up +`C:`, use the following command: ``` restic restore 12345678:/C/C:./ --target output/folder diff --git a/changelog/unreleased/issue-4795 b/changelog/unreleased/issue-4795 index 084335f51..ff86f0931 100644 --- a/changelog/unreleased/issue-4795 +++ b/changelog/unreleased/issue-4795 @@ -1,7 +1,8 @@ -Enhancement: `restore --verify` shows progress with a progress bar +Enhancement: Display progress bar for `restore --verify` -If restore command was run with `--verify` restic didn't show any progress indication, now it shows a progress bar while 'verification' is running. -The progress bar is text only for now and doesn't respect `--json` flag. +When the `restore` command is run with `--verify`, it now displays a progress +bar while the verification step is running. The progress bar is not shown when +the `--json` flag is specified. https://github.com/restic/restic/issues/4795 https://github.com/restic/restic/pull/4989 diff --git a/changelog/unreleased/issue-4934 b/changelog/unreleased/issue-4934 index 6891ca204..56e22ad28 100644 --- a/changelog/unreleased/issue-4934 +++ b/changelog/unreleased/issue-4934 @@ -1,8 +1,10 @@ -Enhancement: Clear removed snapshots from local cache of the current host +Enhancement: Automatically clear removed snapshots from cache -Restic only removed snapshots from the cache on the host that runs the `forget` command. -On other hosts that use the same repository, the old snapshots remained in the cache. -Restic now, automatically clears old snapshots from the local cache of the current host. +Previously, restic only removed snapshots from the cache on the host where the +`forget` command was executed. On other hosts that use the same repository, the +old snapshots remained in the cache. + +Restic now automatically clears old snapshots from the local cache of the current host. https://github.com/restic/restic/issues/4934 -https://github.com/restic/restic/pull/4981 \ No newline at end of file +https://github.com/restic/restic/pull/4981 diff --git a/changelog/unreleased/issue-4944 b/changelog/unreleased/issue-4944 index 02f5ae341..738da8e57 100644 --- a/changelog/unreleased/issue-4944 +++ b/changelog/unreleased/issue-4944 @@ -1,8 +1,9 @@ Enhancement: Print JSON-formatted errors during `restore --json` -Restic printed any restore errors directly to the console as freeform -text messages, even with `--json`. Restic now prints them as JSON formatted -messages when `--json` is passed. +Restic printed any `restore` errors directly to the console as freeform text +messages, even when using the `--json` option. + +Now, when `--json` is specified, restic prints them as JSON formatted messages. https://github.com/restic/restic/issues/4944 https://github.com/restic/restic/pull/4946 diff --git a/changelog/unreleased/issue-4945 b/changelog/unreleased/issue-4945 index 7bbf69fac..024b30b21 100644 --- a/changelog/unreleased/issue-4945 +++ b/changelog/unreleased/issue-4945 @@ -1,7 +1,9 @@ Bugfix: Include missing backup error text with `--json` -Restic was not actually providing the text of an error message during -backup if `--json` was passed, instead only printing `"error": {}`. +Previously, when running a backup with the `--json` option, restic failed to +include the actual error message in the output, resulting in `"error": {}` +being displayed. + Restic now includes the error text in JSON output. https://github.com/restic/restic/issues/4945 diff --git a/changelog/unreleased/issue-4953 b/changelog/unreleased/issue-4953 index 78a266aff..c542377fc 100644 --- a/changelog/unreleased/issue-4953 +++ b/changelog/unreleased/issue-4953 @@ -1,7 +1,7 @@ Bugfix: Correctly handle long paths on older Windows versions -When using older Windows versions, like Windows Server 2012, restic 0.17.0 -failed to back up files with long paths. This has been fixed. +On older Windows versions, like Windows Server 2012, restic 0.17.0 failed to +back up files with long paths. This problem has now been resolved. https://github.com/restic/restic/issues/4953 https://github.com/restic/restic/pull/4954 diff --git a/changelog/unreleased/issue-4957 b/changelog/unreleased/issue-4957 index d18e28ec9..5da7463ae 100644 --- a/changelog/unreleased/issue-4957 +++ b/changelog/unreleased/issue-4957 @@ -1,8 +1,8 @@ -Bugfix: Fix delayed cancelation of some commands +Bugfix: Fix delayed cancellation of certain commands -Since restic 0.17.0, some commands no longer promptly reacted to being canceled -via Ctrl-C (SIGINT) and continued to run for a limited amount of time. The most -affected commands were `diff`,`find`, `ls`, `stats` and `rewrite`. +Since restic 0.17.0, some commands did not immediately respond to cancellation +via Ctrl-C (SIGINT) and continued running for a short period. The most affected +commands were `diff`,`find`, `ls`, `stats` and `rewrite`. This has been fixed. diff --git a/changelog/unreleased/issue-4969 b/changelog/unreleased/issue-4969 index ce76a7389..9015c2eab 100644 --- a/changelog/unreleased/issue-4969 +++ b/changelog/unreleased/issue-4969 @@ -1,7 +1,7 @@ Bugfix: Correctly restore timestamp for files with resource forks on macOS -On macOS, timestamps were incorrectly restored for files with resource forks. -This has been fixed. +On macOS, timestamps were not restored for files with resource forks. This has +been fixed. https://github.com/restic/restic/issues/4969 https://github.com/restic/restic/pull/5006 diff --git a/changelog/unreleased/issue-4970 b/changelog/unreleased/issue-4970 index 524e91b75..2fc9300c9 100644 --- a/changelog/unreleased/issue-4970 +++ b/changelog/unreleased/issue-4970 @@ -1,9 +1,10 @@ Enhancement: Make timeout for stuck requests customizable -Restic monitors connections to the backend to detect stuck requests. If a request -does not return any data within five minutes, restic assumes the request is stuck and -retries it. However, for large repositories it sometimes takes longer than that to -collect a list of all files, causing the following error: +Restic monitors connections to the backend to detect stuck requests. If a +request does not return any data within five minutes, restic assumes the +request is stuck and retries it. However, for large repositories this timeout +might be insufficient to collect a list of all files, causing the following +error: `List(data) returned error, retrying after 1s: [...]: request timeout` diff --git a/changelog/unreleased/issue-4975 b/changelog/unreleased/issue-4975 index 0e29935f5..2503f46da 100644 --- a/changelog/unreleased/issue-4975 +++ b/changelog/unreleased/issue-4975 @@ -1,6 +1,7 @@ Bugfix: Prevent `backup --stdin-from-command` from panicking -If --stdin-from-command is used, restic now checks whether there is a command behind it. +Restic would previously crash if `--stdin-from-command` was specified without +providing a command. This issue has been fixed. https://github.com/restic/restic/issues/4975 https://github.com/restic/restic/pull/4976 diff --git a/changelog/unreleased/issue-5004 b/changelog/unreleased/issue-5004 index 529b65464..a0df9478e 100644 --- a/changelog/unreleased/issue-5004 +++ b/changelog/unreleased/issue-5004 @@ -1,6 +1,6 @@ Bugfix: Fix spurious "A Required Privilege Is Not Held by the Client" error -On Windows, creating a backup could sometimes print the following error +On Windows, creating a backup could sometimes trigger the following error: ``` error: nodeFromFileInfo [...]: get named security info failed with: a required privilege is not held by the client. diff --git a/changelog/unreleased/issue-5005 b/changelog/unreleased/issue-5005 index 90c164b07..eb712b967 100644 --- a/changelog/unreleased/issue-5005 +++ b/changelog/unreleased/issue-5005 @@ -1,12 +1,15 @@ Bugfix: Fix rare failures to retry locking a repository -Restic 0.17.0 could in rare cases fail to retry locking a repository if -one of the lock files failed to load. The lock operation failed with error -`unable to create lock in backend: circuit breaker open for file ` +Restic 0.17.0 could in rare cases fail to retry locking a repository if one of +the lock files failed to load, resulting in the error: -The error handling has been fixed to correctly retry locking the repository. -In addition, restic now waits a few seconds between locking retries to -increase chances of success. +``` +unable to create lock in backend: circuit breaker open for file +``` + +This issue has been addressed. The error handling now properly retries the +locking operation. In addition, restic waits a few seconds between locking +retries to increase chances of successful locking. https://github.com/restic/restic/issues/5005 https://github.com/restic/restic/pull/5011 diff --git a/changelog/unreleased/pull-4958 b/changelog/unreleased/pull-4958 index bbb28a97b..02574ad33 100644 --- a/changelog/unreleased/pull-4958 +++ b/changelog/unreleased/pull-4958 @@ -1,7 +1,7 @@ Bugfix: Don't ignore metadata-setting errors during restore -Restic was accidentally ignoring errors when setting timestamps, -attributes, or file modes during restore. It will now report those -errors (unless it's just a permission error when not running as root). +Restic ignored errors when setting timestamps, attributes, or file modes during +a restore. It now reports those, except for permission errors when running +without root privileges. https://github.com/restic/restic/pull/4958 diff --git a/changelog/unreleased/pull-4959 b/changelog/unreleased/pull-4959 index 120527e22..80b2780b2 100644 --- a/changelog/unreleased/pull-4959 +++ b/changelog/unreleased/pull-4959 @@ -1,6 +1,6 @@ -Enhancement: Return exit code 12 for "bad password" +Enhancement: Return exit code 12 for "bad password" errors -Restic now returns exit code 12 when it can't open the repository -because of a bad password. +Restic now returns exit code 12 when it cannot open the repository due to an +incorrect password. https://github.com/restic/restic/pull/4959 diff --git a/changelog/unreleased/pull-4977 b/changelog/unreleased/pull-4977 index 702df29a7..85e4091c5 100644 --- a/changelog/unreleased/pull-4977 +++ b/changelog/unreleased/pull-4977 @@ -1,14 +1,15 @@ -Change: let `backup` store files with incomplete metadata +Change: `backup` includes files with incomplete metadata -If restic failed to read the extended metadata for a file or folder while -creating a backup, then the file or folder was not included in the resulting -snapshot. Instead, only a warning message was printed along with exiting -with exit code 3. +If restic failed to read extended metadata for a file or folder during a +backup, then the file or folder was not included in the resulting snapshot. +Instead, a warning message was printed along with returning exit code 3 once +the backup was finished. + +Now, restic also includes items for which the extended metadata could not be +read in a snapshot. The warning message has been updated to: -Now, restic also includes items for which the extended metadata could not -be read in a snapshot. The warning message has been changed to read ``` -incomplete metadata for /path/to/file: details on error +incomplete metadata for /path/to/file:
``` https://github.com/restic/restic/issues/4953 diff --git a/changelog/unreleased/pull-4980 b/changelog/unreleased/pull-4980 index 5713db7a2..4b1de54bf 100644 --- a/changelog/unreleased/pull-4980 +++ b/changelog/unreleased/pull-4980 @@ -1,11 +1,10 @@ -Bugfix: Skip EA processing in Windows for volumes that do not support EA +Bugfix: Skip extended attribute processing on unsupported Windows volumes -Restic was failing to backup files on some windows paths like network -drives because of errors while fetching extended attributes. -Either they return error codes like windows.E_NOT_SET or -windows.ERROR_INVALID_FUNCTION or it results in slower backups. -Restic now completely skips the attempt to fetch extended attributes -for such volumes where it is not supported. +For restic 0.17.0, backups of certain Windows paths, such as network drives, +failed due to errors while fetching extended attributes. + +Restic now skips extended attribute processing for volumes where they are not +supported. https://github.com/restic/restic/pull/4980 https://github.com/restic/restic/pull/4998 diff --git a/changelog/unreleased/pull-5018 b/changelog/unreleased/pull-5018 index 1b7b9f428..84f36355c 100644 --- a/changelog/unreleased/pull-5018 +++ b/changelog/unreleased/pull-5018 @@ -1,13 +1,13 @@ -Bugfix: Improve HTTP2 support for rest backend +Bugfix: Improve HTTP/2 support for REST backend -If rest-server tried to gracefully shut down an HTTP2 connection still used by the client, -this could result in the following error. +If `rest-server` tried to gracefully shut down an HTTP/2 connection still in +use by the client, it could result in the following error: ``` http2: Transport: cannot retry err [http2: Transport received Server's graceful shutdown GOAWAY] after Request.Body was written; define Request.GetBody to avoid this error ``` -This has been fixed. +This issue has been resolved. https://github.com/restic/restic/pull/5018 https://forum.restic.net/t/receiving-http2-goaway-messages-with-windows-restic-v0-17-0/8367