]> git.ipfire.org Git - thirdparty/git.git/commit
remote: move doc to remote.h and refspec.h
authorHeba Waly <heba.waly@gmail.com>
Sun, 17 Nov 2019 21:04:45 +0000 (21:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2019 06:21:28 +0000 (15:21 +0900)
commitd27eb356bf253be763ab08733fae723adda27e1c
treefc08851fbcb7750b3a263df8c705451f5f45677d
parent405c6b1fbc699a9651e3a555612fd7a31590a509
remote: move doc to remote.h and refspec.h

Move the documentation from Documentation/technical/api-remote.txt to
remote.h and refspec.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.

N.B. The doc for both push and fetch members of the remote struct aren't
moved because they are out of date, as the members were changed from arrays
of rspecs to struct refspec 2 years ago.

Also documentation/technical/api-remote.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.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-remote.txt [deleted file]
refspec.h
remote.h