From: M Hickford <mirth.hickford@xxxxxxxxx>
Signed-off-by: M Hickford <mirth.hickford@xxxxxxxxx>
---
Documentation: clarify that cache forgets credentials if the system
restarts
Make it obvious to readers unfamiliar with Unix sockets.
Signed-off-by: M Hickford mirth.hickford@xxxxxxxxx
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1447%2Fhickford%2Fpatch-2-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1447/hickford/patch-2-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1447
Range-diff vs v1:
1: 5032ddf99da ! 1: e84d069cf19 Documentation: clarify that cache forgets credentials if the system restarts
@@ Metadata
## Commit message ##
Documentation: clarify that cache forgets credentials if the system restarts
- Make it obvious to readers unfamiliar with Unix sockets.
-
Signed-off-by: M Hickford <mirth.hickford@xxxxxxxxx>
## Documentation/git-credential-cache.txt ##
-@@ Documentation/git-credential-cache.txt: DESCRIPTION
+@@ Documentation/git-credential-cache.txt: git config credential.helper 'cache [<options>]'
+ DESCRIPTION
+ -----------
- This command caches credentials in memory for use by future Git
- programs. The stored credentials never touch the disk, and are forgotten
+-This command caches credentials in memory for use by future Git
+-programs. The stored credentials never touch the disk, and are forgotten
-after a configurable timeout. The cache is accessible over a Unix
-+after a configurable timeout. Credentials are forgotten sooner if you
-+log out or the system restarts. The cache is accessible over a Unix
- domain socket, restricted to the current user by filesystem permissions.
+-domain socket, restricted to the current user by filesystem permissions.
++This command caches credentials for use by future Git programs.
++The stored credentials are kept in memory of the cache-daemon
++process (instead of written to a file) and are forgotten after a
++configurable timeout. Credentials are forgotten sooner if the
++cache-daemon dies, for example if the system restarts. The cached
++is accessible over a Unix domain socket, restricted to the current
++user by filesystem permissions.
You probably don't want to invoke this command directly; it is meant to
+ be used as a credential helper by other parts of Git. See
Documentation/git-credential-cache.txt | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index 432e159d952..9eef5d2cc10 100644
--- a/Documentation/git-credential-cache.txt
+++ b/Documentation/git-credential-cache.txt
@@ -14,10 +14,13 @@ git config credential.helper 'cache [<options>]'
DESCRIPTION
-----------
-This command caches credentials in memory for use by future Git
-programs. The stored credentials never touch the disk, and are forgotten
-after a configurable timeout. The cache is accessible over a Unix
-domain socket, restricted to the current user by filesystem permissions.
+This command caches credentials for use by future Git programs.
+The stored credentials are kept in memory of the cache-daemon
+process (instead of written to a file) and are forgotten after a
+configurable timeout. Credentials are forgotten sooner if the
+cache-daemon dies, for example if the system restarts. The cached
+is accessible over a Unix domain socket, restricted to the current
+user by filesystem permissions.
You probably don't want to invoke this command directly; it is meant to
be used as a credential helper by other parts of Git. See
base-commit: 5cc9858f1b470844dea5c5d3e936af183fdf2c68
--
gitgitgadget
