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

update docs for git-remote-annex

Browse source
This commit is contained in:
Joey Hess 2024-05-14 15:31:16 -04:00
parent 23c4125ed4
commit 0722c504c5
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/special_remotes.mdwn
View file

@ -5,8 +5,7 @@ directory.
But, git-annex also extends git's concept of remotes, with these special
types of remotes. These can be used by git-annex to store and retrieve
the content of files. They cannot be used by other git commands, and
the git history is not stored in them.
the content of files.
* [[adb]] (for Android devices)
* [[Amazon_Glacier|glacier]]
@ -94,15 +93,25 @@ To initialize a new special remote, use
the special remote you want to use for details about configuration and
examples of how to initremote it.
Once a special remote has been initialize, other clones of the repository can
Once a special remote has been initialized, other clones of the repository can
also enable it, by using [[git-annex enableremote|git-annex-enableremote]]
with the same name that was used to initialize it. (Run the command without
any name to get a list of available special remotes.)
Initializing or enabling a special remote adds it as a remote of your git
repository. You can't use git commands like `git pull` with the remote
(usually, there are exceptions like [[git-lfs]]), but you can use git-annex
commands.
repository.
## Storing a git repository in a special remote
Most special remotes do not include a clone of the git repository
by default, so you can't use commands like `git push` and `git pull`
with them. (There are some exceptions like [[git-lfs]].)
But it is possible to store a git repository in many special remotes,
using the [[git-remote-annex]] command. This involves configuring
the remote with an "annex::" url. It's even possible to `git clone`
from a special remote using such an url. See the documentation of
[[git-remote-annex]] for details.
## Unused content on special remotes

3
doc/todo/git-remote-annex.mdwn
View file

@ -18,9 +18,6 @@ This is implememented and working. Remaining todo list for it:
(with or without exporttree=yes). This is because the ContentIdentifier
db is not populated.
* Need to mention git-remote-annex in special remotes page, and perhaps
write a tip for it.
* It would be nice if git-annex could generate an annex:: url
for a special remote and show it to the user, eg when
they have set the shorthand "annex::" url, so they know the full url.