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. 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. Signed-off-by: Heba Waly heba.waly@xxxxxxxxx [heba.waly@xxxxxxxxx] 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-v2 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-412/HebaWaly/delete_empty_docs-v2 Pull-Request: https://github.com/gitgitgadget/git/pull/412 Range-diff vs v1: 1: ffdde613d8 ! 1: 5cd79e24fe documentation: remove empty doc files @@ -5,13 +5,22 @@ Remove empty and redundant documentation files from the Documentation/technical/ directory. - As part of moving the documentation from Documentation/technical/api-* to - header files, the following files are deleted because they include only - TODO messages with no documentation to be moved: - Documentation/technical/api-grep.txt - Documentation/technical/api-object-access.txt - Documentation/technical/api-quote.txt - Documentation/technical/api-xdiff-interface.txt + 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. + + 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. Signed-off-by: Heba Waly <heba.waly@xxxxxxxxx> -- gitgitgadget
