From 306ea42447feccf6e2962cc6ac5197483b12dfb8 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 6 May 2024 13:06:22 -0400 Subject: [PATCH] improve git-remote-annex docs renamed the git config to something shorter too --- doc/git-annex.mdwn | 2 +- doc/git-remote-annex.mdwn | 11 ++++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index c32d5854d3..ceb5fbb60b 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -1644,7 +1644,7 @@ Remotes are configured using these settings in `.git/config`. remotes, and is set when using [[git-annex-initremote]](1) with the `--private` option. -* `remote..git-remote-annex-max-bundles` +* `remote..max-bundles`, `annex.max-bundles` When using [[git-remote-annex]] to store a git repository in a special remote, this configures how many separate git bundle objects to store diff --git a/doc/git-remote-annex.mdwn b/doc/git-remote-annex.mdwn index f94799143f..ab0f8a930e 100644 --- a/doc/git-remote-annex.mdwn +++ b/doc/git-remote-annex.mdwn @@ -1,6 +1,6 @@ # NAME -git-remote-annex - remote helper program to store git repository in a git-annex special remote +git-remote-annex - remote helper program to store a git repository in a git-annex special remote # SYNOPSIS @@ -14,7 +14,7 @@ special remote. It can be used with any special remote except those that use encryption=shared or encryption=hybrid. (Since those types of encryption -rely on on cipher that is checked into the git repository, cloning from +rely on a cipher that is checked into the git repository, cloning from such a special remote would present a chicken and egg problem.) The format of the remote URL is "annex::" followed by the UUID of the @@ -36,7 +36,8 @@ the configuration parameters can be omitted. For example: git push annex::358ff77e-0bc3-11ef-bc49-872e6695c0e3 master -This also makes it easy to configure git to use an existing special remote: +This also makes it easy to configure the url for an existing special remote, +making it usable by git: git config remote.foo.url annex::358ff77e-0bc3-11ef-bc49-872e6695c0e3 git fetch foo master @@ -52,9 +53,9 @@ how the git repository is stored, see Pushes to a special remote are usually done incrementally. However, sometimes the whole git repository (but not the annex) needs to be -re-uploaded. This is done when deleting a ref from the remote. It's also +re-uploaded. That is done when deleting a ref from the remote. It's also done when too many git bundles accumulate in the special remote, as -configured by the `remote..git-remote-annex-max-bundles` git config. +configured by the `remote..max-bundles` git config. Like any git repository, a git repository stored on a special remote can have conflicting things pushed to it from different places. This mostly