Skip to content

Commit

Permalink
documentation: remove empty doc files
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
HebaWaly committed Oct 24, 2019
1 parent d966095 commit ee64a07
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 40 deletions.
8 changes: 0 additions & 8 deletions Documentation/technical/api-grep.txt

This file was deleted.

15 changes: 0 additions & 15 deletions Documentation/technical/api-object-access.txt

This file was deleted.

10 changes: 0 additions & 10 deletions Documentation/technical/api-quote.txt

This file was deleted.

7 changes: 0 additions & 7 deletions Documentation/technical/api-xdiff-interface.txt

This file was deleted.

0 comments on commit ee64a07

Please sign in to comment.