Skip to content

Commit f3b9055

Browse files
HebaWalygitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 971b1f2 commit f3b9055

File tree

4 files changed

+238
-275
lines changed

4 files changed

+238
-275
lines changed

Documentation/git-credential.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ from system-specific helpers, as well as prompting the user for
1919
usernames and passwords. The git-credential command exposes this
2020
interface to scripts which may want to retrieve, store, or prompt for
2121
credentials in the same manner as Git. The design of this scriptable
22-
interface models the internal C API; see
23-
link:technical/api-credentials.html[the Git credential API] for more
22+
interface models the internal C API; see credential.h for more
2423
background on the concepts.
2524

2625
git-credential takes an "action" option on the command-line (one of

Documentation/gitcredentials.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,7 @@ CUSTOM HELPERS
186186
--------------
187187

188188
You can write your own custom helpers to interface with any system in
189-
which you keep credentials. See the documentation for Git's
190-
link:technical/api-credentials.html[credentials API] for details.
189+
which you keep credentials. See credential.h for details.
191190

192191
GIT
193192
---

Documentation/technical/api-credentials.txt

Lines changed: 0 additions & 271 deletions
This file was deleted.

0 commit comments

Comments
 (0)