aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorroot <root@localhost>2013-02-14 00:00:00 +0000
committerroot <root@localhost>2013-02-14 00:00:00 +0000
commite2de0ce73fcb4d79092995c91bf9d80635217445 (patch)
tree230117195ca7eb846c24305636cac456f77f0116 /README.rst
parent853dae8914f7d74e6cb4bcc155ae565aa1c4d6ba (diff)
downloadgit-remote-gcrypt-e2de0ce73fcb4d79092995c91bf9d80635217445.zip
git-remote-gcrypt-e2de0ce73fcb4d79092995c91bf9d80635217445.tar.gz
git-remote-gcrypt-e2de0ce73fcb4d79092995c91bf9d80635217445.tar.bz2
Simply detect if using git repository backend. gitception:// is unneeded
Simply treat absolute paths that do not lead to a HEAD file as local directory backends, and all other as git backends.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 7e48b97..8b84d0e 100644
--- a/README.rst
+++ b/README.rst
@@ -16,9 +16,10 @@ Remote helper programs are invoked by git to handle network transport.
This helper handles gcrypt:: URLs that will access a remote repository
encrypted with GPG, using our custom format.
-Supported locations are `local`, `ssh://`, `sftp://` and
-`gitception://`. `gcrypt::gitception://<giturl>` allows stacking gcrypt
-on top of any other git transport.
+Supported locations are `local`, `ssh://` and `sftp://`, where the
+repository is stored as a set of files. If the location instead is any
+`<giturl>`, gcrypt will store the same representation in a git
+repository, and so it can be bridged over any git transport.
.. NOTE:: Repository format MAY STILL change, incompatibly
@@ -91,6 +92,13 @@ Examples
git remote add cryptremote gcrypt::ssh://example.com:repo
git push cryptremote HEAD
+How to use a git backend::
+
+ # notice that the target repo must already exist and its
+ # `master` branch will be overwritten!
+ git remote add gitcrypt gcrypt::git@example.com:repo
+ git push gitcrypt HEAD
+
Notes
=====