[v3,0/1,Outreachy] documentation: remove empty doc files

Message

John Cai via GitGitGadget Oct. 24, 2019, 11:29 a.m. UTC

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 [e-mail] [[e-mail]]

Heba Waly (1):
  documentation: remove empty doc files

 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt


base-commit: d966095db01190a2196e31195ea6fa0c722aa732
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-412%2FHebaWaly%2Fdelete_empty_docs-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-412/HebaWaly/delete_empty_docs-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/412

Range-diff vs v2:

 1:  5cd79e24fe ! 1:  ee64a075d3 documentation: remove empty doc files
     @@ -12,15 +12,11 @@
          for information, besides having the documentation in header files makes it
          easier for developers to find the information they are looking for.
      
     -    here's a list of the files removed and if the info can be found in the
     -    corresponding header file:
     -    1- Documentation/technical/api-grep.txt -> grep.h does not have enough
     -    documentation at the moment.
     -    2- Documentation/technical/api-object-access.txt -> sha1-file.c and
     -    object.h have some details
     -    3- Documentation/technical/api-quote.txt -> quote.h has some details.
     -    4- Documentation/technical/api-xdiff-interface.txt -> xdiff-interface.h has
     -    some details.
     +    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 <[e-mail]>