From: "M Hickford via GitGitGadget" <gitgitgadget@gmail•com>
To: git@vger•kernel.org
Cc: "brian m. carlson" <sandals@crustytoothpaste•net>,
Jeff King <peff@peff•net>, M Hickford <mirth.hickford@gmail•com>,
M Hickford <mirth.hickford@gmail•com>
Subject: [PATCH v2] Documentation: clarify that cache forgets credentials if the system restarts
Date: Sat, 28 Jan 2023 20:09:23 +0000 [thread overview]
Message-ID: <pull.1447.v2.git.1674936563549.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1447.git.1671610994375.gitgitgadget@gmail.com>
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-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1447/hickford/patch-2-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1447
Range-diff vs v1:
1: 5032ddf99da ! 1: e84d069cf19 Documentation: clarify that cache forgets credentials if the system restarts
@@ Metadata
## Commit message ##
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>
## Documentation/git-credential-cache.txt ##
-@@ Documentation/git-credential-cache.txt: DESCRIPTION
+@@ Documentation/git-credential-cache.txt: 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
+-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
-+after a configurable timeout. Credentials are forgotten sooner if you
-+log out or the system restarts. The cache is accessible over a Unix
- domain socket, restricted to the current user by filesystem permissions.
+-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 cached
++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
Documentation/git-credential-cache.txt | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index 432e159d952..9eef5d2cc10 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 cached
+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
base-commit: 5cc9858f1b470844dea5c5d3e936af183fdf2c68
--
gitgitgadget
next prev parent reply other threads:[~2023-01-28 20:09 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-21 8:23 [PATCH] Documentation: clarify that cache forgets credentials if the system restarts M Hickford via GitGitGadget
2022-12-21 11:15 ` Junio C Hamano
2022-12-22 2:41 ` Jeff King
2023-01-28 20:08 ` M Hickford
2022-12-21 22:09 ` brian m. carlson
2023-01-28 20:09 ` M Hickford via GitGitGadget [this message]
2023-01-28 20:13 ` [PATCH v3] " M Hickford via GitGitGadget
2023-01-29 6:48 ` Jeff King
2023-01-29 17:26 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1447.v2.git.1674936563549.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=mirth.hickford@gmail$(echo .)com \
--cc=peff@peff$(echo .)net \
--cc=sandals@crustytoothpaste$(echo .)net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox