Merge branch 'gc/branch-recurse-submodules-fix'

[thirdparty/git.git] / Documentation / config / user.txt

diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt
index ad78dce9ecbfc6faf633be133f8f88218844bd9a..ec9233b060a82c41dd9a01785a6f1e748ddf0ad9 100644 (file)
--- a/Documentation/config/user.txt
+++ b/Documentation/config/user.txt
@@ -36,10 +36,13 @@ user.signingKey::
        commit, you can override the default selection with this variable.
        This option is passed unchanged to gpg's --local-user parameter,
        so you may specify a key using any method that gpg supports.
-       If gpg.format is set to "ssh" this can contain the literal ssh public
-       key (e.g.: "ssh-rsa XXXXXX identifier") or a file which contains it and
-       corresponds to the private key used for signing. The private key
-       needs to be available via ssh-agent. Alternatively it can be set to
-       a file containing a private key directly. If not set git will call
-       gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the first
-       key available.
+       If gpg.format is set to `ssh` this can contain the path to either
+       your private ssh key or the public key when ssh-agent is used.
+       Alternatively it can contain a public key prefixed with `key::`
+       directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
+       needs to be available via ssh-agent. If not set git will call
+       gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
+       first key available. For backward compatibility, a raw key which
+       begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
+       as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
+       use the `key::` form instead.