Skip to content

Commit a6b9dee

Browse files
Merge pull request #1167 from github/dave-j/typo-fix
Small PR to fix documentation
2 parents 67e43e6 + 2e668ce commit a6b9dee

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Customers will need to download a specific version of backup-utils from the [rel
8383
Below is the two phase timeline we will follow to roll out the changes described above:
8484

8585
* **Phase 1 (rolled out on 2023-11-30):** We have closed all open pull requests and issues (after reviewing each one and porting them to our internal repository if merited),
86-
and updated the repository settings so that new issues cannot be opened. Also, we have stop syncing code from our internal repository to this repository.
86+
and updated the repository settings so that new issues cannot be opened. Also, we have stopped syncing code from our internal repository to this repository.
8787
* As of 2023-11-30, you can still get a working copy of backup-utils by cloning the repository.
8888
But the code will not be updated in the repository; you can access updated versions of backup-utils via the [release page](https://github.com/github/backup-utils/releases).
8989
* **Phase 2 (rolling out 2024-02-20):** The backup-utils code will be removed and the repository will be used to host documentation for backup-utils.

docs/requirements.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ CPU and memory requirements are dependent on the size of the GitHub Enterprise S
2222
The [fix in rsync `3.2.5`](https://github.com/WayneD/rsync/blob/master/NEWS.md#news-for-rsync-325-14-aug-2022) for [CVE-2022-29154](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-29154) can cause severe performance degradation to `backup-utils`.
2323

2424
If you encounter this degradation you can mitigate it by using the `--trust-sender` flag, which is available in rsync >= v3.2.5.
25+
**Note**: If you are using backup-utils 3.9 or greater, `--trust-sender` is automatically used if your rsync version supports it and no further changes are needed.
2526

2627
If your backup host is running rsync < v3.2.5 you may or may not need to make changes to your rsync package, depending on whether your rsync package has backported the fix for CVE-2022-29154 without also backporting the `--trust-sender` flag.
2728

0 commit comments

Comments
 (0)