aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.rst
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2016-01-07 11:15:14 -0700
committerSean Whitton <spwhitton@spwhitton.name>2016-01-07 11:15:14 -0700
commit255be2c683dc86d622f26e4c4993fd3068e7a905 (patch)
tree953138343205a6c8b47c2a0e92c7a939f2f742f9 /README.rst
parent8aa13af08947af47bda7839aa4d1bcbba6a08537 (diff)
parent5dcc77f507d497fe4023e94a47b6a7a1f1146bce (diff)
downloadgit-remote-gcrypt-255be2c683dc86d622f26e4c4993fd3068e7a905.tar.gz
Merge remote-tracking branch 'joeyh/master' into devel
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst32
1 files changed, 29 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index f177913..ba06259 100644
--- a/README.rst
+++ b/README.rst
@@ -60,10 +60,25 @@ The following ``git-config(1)`` variables are supported:
The ``gcrypt-participants`` setting on the remote takes precedence
over the repository variable ``gcrypt.participants``.
+``remote.<name>.gcrypt-publish-participants``
+ ..
+``gcrypt.publish-participants``
+ By default, the gpg key ids of the participants are obscured by
+ encrypting using `gpg -R`. Setting this option to `true` disables
+ that security measure.
+
+ The problem with using `gpg -R` is that to decrypt, gpg tries each
+ available secret key in turn until it finds a usable key.
+ This can result in unncessary passphrase prompts.
+
+``remote.<name>.gcrypt-signingkey``
+ ..
``user.signingkey``
- (From regular git configuration) The key to use for signing. You
- should set ``user.signingkey`` if your default signing key is not
- part of the participant list.
+ (The latter from regular git configuration) The key to use for signing.
+ You should set ``user.signingkey`` if your default signing key is not
+ part of the participant list. You may use the per-remote version
+ to sign different remotes using different keys.
+
Environment Variables
=====================
@@ -170,6 +185,17 @@ Each item extends until newline, and matches one of the following:
``extn <name> ...``
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 is not
+encrypted with gcrypt (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
========