]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation: clarify that cache forgets credentials if the system restarts
authorM Hickford <mirth.hickford@gmail.com>
Sat, 28 Jan 2023 20:13:34 +0000 (20:13 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sun, 29 Jan 2023 17:21:07 +0000 (09:21 -0800)
Signed-off-by: M Hickford <mirth.hickford@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-credential-cache.txt

index 432e159d95246ccb9e716ad1554c8b6047db1870..f473994a864e9575d57844e1640e8dfb4eea00dd 100644 (file)
@@ -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 cache
+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