diff options
author | Heba Waly <heba.waly@gmail.com> | 2019-11-18 00:04:53 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-11-18 09:21:29 +0300 |
commit | f3b9055624cb797b1956f100a40104c9aceb4835 (patch) | |
tree | 94ebe29cf7e0d3dd36320f521a33c131fa010a4f /Documentation/git-credential.txt | |
parent | 971b1f24a2190ebe288fc6544378941a0624bb95 (diff) |
credential: move doc to credential.h
Move the documentation from Documentation/technical/api-credentials.txt
to credential.h as it's easier for the developers to find the usage
information beside the code instead of looking for it in another doc file.
Documentation/technical/api-credentials.txt is removed because the
information it has is now redundant and it'll be hard to keep it up to
date and synchronized with the documentation in the header file.
Documentation/git-credential.txt and Documentation/gitcredentials.txt now link
to credential.h instead of Documentation/technical/api-credentials.txt for
details about the credetials API.
Signed-off-by: Heba Waly <heba.waly@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-credential.txt')
-rw-r--r-- | Documentation/git-credential.txt | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt index b211440373..6f0c7ca80f 100644 --- a/Documentation/git-credential.txt +++ b/Documentation/git-credential.txt @@ -19,8 +19,7 @@ from system-specific helpers, as well as prompting the user for usernames and passwords. The git-credential command exposes this interface to scripts which may want to retrieve, store, or prompt for credentials in the same manner as Git. The design of this scriptable -interface models the internal C API; see -link:technical/api-credentials.html[the Git credential API] for more +interface models the internal C API; see credential.h for more background on the concepts. git-credential takes an "action" option on the command-line (one of |