From e998314088a1659330c9a3cde6745bb78b5b6480 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Thu, 27 Jul 2023 21:52:04 +0200 Subject: [PATCH] tweak changelog entries --- changelog/unreleased/issue-1759 | 4 ++-- changelog/unreleased/issue-2359 | 2 +- changelog/unreleased/issue-2468 | 4 ++-- changelog/unreleased/issue-2565 | 9 +++++---- changelog/unreleased/issue-3311 | 6 +++--- changelog/unreleased/issue-3698 | 4 ++-- changelog/unreleased/issue-3871 | 6 +++--- changelog/unreleased/issue-3941 | 10 ++++++---- changelog/unreleased/{pull-4166 => issue-4130} | 1 + changelog/unreleased/issue-4159 | 4 ++-- changelog/unreleased/issue-4188 | 2 +- changelog/unreleased/issue-4199 | 8 ++++++++ changelog/unreleased/issue-426 | 2 +- changelog/unreleased/issue-719 | 6 +++--- changelog/unreleased/pull-4220 | 5 +++-- changelog/unreleased/pull-4226 | 6 +++--- changelog/unreleased/pull-4304 | 5 ----- 17 files changed, 46 insertions(+), 38 deletions(-) rename changelog/unreleased/{pull-4166 => issue-4130} (88%) create mode 100644 changelog/unreleased/issue-4199 delete mode 100644 changelog/unreleased/pull-4304 diff --git a/changelog/unreleased/issue-1759 b/changelog/unreleased/issue-1759 index 1b698f845..ab5208e3d 100644 --- a/changelog/unreleased/issue-1759 +++ b/changelog/unreleased/issue-1759 @@ -8,8 +8,8 @@ the snapshot, even if only some unimportant file was damaged. We've added a `repair snapshots` command, which can repair snapshots by removing damaged directories and missing files contents. Note that using this command -can lead to data loss! Please see the "Troubleshooting" section in the documentation -for more details. +can lead to (limited) data loss! Please see the "Troubleshooting" section in the +documentation for more details. https://github.com/restic/restic/issues/1759 https://github.com/restic/restic/issues/1714 diff --git a/changelog/unreleased/issue-2359 b/changelog/unreleased/issue-2359 index 0399a96f1..43fa304f1 100644 --- a/changelog/unreleased/issue-2359 +++ b/changelog/unreleased/issue-2359 @@ -3,7 +3,7 @@ Enhancement: Provide multi-platform Docker containers The official Docker containers are now built for the architectures linux/386, linux/amd64, linux/arm and linux/arm64. -As an alternative to the Docker Hub, the Docker containers are now also +As an alternative to the Docker Hub, the Docker containers are also available on ghcr.io, the GitHub Container Registry. https://github.com/restic/restic/issues/2359 diff --git a/changelog/unreleased/issue-2468 b/changelog/unreleased/issue-2468 index 56555a136..60dd3e650 100644 --- a/changelog/unreleased/issue-2468 +++ b/changelog/unreleased/issue-2468 @@ -2,9 +2,9 @@ Enhancement: Add support for non-global Azure clouds Restic backups on Azure only supported storages using the global domain `core.windows.net`. This meant that backups to other domains such as Azure -China (`core.chinacloudapi.cn') or Azure Germany (`core.cloudapi.de`) were +China (`core.chinacloudapi.cn`) or Azure Germany (`core.cloudapi.de`) were not supported. Restic now allows overriding the global domain using the -environment variable `AZURE_ENDPOINT_SUFFIX'. +environment variable `AZURE_ENDPOINT_SUFFIX`. https://github.com/restic/restic/issues/2468 https://github.com/restic/restic/pull/4387 diff --git a/changelog/unreleased/issue-2565 b/changelog/unreleased/issue-2565 index 62c8c3ca1..d7d5a25eb 100644 --- a/changelog/unreleased/issue-2565 +++ b/changelog/unreleased/issue-2565 @@ -1,9 +1,10 @@ Bugfix: Support "unlimited" in `forget --keep-*` options -Restic would forget snapshots that should have been kept when a negative value -was passed to the `--keep-*` options. Negative values are now forbidden. To -keep all snapshots, the special value `unlimited` is now supported. For -example, `--keep-monthly unlimited` will keep all monthly snapshots. +Restic would previously forget snapshots that should have been kept when a +negative value was passed to the `--keep-*` options. Negative values are now +forbidden. To keep all snapshots, the special value `unlimited` is now +supported. For example, `--keep-monthly unlimited` will keep all monthly +snapshots. https://github.com/restic/restic/issues/2565 https://github.com/restic/restic/pull/4234 diff --git a/changelog/unreleased/issue-3311 b/changelog/unreleased/issue-3311 index 4dfe502f7..0af9ba359 100644 --- a/changelog/unreleased/issue-3311 +++ b/changelog/unreleased/issue-3311 @@ -1,12 +1,12 @@ Bugfix: Support non-UTF8 paths as symlink target -Restic versions before 0.16.0 did not correctly backup and restore symlinks +Restic versions before 0.16.0 did not correctly `backup` and `restore` symlinks that contain a non-UTF8 target. Note that this only affects system that still use a non-Unicode encoding for filesystem paths. We have extended the repository format to add support for such symlinks. Please -note that at least restic version 0.16.0 must be used for both backup and -restore to correctly handle non-UTF8 symlink targets. +note that at least restic version 0.16.0 must be used for both `backup` and +`restore` to correctly handle non-UTF8 symlink targets. https://github.com/restic/restic/issues/3311 https://github.com/restic/restic/pull/3802 diff --git a/changelog/unreleased/issue-3698 b/changelog/unreleased/issue-3698 index 0851d3756..d7bb957e5 100644 --- a/changelog/unreleased/issue-3698 +++ b/changelog/unreleased/issue-3698 @@ -1,7 +1,7 @@ -Enhancement: Add support for Managed / Worload Identity to azure backend +Enhancement: Add support for Managed / Workload Identity to azure backend Restic now additionally supports authenticating to Azure using Workload -Identity or Managed Identity credentials which are automatically injected in +Identity or Managed Identity credentials, which are automatically injected in several environments such as a managed Kubernetes cluster. https://github.com/restic/restic/issues/3698 diff --git a/changelog/unreleased/issue-3871 b/changelog/unreleased/issue-3871 index 786e902d4..fae63862f 100644 --- a/changelog/unreleased/issue-3871 +++ b/changelog/unreleased/issue-3871 @@ -2,11 +2,11 @@ Enhancement: Support `:` syntax to select subfolders Commands like `diff` or `restore` always worked with the full snapshot. This did not allow comparing only a specific subfolder or only restoring that folder -(`restore --include subfolder` limits the restored files, but still creates the +(`restore --include subfolder` filters the restored files, but still creates the directories included in `subfolder`). -The commands `diff`, `dump`, `ls`, `restore` now support the -`:` syntax, where `snapshot` is the ID of a snapshot (or +The commands `diff`, `dump`, `ls` and `restore` now support the +`:` syntax, where `snapshot` is the ID of a snapshot (or the string `latest`) and `subfolder` is a path within the snapshot. The commands will then only work with the specified path of the snapshot. The `subfolder` must be a path to a folder as returned by `ls`. diff --git a/changelog/unreleased/issue-3941 b/changelog/unreleased/issue-3941 index 011cd9eaa..ebb729837 100644 --- a/changelog/unreleased/issue-3941 +++ b/changelog/unreleased/issue-3941 @@ -1,14 +1,16 @@ Enhancement: Support `--group-by` for backup parent selection -The backup command by default selected the parent snapshot based on the hostname -and the backup targets. When the backup path list changed, the backup command +The `backup` command by default selected the parent snapshot based on the hostname +and the backup targets. When the backup path list changed, the `backup` command was unable to determine a suitable parent snapshot and had to read all files again. -The new `--group-by` option for the backup command allows filtering snapshots +The new `--group-by` option for the `backup` command allows filtering snapshots for the parent selection by `host`, `paths` and `tags`. It defaults to `host,paths` which selects the latest snapshot with hostname and paths matching -those of the backup run. It should be used consistently with `forget --group-by`. +those of the backup run. This matches the behavior of prior restic versions. +The `--group-by` option should be set to the same value as passed to +`forget --group-by`. https://github.com/restic/restic/issues/3941 https://github.com/restic/restic/pull/4081 diff --git a/changelog/unreleased/pull-4166 b/changelog/unreleased/issue-4130 similarity index 88% rename from changelog/unreleased/pull-4166 rename to changelog/unreleased/issue-4130 index 6714fdf7f..4d5941e77 100644 --- a/changelog/unreleased/pull-4166 +++ b/changelog/unreleased/issue-4130 @@ -4,4 +4,5 @@ If the cache directory was removed or ran out of space while restic was running, this caused further caching attempts to fail and drastically slow down the command execution. Now, the currently running command is canceled instead. +https://github.com/restic/restic/issues/4130 https://github.com/restic/restic/pull/4166 diff --git a/changelog/unreleased/issue-4159 b/changelog/unreleased/issue-4159 index 4f91ce240..f04ce1251 100644 --- a/changelog/unreleased/issue-4159 +++ b/changelog/unreleased/issue-4159 @@ -1,6 +1,6 @@ -Enhancement: Add `--human-readable` flag to `ls` and `find` commands +Enhancement: Add `--human-readable` option to `ls` and `find` commands -Previously, when using the -l option with the ls and find commands, +Previously, when using the `-l` option with the `ls` and `find` commands, the displayed size was always in bytes, without an option for a more human readable format such as MiB or GiB. diff --git a/changelog/unreleased/issue-4188 b/changelog/unreleased/issue-4188 index dbb26f733..6c7c1b0bb 100644 --- a/changelog/unreleased/issue-4188 +++ b/changelog/unreleased/issue-4188 @@ -1,6 +1,6 @@ Enhancement: `backup` includes restic version in snapshot metadata -The restic version used backup the snapshot is now included in its metadata. +The restic version used to backup a snapshot is now included in its metadata. The program version is shown when inspecting a snapshot using `restic cat snapshot ` or `restic snapshots --json`. diff --git a/changelog/unreleased/issue-4199 b/changelog/unreleased/issue-4199 new file mode 100644 index 000000000..25f18e8ca --- /dev/null +++ b/changelog/unreleased/issue-4199 @@ -0,0 +1,8 @@ +Bugfix: Avoid lock refresh issues with slow network connections + +On network connections with a low upload speed, restic could often fail +backups and other operations with `Fatal: failed to refresh lock in time`. +We've reworked the lock refresh to avoid this error. + +https://github.com/restic/restic/issues/4199 +https://github.com/restic/restic/pull/4304 diff --git a/changelog/unreleased/issue-426 b/changelog/unreleased/issue-426 index 9caf14ef5..f50cddbf7 100644 --- a/changelog/unreleased/issue-426 +++ b/changelog/unreleased/issue-426 @@ -2,7 +2,7 @@ Enhancement: Show progress bar during restore The `restore` command now shows a progress report while restoring files. -Example: [0:42] 5.76% 23 files 12.98 MiB, total 3456 files 23.54 GiB +Example: `[0:42] 5.76% 23 files 12.98 MiB, total 3456 files 23.54 GiB` JSON output is now also supported. diff --git a/changelog/unreleased/issue-719 b/changelog/unreleased/issue-719 index 4f28ea83c..897a6bf1f 100644 --- a/changelog/unreleased/issue-719 +++ b/changelog/unreleased/issue-719 @@ -1,7 +1,7 @@ -Enhancement: Add --retry-lock option +Enhancement: Add `--retry-lock` option -This option allows to specify a duration for which restic will wait if there -already exists a conflicting lock within the repository. +This option allows specifying a duration for which restic will wait if the +repository is already locked. https://github.com/restic/restic/issues/719 https://github.com/restic/restic/pull/2214 diff --git a/changelog/unreleased/pull-4220 b/changelog/unreleased/pull-4220 index 787b6ba2d..4fe86cdb9 100644 --- a/changelog/unreleased/pull-4220 +++ b/changelog/unreleased/pull-4220 @@ -1,5 +1,6 @@ -Enhancement: Add jq to container image +Enhancement: Add `jq` binary to container image -The Docker container image now contains jq which can be useful when restic outputs json data. +The Docker container image now contains `jq`, which can be useful to process +JSON data output by restic. https://github.com/restic/restic/pull/4220 diff --git a/changelog/unreleased/pull-4226 b/changelog/unreleased/pull-4226 index 69c848735..8c0e03e73 100644 --- a/changelog/unreleased/pull-4226 +++ b/changelog/unreleased/pull-4226 @@ -1,7 +1,7 @@ -Enhancement: Allow specifying the region of new buckets in the gcs backend +Enhancement: Allow specifying the region of new buckets in the gs backend Buckets used by the Google Cloud Storage backend would always get created in -the "us" region. It is now possible to specify the region, where a bucket -should get created. +the "us" region. It is now possible to specify the region where a bucket +should be created by using the `-o gs.region=us` option. https://github.com/restic/restic/pull/4226 diff --git a/changelog/unreleased/pull-4304 b/changelog/unreleased/pull-4304 deleted file mode 100644 index ca3c7a8db..000000000 --- a/changelog/unreleased/pull-4304 +++ /dev/null @@ -1,5 +0,0 @@ -Bugfix: Avoid lock refresh issues with slow network connections - -On network connections with a low upload speed, restic could often fail backups and other operations with `Fatal: failed to refresh lock in time`. We've reworked the lock refresh to avoid this error. - -https://github.com/restic/restic/pull/4304