From 83d519179f5611641802b5de2b5f3f155798f61a Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 19 Sep 2013 12:03:33 -0400 Subject: --check option to see if a repo exists and can be decrypted This is to allow programs to determine if a repo uses gcrypt, per #6. Since this program already knows the name of the manifest file and how to download it and decrypt it, it makes sense to do the check here rather than in, eg, git-annex. --- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 6fc4636..3922376 100644 --- a/README.rst +++ b/README.rst @@ -173,6 +173,17 @@ Each item extends until newline, and matches one of the following: ``extn ...`` Extension field, preserved but unused. +Detecting gcrypt repos +====================== + +To detect if a git url is a gcrypt repo, use: git-remote-gcrypt --check url +Exit status if 0 if the repo exists and can be decrypted, 1 if the repo +uses gcrypt but could not be decrypted, and 100 if the repo does not +exist or could not be accessed. + +Note that this has to fetch the repo contents into the local git +repository, the same as is done when using a gcrypt repo. + See Also ======== -- cgit v1.2.3