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

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

[M Hickford via GitGitGadget]

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

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

[Jeff King]

On Wed, Nov 09, 2022 at 10:19:41AM +0000, M Hickford via GitGitGadget wrote:

> 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.

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

> 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/

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".

> 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'
>  -------------------------------------------------------

The patch itself is obviously correct.

-Peff

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

[M Hickford]

On Wed, 9 Nov 2022 at 13:18, Jeff King <peff@peff.net> wrote:
>
> > 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/
>
> 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.

> 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.

> The patch itself is obviously correct.

Thanks for the review

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

[M Hickford via GitGitGadget]

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

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>
---
    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-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/Y2p4rhiOphuOM0VQ@coredump.intra.peff.net/
     +    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(-)

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

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

[Taylor Blau]

On Wed, Nov 09, 2022 at 04:09:14PM +0000, M Hickford wrote:
> > The patch itself is obviously correct.
>
> Thanks for the review

Thanks, both. I picked up the updated round.

Thanks,
Taylor