mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

clean up man page

Browse source
This commit is contained in:
Joey Hess 2024-05-28 15:29:38 -04:00
parent 80d236b789
commit cb7f15e733
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/git-remote-annex.mdwn
View file

@ -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:
<https://git-annex.branchable.com/internals/git-remote-annex/>
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.<name>.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