]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation: increase example cache timeout to 1 hour
authorM Hickford <mirth.hickford@gmail.com>
Wed, 9 Nov 2022 16:11:13 +0000 (16:11 +0000)
committerTaylor Blau <me@ttaylorr.com>
Thu, 10 Nov 2022 02:28:53 +0000 (21:28 -0500)
Previously, the example *decreased* the cache timeout compared to the
default, making it less user friendly.

Instead, nudge users to make cache more usable. Many users choose
store over cache.
https://lore.kernel.org/git/CAGJzqskRYN49SeS8kSEN5-vbB_Jt1QvAV9QhS6zNuKh0u8wxPQ@mail.gmail.com/

The default timeout remains 15 minutes. A stronger nudge would
be to increase that.

Signed-off-by: M Hickford <mirth.hickford@gmail.com>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Documentation/git-credential-cache.txt

index 0216c18ef80c9a9d32095ec3969091aff1c20344..432e159d95246ccb9e716ad1554c8b6047db1870 100644 (file)
@@ -69,10 +69,10 @@ $ git push http://example.com/repo.git
 ------------------------------------
 
 You can provide options via the credential.helper configuration
-variable (this example drops the cache time to 5 minutes):
+variable (this example increases the cache time to 1 hour):
 
 -------------------------------------------------------
-$ git config credential.helper 'cache --timeout=300'
+$ git config credential.helper 'cache --timeout=3600'
 -------------------------------------------------------
 
 GIT