[PATCH] Documentation: increase example cache timeout to 1 hour

From: M Hickford via GitGitGadget <gitgitgadget@gmail.com>
Date: Nov 9, 2022, 10:19 UTC
Message-ID: <pull.1412.git.1667989181611.gitgitgadget@gmail.com>

From: M Hickford <mirth.hickford@gmail.com>

Previously, the example *decreased* the cache timeout compared to the default, nudging users to make cache less usable.

Instead, nudge users to make cache more usable. Currently many users choose store over cache for usability. See https://lore.kernel.org/git/Y2p4rhiOphuOM0VQ@coredump.intra.peff.net/

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

Signed-off-by: M Hickford <mirth.hickford@gmail.com>
---
    Documentation: Increase example cache timeout to 1 hour
    
    Previously, the example decreased the cache timeout compared to the
    default, nudging users to make cache less usable.
    
    Instead, nudge users to make cache more usable. Currently many users
    choose store over cache for usability. See
    https://lore.kernel.org/git/Y2p4rhiOphuOM0VQ@coredump.intra.peff.net/
    
    The default timeout remains 15 minutes. A stronger nudge would be to
    increase that.
    
    Signed-off-by: M Hickford mirth.hickford@gmail.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1412%2Fhickford%2Fnudge-cache-longer-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1412/hickford/nudge-cache-longer-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1412

 Documentation/git-credential-cache.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index 0216c18ef80..432e159d952 100644
--- a/Documentation/git-credential-cache.txt
+++ b/Documentation/git-credential-cache.txt
@@ -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

base-commit: 319605f8f00e402f3ea758a02c63534ff800a711

-- 
gitgitgadget