From 85c15e6fa3d1a2a9eb44f47b334b00cb32e0367b Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Mon, 23 Oct 2023 19:01:45 +0200 Subject: [PATCH 1/3] polish changelogs --- changelog/unreleased/issue-4128 | 4 ++-- changelog/unreleased/issue-4513 | 6 +++--- changelog/unreleased/pull-299 | 3 ++- changelog/unreleased/pull-4480 | 6 +++--- changelog/unreleased/pull-4511 | 2 +- changelog/unreleased/pull-4519 | 14 +++++--------- 6 files changed, 16 insertions(+), 19 deletions(-) diff --git a/changelog/unreleased/issue-4128 b/changelog/unreleased/issue-4128 index 4612b2366..ac894656c 100644 --- a/changelog/unreleased/issue-4128 +++ b/changelog/unreleased/issue-4128 @@ -1,7 +1,7 @@ -Enhancement: Automatically adjust GOMAXPROCS in resource-constrained containers +Enhancement: Automatically set `GOMAXPROCS` in resource-constrained containers When running restic in a Linux container with CPU-usage limits, restic now -automatically adjusts GOMAXPROCS. This helps to reduce the memory consumption +automatically adjusts `GOMAXPROCS`. This helps to reduce the memory consumption on hosts with many CPU cores. https://github.com/restic/restic/issues/4128 diff --git a/changelog/unreleased/issue-4513 b/changelog/unreleased/issue-4513 index aa79f2848..7a26f34a4 100644 --- a/changelog/unreleased/issue-4513 +++ b/changelog/unreleased/issue-4513 @@ -1,8 +1,8 @@ Bugfix: Make `key list` command honor `--no-lock` -This allows to determine which keys a repo can be accessed by without the -need for having write access (e.g., read-only sftp access, filesystem -snapshot). +The `key list` command now supports the `--no-lock` options. This allows +determining which keys a repo can be accessed by without the need for having +write access (e.g., read-only sftp access, filesystem snapshot). https://github.com/restic/restic/issues/4513 https://github.com/restic/restic/pull/4514 diff --git a/changelog/unreleased/pull-299 b/changelog/unreleased/pull-299 index aae5c0e05..6774f3b9e 100644 --- a/changelog/unreleased/pull-299 +++ b/changelog/unreleased/pull-299 @@ -1,6 +1,7 @@ Enhancement: Show progress bar while loading the index -Restic did not provide any feedback while loading index files. Now there is a progress bar for the index loading process. +Restic did not provide any feedback while loading index files. Now, there is a +progress bar that shows the index loading progress. https://github.com/restic/restic/issues/229 https://github.com/restic/restic/pull/4419 diff --git a/changelog/unreleased/pull-4480 b/changelog/unreleased/pull-4480 index bafbf62e8..ec5e68761 100644 --- a/changelog/unreleased/pull-4480 +++ b/changelog/unreleased/pull-4480 @@ -2,9 +2,9 @@ Enhancement: Allow setting REST password and username via environment variables Previously, it was only possible to specify the REST server username and password in the repository URL, or using the `--repository-file` option. This -meant it was not possible to use authentication in contexts where the repository -URL is public and parts of it are templated by other software. Restic now -allows setting the username and password using the `RESTIC_REST_USERNAME` and +meant it was not possible to use authentication in contexts where the +repository URL is stored in publicly accessible way. Restic now allows setting +the username and password using the `RESTIC_REST_USERNAME` and `RESTIC_REST_PASSWORD` variables. https://github.com/restic/restic/pull/4480 diff --git a/changelog/unreleased/pull-4511 b/changelog/unreleased/pull-4511 index 60c5659b6..5bf81bebb 100644 --- a/changelog/unreleased/pull-4511 +++ b/changelog/unreleased/pull-4511 @@ -1,4 +1,4 @@ -Enhancement: Include inode numbers in JSON output for find and ls +Enhancement: Include inode numbers in JSON output for `find` and `ls` commands Restic used to omit the inode numbers in the JSON messages emitted for nodes by the `ls` command as well as for matches by the `find` command. It now includes diff --git a/changelog/unreleased/pull-4519 b/changelog/unreleased/pull-4519 index c5982df1b..abc6445c2 100644 --- a/changelog/unreleased/pull-4519 +++ b/changelog/unreleased/pull-4519 @@ -1,16 +1,12 @@ Enhancement: Add config option to set SFTP command arguments -The `sftp.args` option can be passed to restic (using `-o`) to specify -custom arguments to be used by the SSH command executed by the SFTP -backend. - -Before this change, a common scenario where a custom identity file was -needed for the SSH connection, required the full command to be -specified: +When using the `sftp` backend, scenarios where a custom identity file was +needed for the SSH connection, required the full command to be specified: `-o sftp.command='ssh user@host:port -i /ssh/my_private_key -s sftp'` -With this new configuration option: -`-o sftp.args='-i /ssh/my_private_key'` +Now, the `-o sftp.args=...` option can be passed to restic to specify +custom arguments for the SSH command executed by the SFTP backend. +This simplifies the above example to `-o sftp.args='-i /ssh/my_private_key'`. https://github.com/restic/restic/pull/4519 https://github.com/restic/restic/issues/4241 From 85abceb99c497e4cd295d4163df8e60d0ce6422f Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Mon, 23 Oct 2023 19:02:20 +0200 Subject: [PATCH 2/3] doc: update minimum required Go version --- doc/020_installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/020_installation.rst b/doc/020_installation.rst index a39ae91e9..0fedc6425 100644 --- a/doc/020_installation.rst +++ b/doc/020_installation.rst @@ -279,7 +279,7 @@ From Source *********** restic is written in the Go programming language and you need at least -Go version 1.18. Building for Solaris requires at least Go version 1.20. +Go version 1.19. Building for Solaris requires at least Go version 1.20. Building restic may also work with older versions of Go, but that's not supported. See the `Getting started `__ guide of the Go project for From 6d19e0260dd2c59e92b2ad611954c03dfc674f7a Mon Sep 17 00:00:00 2001 From: "Leo R. Lundgren" Date: Mon, 23 Oct 2023 20:45:15 +0200 Subject: [PATCH 3/3] doc: Polish changelogs --- changelog/unreleased/issue-4523 | 25 +++++++++++++++---------- changelog/unreleased/pull-4480 | 13 +++++++------ 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/changelog/unreleased/issue-4523 b/changelog/unreleased/issue-4523 index 3dd4a536f..e246cfe28 100644 --- a/changelog/unreleased/issue-4523 +++ b/changelog/unreleased/issue-4523 @@ -1,17 +1,22 @@ Bugfix: Update zstd library to fix possible data corruption at max. compression -In restic 0.16.0, backups using maximum compression could result in data -corruption due to a bug in the library used for compressing data. Please note -that the "auto" compression level (used by default) is not affected! - -To check a repository for data corruption, run `restic check --read-data`. This -will download and verify the whole repository. If the `check` command detects -data corruption, follow the suggested steps. To simplify the repository repair -and minimize data loss, we've also added an experimental `repair packs` command -that salvages all valid data from the affected pack files. +In restic 0.16.0, backups where the compression level was set to `max` (using +`--compression max`) could in rare and very specific circumstances result in +data corruption due to a bug in the library used for compressing data. Restic now uses the latest version of the library used to compress data, which -includes a fix for the data corruption issue. +includes a fix for this issue. Please note that the `auto` compression level +(which restic uses by default) was never affected, and even if you used `max` +compression, chances of being affected by this issue were very small. + +To check a repository for any corruption, run `restic check --read-data`. This +will download and verify the whole repository and can be used at any time to +completely verify the integrity of a repository. If the `check` command detects +anomalies, follow the suggested steps. + +To simplify any needed repository repair and minimize data loss, there is also +a new and experimental `repair packs` command that salvages all valid data from +the affected pack files (see `restic help repair packs` for more information). https://github.com/restic/restic/issues/4523 https://github.com/restic/restic/pull/4530 diff --git a/changelog/unreleased/pull-4480 b/changelog/unreleased/pull-4480 index ec5e68761..2075fe21d 100644 --- a/changelog/unreleased/pull-4480 +++ b/changelog/unreleased/pull-4480 @@ -1,10 +1,11 @@ Enhancement: Allow setting REST password and username via environment variables -Previously, it was only possible to specify the REST server username and -password in the repository URL, or using the `--repository-file` option. This -meant it was not possible to use authentication in contexts where the -repository URL is stored in publicly accessible way. Restic now allows setting -the username and password using the `RESTIC_REST_USERNAME` and -`RESTIC_REST_PASSWORD` variables. +Previously, it was only possible to specify the REST-server username and +password in the repository URL, or by using the `--repository-file` option. +This meant it was not possible to use authentication in contexts where the +repository URL is stored in publicly accessible way. + +Restic now allows setting the username and password using the +`RESTIC_REST_USERNAME` and `RESTIC_REST_PASSWORD` variables. https://github.com/restic/restic/pull/4480