From cb7f15e73340062e74267d7f950dc46dedcd6b54 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Tue, 28 May 2024 15:29:38 -0400 Subject: [PATCH] clean up man page --- doc/git-remote-annex.mdwn | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/doc/git-remote-annex.mdwn b/doc/git-remote-annex.mdwn index 9c218d96f3..f3d9fbc142 100644 --- a/doc/git-remote-annex.mdwn +++ b/doc/git-remote-annex.mdwn @@ -36,35 +36,34 @@ When using the shorthand "annex::" url, the full url will be displayed each time you git pull or push, when it's possible for git-annex to determine it. -When a special remote needs some credentials to be used, they are not -included in the URL, and will need to be provided when cloning from the -special remote. That is typically done by setting environment variables. -Some special remotes may also need environment variables to be set when -pulling or pushing. +# CONFLICTING PUSHES Like any git repository, a git repository stored on a special remote can have conflicting things pushed to it from different places. This mostly works the same as any other git repository, eg a push that overwrites other -work will be prevented unless forced. However, it is possible, when -conflicting pushes are being done at the same time, for one of the pushes -to be overwritten by the other one. In this situation, the overwritten -push will appear to have succeeded, but pulling later will show the true -situation. +work will be prevented unless forced. + +However, it is possible, when conflicting pushes are being done at the same +time, for one of the pushes to be overwritten by the other one. In this +situation, the overwritten push will appear to have succeeded, but pulling +later will show the true situation. + +# REPOSITORY FORMAT The git repository is stored in the special remote using special annex objects with names starting with "GITMANIFEST" and "GITBUNDLE". For details, 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. That is done when force pushing a ref, or deleting a -ref from the remote. It's also done when too many git bundles -accumulate in the special remote, as configured by the +sometimes the whole git repository is re-uploaded. That is done when force +pushing a ref, or 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..annex-max-git-bundles` git config. Note that a re-upload of the repository does not delete old GITBUNDLE objects from it. This means that refs pushed to the special remote can still be accessed even after deleting or overwriting them. + A push that deletes every ref from the special remote will delete all the accumulated GITBUNDLE objects. But of course, making such a push means that someone who clones from the special remote at that point in time