]> git.ipfire.org Git - thirdparty/git.git/commit
documentation: remove empty doc files
authorHeba Waly <heba.waly@gmail.com>
Thu, 24 Oct 2019 11:29:11 +0000 (11:29 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 25 Oct 2019 02:18:14 +0000 (11:18 +0900)
commit7b4fb434b410358b7a70ef772463292e18bf6c30
tree551cc24375da08ddc24c9de6e67e9604efedafaf
parent566a1439f6f56c2171b8853ddbca0ad3f5098770
documentation: remove empty doc files

Remove empty and redundant documentation files from the
Documentation/technical/ directory.

The empty doc files included only TODO messages with no documentation for
years. Instead an approach is being taken to keep all doc beside the code
in the relevant header files.
Having empty doc files is confusing and disappointing to anybody looking
for information, besides having the documentation in header files makes it
easier for developers to find the information they are looking for.

Some of the content which could have gone here already exists elsewhere:
- api-object-access.txt -> sha1-file.c and object.h have some details.
- api-quote.txt -> quote.h has some details.
- api-xdiff-interface.txt -> xdiff-interface.h has some details.
- api-grep.txt -> grep.h does not have enough documentation at the moment.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
Reviewed-by: Emily Shaffer <emilyshaffer@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-grep.txt [deleted file]
Documentation/technical/api-object-access.txt [deleted file]
Documentation/technical/api-quote.txt [deleted file]
Documentation/technical/api-xdiff-interface.txt [deleted file]