]> git.ipfire.org Git - thirdparty/git.git/commit
diff: move doc to diff.h and diffcore.h
authorHeba Waly <heba.waly@gmail.com>
Sun, 17 Nov 2019 21:04:40 +0000 (21:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2019 06:21:28 +0000 (15:21 +0900)
commit13c4d7eb228ea29dba77f8800daf2bd0ac54755a
tree06bd9c47bcfe5edcb953755e6d7cbcff7d4cc1a0
parentd9f6f3b6195a0ca35642561e530798ad1469bd41
diff: move doc to diff.h and diffcore.h

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

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

There are three members documented in the doc file that weren't found in
the header files, assuming the doc wasn't up to date and the members
no longer exist:
touched_flags, COLOR_DIFF_WORDS and QUIET.

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