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

back to annex:: for git-remote-annex url

Browse source 
Oh, turns out git needs two colons to use a gitremote-helper. Ok.
This commit is contained in:
Joey Hess 2024-05-07 14:37:29 -04:00
parent e1447dc2e2
commit 947cf1c345
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 11 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CmdLine/GitRemoteAnnex.hs
View file

@ -135,18 +135,18 @@ data SpecialRemoteConfig = SpecialRemoteConfig
deriving (Show) deriving (Show)
-- The url for a special remote looks like -- The url for a special remote looks like
-- annex:uuid?param=value&param=value... -- annex::uuid?param=value&param=value...
parseSpecialRemoteUrl :: String -> Either String SpecialRemoteConfig parseSpecialRemoteUrl :: String -> Either String SpecialRemoteConfig
parseSpecialRemoteUrl s = case parseURI s of parseSpecialRemoteUrl s = case parseURI s of
Nothing -> Left "URL parse failed" Nothing -> Left "URL parse failed"
Just u -> case uriScheme u of Just u -> case uriScheme u of
"annex:" -> case uriPath u of "annex:" -> case uriPath u of
"" -> Left "annex: URL did not include a UUID" "" -> Left "annex: URL did not include a UUID"
(':':_) -> Left "annex: URL malformed" (':':p) -> Right $ SpecialRemoteConfig
p -> Right $ SpecialRemoteConfig
{ specialRemoteUUID = toUUID p { specialRemoteUUID = toUUID p
, specialRemoteParams = parsequery u , specialRemoteParams = parsequery u
} }
_ -> Left "annex: URL malformed"
_ -> Left "Not an annex: URL" _ -> Left "Not an annex: URL"
where where
parsequery u = map parsekv $ splitc '&' (drop 1 (uriQuery u)) parsequery u = map parsekv $ splitc '&' (drop 1 (uriQuery u))

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

@ -4,7 +4,7 @@ git-remote-annex - remote helper program to store a git repository in a git-anne
# SYNOPSIS # SYNOPSIS
git fetch annex:uuid?param=value&param=value... git fetch annex::uuid?param=value&param=value...
# DESCRIPTION # DESCRIPTION
@ -17,13 +17,13 @@ encryption=shared or encryption=hybrid. (Since those types of encryption
rely on a 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.) 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 The format of the remote URL is "annex::" followed by the UUID of the
special remote, and then followed by all of the configuration parameters of special remote, and then followed by all of the configuration parameters of
the special remote. the special remote.
For example, to clone from a directory special remote: For example, to clone from a directory special remote:
git clone annex:358ff77e-0bc3-11ef-bc49-872e6695c0e3?type=directory&encryption=none&directory=/mnt/foo/ git clone annex::358ff77e-0bc3-11ef-bc49-872e6695c0e3?type=directory&encryption=none&directory=/mnt/foo/
When a special remote needs some additional credentials to be provided, When a special remote needs some additional credentials to be provided,
they are not included in the URL, and need to be provided when cloning from they are not included in the URL, and need to be provided when cloning from
@ -31,16 +31,12 @@ the special remote. That is typically done by setting environment
variables. Some special remotes may also need environment variables to be variables. Some special remotes may also need environment variables to be
set when pulling or pushing. set when pulling or pushing.
As a useful shorthand, when the special remote has already been enabled, When configuring the url of an existing special remote, a
the configuration parameters can be omitted. For example: shorter url of "annex::" is sufficient. For example:
git push annex:358ff77e-0bc3-11ef-bc49-872e6695c0e3 master git-annex initremote foo type=directory encryption=none directory=/mnt/foo
git config remote.foo.url annex::
This also makes it easy to configure the url for an existing special remote, git push foo master
making it usable by git:
git config remote.foo.url annex:358ff77e-0bc3-11ef-bc49-872e6695c0e3
git fetch foo master
Configuring the url like that is automatically done when cloning from a Configuring the url like that is automatically done when cloning from a
special remote, but not by [[git-annex-initremote]](1) and special remote, but not by [[git-annex-initremote]](1) and