diff options
| author | brian m. carlson <sandals@crustytoothpaste.net> | 2025-01-20 01:56:02 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-01-21 12:56:06 -0800 |
| commit | 1f010d6bdf756129db13d1367c888aa4153f6d87 (patch) | |
| tree | 715708841b4980198157a60e72028e25a0059177 /Documentation/git-credential-cache.txt | |
| parent | ed4cf6e8e29bebb9324ba1a400a6c07513f2d642 (diff) | |
| download | git-1f010d6bdf756129db13d1367c888aa4153f6d87.tar.xz | |
doc: use .adoc extension for AsciiDoc files
We presently use the ".txt" extension for our AsciiDoc files. While not
wrong, most editors do not associate this extension with AsciiDoc,
meaning that contributors don't get automatic editor functionality that
could be useful, such as syntax highlighting and prose linting.
It is much more common to use the ".adoc" extension for AsciiDoc files,
since this helps editors automatically detect files and also allows
various forges to provide rich (HTML-like) rendering. Let's do that
here, renaming all of the files and updating the includes where
relevant. Adjust the various build scripts and makefiles to use the new
extension as well.
Note that this should not result in any user-visible changes to the
documentation.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-credential-cache.txt')
| -rw-r--r-- | Documentation/git-credential-cache.txt | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt deleted file mode 100644 index 487cc557a8..0000000000 --- a/Documentation/git-credential-cache.txt +++ /dev/null @@ -1,83 +0,0 @@ -git-credential-cache(1) -======================= - -NAME ----- -git-credential-cache - Helper to temporarily store passwords in memory - -SYNOPSIS --------- ------------------------------ -git config credential.helper 'cache [<options>]' ------------------------------ - -DESCRIPTION ------------ - -This command caches credentials for use by future Git programs. -The stored credentials are kept in memory of the cache-daemon -process (instead of being 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 -linkgit:gitcredentials[7] or `EXAMPLES` below. - -OPTIONS -------- - ---timeout <seconds>:: - - Number of seconds to cache credentials (default: 900). - ---socket <path>:: - - Use `<path>` to contact a running cache daemon (or start a new - cache daemon if one is not started). - Defaults to `$XDG_CACHE_HOME/git/credential/socket` unless - `~/.git-credential-cache/` exists in which case - `~/.git-credential-cache/socket` is used instead. - If your home directory is on a network-mounted filesystem, you - may need to change this to a local filesystem. You must specify - an absolute path. - -CONTROLLING THE DAEMON ----------------------- - -If you would like the daemon to exit early, forgetting all cached -credentials before their timeout, you can issue an `exit` action: - --------------------------------------- -git credential-cache exit --------------------------------------- - -EXAMPLES --------- - -The point of this helper is to reduce the number of times you must type -your username or password. For example: - ------------------------------------- -$ git config credential.helper cache -$ git push http://example.com/repo.git -Username: <type your username> -Password: <type your password> - -[work for 5 more minutes] -$ git push http://example.com/repo.git -[your credentials are used automatically] ------------------------------------- - -You can provide options via the credential.helper configuration -variable (this example increases the cache time to 1 hour): - -------------------------------------------------------- -$ git config credential.helper 'cache --timeout=3600' -------------------------------------------------------- - -GIT ---- -Part of the linkgit:git[1] suite |
