mirror of
https://github.com/git/git
synced 2024-08-24 18:26:02 +00:00
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>
This commit is contained in:
parent
566a1439f6
commit
7b4fb434b4
|
@ -1,8 +0,0 @@
|
|||
grep API
|
||||
========
|
||||
|
||||
Talk about <grep.h>, things like:
|
||||
|
||||
* grep_buffer()
|
||||
|
||||
(JC)
|
|
@ -1,15 +0,0 @@
|
|||
object access API
|
||||
=================
|
||||
|
||||
Talk about <sha1-file.c> and <object.h> family, things like
|
||||
|
||||
* read_sha1_file()
|
||||
* read_object_with_reference()
|
||||
* has_sha1_file()
|
||||
* write_sha1_file()
|
||||
* pretend_object_file()
|
||||
* lookup_{object,commit,tag,blob,tree}
|
||||
* parse_{object,commit,tag,blob,tree}
|
||||
* Use of object flags
|
||||
|
||||
(JC, Shawn, Daniel, Dscho, Linus)
|
|
@ -1,10 +0,0 @@
|
|||
quote API
|
||||
=========
|
||||
|
||||
Talk about <quote.h>, things like
|
||||
|
||||
* sq_quote and unquote
|
||||
* c_style quote and unquote
|
||||
* quoting for foreign languages
|
||||
|
||||
(JC)
|
|
@ -1,7 +0,0 @@
|
|||
xdiff interface API
|
||||
===================
|
||||
|
||||
Talk about our calling convention to xdiff library, including
|
||||
xdiff_emit_consume_fn.
|
||||
|
||||
(Dscho, JC)
|
Loading…
Reference in a new issue