From 5404e49fc73a198bd3ed870b31ae8bebb9a46780 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sun, 21 Aug 2022 09:16:46 -0700 Subject: use stronger language regarding gitception/sftp vs. local/rsync Signed-off-by: Sean Whitton --- README.rst | 21 ++++++++++++++------- debian/changelog | 5 +++++ 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index a86d567..a7c41a2 100644 --- a/README.rst +++ b/README.rst @@ -18,8 +18,8 @@ helper handles URIs prefixed with `gcrypt::`. Supported backends are `local`, `rsync://` and `sftp://`, where the repository is stored as a set of files, or instead any `` where gcrypt will store the same representation in a git repository, -bridged over arbitrary git transport. See "Performance" below for -backends comparison. +bridged over arbitrary git transport. Prefer `local` or `rsync://` if +you can use one of those; see "Performance" below for discussion. There is also an experimental `rclone://` backend for early adoptors only (you have been warned). @@ -156,11 +156,18 @@ Remote ID Performance Using an arbitrary `` or an `sftp://` URI requires - uploading the entire repository history with each push. If your - repository history is large or you are pushing over a slow link, - consider using the `rsync://` transport, which performs - incremental pushes. Note that the latter won't work with a - repository hosting service like Gitolite, GitHub or GitLab. + uploading the entire repository history with each push. This + means that pushes of your repository become slower over time, as + your git history becomes longer, and it can easily get to the + point that continued usage of git-remote-gcrypt is impractical. + + Thus, you should use these backends only when you know that your + repository will not ever grow very large, not just that it's not + large now. This means that these backends are inappropriate for + most repositories, and likely suitable only for unusual cases, + such as small credential stores. Even then, use `rsync://` if you + can. Note, however, that `rsync://` won't work with a repository + hosting service like Gitolite, GitHub or GitLab. rsync URIs The URI format for the rsync backend is ``rsync://user@host/path``, diff --git a/debian/changelog b/debian/changelog index 3fa3897..ed6296a 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,6 +2,11 @@ git-remote-gcrypt (1.5-1) UNRELEASED; urgency=medium * Pass --error-on-no-transfer to 'rclone copyto'. Thanks to Nathan Todd-Stone for the patch. + * README.md: + - explain why the arbitrary and sftp:// backends are + inappropriate for most git repositories + - use stronger language to say that one should use local or rsync:// + instead, and also say it up in "Description". -- Sean Whitton Tue, 15 Jun 2021 13:48:38 -0700 -- cgit v1.2.3