[PATCH v2 0/1] [Outreachy] documentation: remove empty doc files

2019-10-23 Thread Heba Waly via GitGitGadget
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 co

[PATCH v2 1/1] documentation: remove empty doc files

2019-10-23 Thread Heba Waly via GitGitGadget
From: Heba 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 emp

[PATCH v3 1/1] config: move documentation to config.h

2019-10-22 Thread Heba Waly via GitGitGadget
From: Heba Waly Move the documentation from Documentation/technical/api-config.txt into config.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file, also documentation/technical/api-config.txt is removed because the inform

[PATCH v3 0/1] [Outreachy] config: move documentation to config.h

2019-10-22 Thread Heba Waly via GitGitGadget
Move the documentation from Documentation/technical/api-config.txt into config.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file, also documentation/technical/api-config.txt is removed because the information it has is no

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

2019-10-22 Thread Heba Waly via GitGitGadget
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: Documentation/technical

[PATCH 1/1] documentation: remove empty doc files

2019-10-22 Thread Heba Waly via GitGitGadget
From: Heba Waly 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

[PATCH v2 1/1] config: move documentation to config.h

2019-10-22 Thread Heba Waly via GitGitGadget
From: Heba Waly Move the documentation from Documentation/technical/api-config.txt into config.h Signed-off-by: Heba Waly --- Documentation/technical/api-config.txt | 319 --- config.h | 336 + 2 files changed, 336 insert

[PATCH v2 0/1] [Outreachy] config: move documentation to config.h

2019-10-22 Thread Heba Waly via GitGitGadget
Move the documentation from Documentation/technical/api-config.txt into config.h Signed-off-by: Heba Waly heba.w...@gmail.com [heba.w...@gmail.com] Thanks for taking the time to contribute to Git! Please be advised that the Git community does not use github.com for their contributions. Instead, w

[PATCH 0/1] config: add documentation to config.h

2019-10-17 Thread Heba Waly via GitGitGadget
This commit is copying and summarizing the documentation from documentation/technical/api-config.txt to comments in config.h Signed-off-by: Heba Waly heba.w...@gmail.com [heba.w...@gmail.com] Thanks for taking the time to contribute to Git! Please be advised that the Git community does not use gi

[PATCH 1/1] config: add documentation to config.h

2019-10-17 Thread Heba Waly via GitGitGadget
From: Heba Waly This commit is copying and summarizing the documentation from documentation/technical/api-config.txt to comments in config.h Signed-off-by: Heba Waly --- config.h | 327 +++ 1 file changed, 327 insertions(+) diff --git a/conf