threads / discuss / 37790

Incorrect documention for git-credential-store

Subject: Incorrect documention for git-credential-store

## tl;dr

2 messages between Oct 23, 2014 and Nov 6, 2014.

replies: 1people: 2as markdown or json

Hopkins, Jesse· Oct 23, 2014, 17:14 UTC · lore

The man page for git-credential-store at http://git-scm.com/docs/git-credential-store and https://www.kernel.org/pub/software/scm/git/docs/git-credential-store.html

incorrectly state that the option to change the credential storage path is '--store'.  The name of the option should be '--file'. I have noticed this running it 1.8.5.3

Regards - Jesse

Jeff King· Nov 6, 2014, 07:40 UTC · re: Hopkins, Jesse · lore

[PATCH] docs/credential-store: s/--store/--file/

On Thu, Oct 23, 2014 at 05:14:56PM +0000, Hopkins, Jesse wrote:
Show 8 quoted lines
> The man page for git-credential-store at
> http://git-scm.com/docs/git-credential-store
> and
> https://www.kernel.org/pub/software/scm/git/docs/git-credential-store.html
> 
> incorrectly state that the option to change the credential storage
> path is '--store'.  The name of the option should be '--file'. I have
> noticed this running it 1.8.5.3
Thanks. Here's a fix.

-- >8 -- The option name "--store" was used early in development, but never even made it into an applied patch, let alone a released version of git. I forgot to update the matching documentation at the time, though.

Noticed-by: Jesse Hopkins <jesse.hopkins@lmco.com>
Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/git-credential-store.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt
index 8481cae..bc97071 100644
--- a/Documentation/git-credential-store.txt
+++ b/Documentation/git-credential-store.txt
@@ -29,7 +29,7 @@ linkgit:gitcredentials[7] or `EXAMPLES` below.
 OPTIONS
 -------
 
---store=<path>::
+--file=<path>::
 
 	Use `<path>` to store credentials. The file will have its
 	filesystem permissions set to prevent other users on the system
-- 
2.1.2.596.g7379948

← back to recent threads