Skip to contentSkip to conversation

Documentation: increase example cache timeout to 1 hour

PATCH Superseded M Hickford via GitGitGadget 4 participants 5 messages Nov 9, 2022 – Nov 10, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: increase example cache timeout to 1 hour

From: M Hickford <[email protected]>

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/[email protected]/

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

---
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/[email protected]/

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

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(-)
Documentation/git-credential-cache.txt +2 -2
index 0216c18ef80..432e159d952 100644
@@ -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

Signature · 1 line
gitgitgadget
#1 lore raw
Quoted 4 lines · M Hickford via GitGitGadget

From: M Hickford <[email protected]>

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

I don't mind at all changing this as your patch does. The existing example was mostly just to illustrate the syntax. But...

Quoted 3 lines

Instead, nudge users to make cache more usable. Currently many users choose store over cache for usability. See
https://lore.kernel.org/git/[email protected]/

I don't see how my email argues for this. The only thing I mentioned about credential-cache there is that it's not available on all platforms.

But if you want my opinion on its usability, the main problem is not that the cache timeout. It's that entering the credential at all is a pain, either because it's a semi-automated environment that needs to operate without user input, or because the credential itself is awkward for the user to enter (like a long token). And that's what pushes people to "store" over "cache".

Quoted 5 lines
Documentation/git-credential-cache.txt +0 -0
index 0216c18ef80..432e159d952 100644

Documentation/git-credential-cache.txt $ git push http://example.com/repo.git · line 76

Quoted 10 lines
Documentation/git-credential-cache.txt +2 -2
@@ -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'
 -------------------------------------------------------

The patch itself is obviously correct.

-Peff

#2 lore raw
Quoted 8 lines · Jeff King
Quoted 4 lines

Instead, nudge users to make cache more usable. Currently many users choose store over cache for usability. See
https://lore.kernel.org/git/[email protected]/

I don't see how my email argues for this. The only thing I mentioned about credential-cache there is that it's not available on all platforms.

I'll amend the commit message.

Quoted 6 lines

But if you want my opinion on its usability, the main problem is not that the cache timeout. It's that entering the credential at all is a pain, either because it's a semi-automated environment that needs to operate without user input, or because the credential itself is awkward for the user to enter (like a long token). And that's what pushes people to "store" over "cache".

I agree. I have some ideas to help human users; I'll share in the other thread.

Quoted 1 line

The patch itself is obviously correct.

Thanks for the review

#3 lore raw
Quoted 3 lines · M Hickford
Quoted 1 line

The patch itself is obviously correct.

Thanks for the review

Thanks, both. I picked up the updated round.

Thanks,
Taylor

#4 lore raw

PATCH v2 1/1 Documentation: increase example cache timeout to 1 hour

In reply to M Hickford via GitGitGadget

From: M Hickford <[email protected]>

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.

---
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/[email protected]/

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

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

Range-diff vs v1:

1: 6c35d68cf98 ! 1: e3e043779dd Documentation: increase example cache timeout to 1 hour
@@ Commit message
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.
+ default, making it less user friendly.

- Instead, nudge users to make cache more usable. Currently many users
- choose store over cache for usability. See
- https://lore.kernel.org/git/[email protected]/
+ 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.

 Documentation/git-credential-cache.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/git-credential-cache.txt +2 -2
index 0216c18ef80..432e159d952 100644
@@ -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

Signature · 1 line
gitgitgadget