summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-grep.txt
AgeCommit message (Collapse)Author
2019-10-25documentation: remove empty doc filesHeba Waly
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>
2007-12-15Start preparing the API documents.Junio C Hamano
Most of them are still stubs, but the procedure to build the HTML documentation, maintaining the index and installing the end product are there. I placed names of people who are likely to know the most about the topic in the stub files, so that volunteers will know whom to ask questions as needed. Signed-off-by: Junio C Hamano <gitster@pobox.com>