diff mbox series

[v3] Documentation: clarify that cache forgets credentials if the system restarts

Message ID pull.1447.v3.git.1674936815117.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit 4f542975d1c0e78799359e1bd40e34972030a1cf
Headers show
Series [v3] Documentation: clarify that cache forgets credentials if the system restarts | expand

Commit Message

M Hickford Jan. 28, 2023, 8:13 p.m. UTC 
From: M Hickford <mirth.hickford@gmail.com>

Signed-off-by: M Hickford <mirth.hickford@gmail.com>
---
    Documentation: clarify that cache forgets credentials if the system
    restarts
    
    Make it obvious to readers unfamiliar with Unix sockets.
    
    Signed-off-by: M Hickford mirth.hickford@gmail.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1447%2Fhickford%2Fpatch-2-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1447/hickford/patch-2-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1447

Range-diff vs v2:

 1:  e84d069cf19 ! 1:  09f4afae70c Documentation: clarify that cache forgets credentials if the system restarts
     @@ Documentation/git-credential-cache.txt: git config credential.helper 'cache [<op
      +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 cached
     ++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.
       


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


base-commit: 5cc9858f1b470844dea5c5d3e936af183fdf2c68

Comments

Jeff King Jan. 29, 2023, 6:48 a.m. UTC | #1 
On Sat, Jan 28, 2023 at 08:13:34PM +0000, M Hickford via GitGitGadget wrote:

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

This version looks good to me.

-Peff
Junio C Hamano Jan. 29, 2023, 5:26 p.m. UTC | #2 
Jeff King <peff@peff.net> writes:

> On Sat, Jan 28, 2023 at 08:13:34PM +0000, M Hickford via GitGitGadget wrote:
>
>> diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
>> index 432e159d952..f473994a864 100644
>> --- a/Documentation/git-credential-cache.txt
>> +++ b/Documentation/git-credential-cache.txt
>> @@ -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.
>
> This version looks good to me.

Yup, it looks good to me, too.  Thanks, all.
diff mbox series

Patch

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