git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Heba Waly via GitGitGadget <gitgitgadget@gmail.com>
Date
Oct 24, 2019, 11:29 UTC
Message-ID
<pull.412.v3.git.1571916551.gitgitgadget@gmail.com>
In-Reply-To
<pull.412.v2.git.1571815556.gitgitgadget@gmail.com>

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 [heba.waly@gmail.com]
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 <heba.waly@gmail.com>
      
-- 
gitgitgadget
Previous: Heba WalyNext: Heba Waly via GitGitGadget
Message 11 of 13 in “[Outreachy] documentation: remove empty doc files”
  1. 0/1 [Outreachy] documentation: remove empty doc filesHeba Waly via GitGitGadget, Oct 22, 2019
  2. 1/1 documentation: remove empty doc filesHeba Waly via GitGitGadget, Oct 22, 2019
  3. Emily ShafferOct 22, 2019
  4. Junio C HamanoOct 22, 2019
  5. Heba WalyOct 23, 2019
  6. Heba WalyOct 23, 2019
  7. 0/1 [Outreachy] documentation: remove empty doc filesHeba Waly via GitGitGadget, Oct 23, 2019
  8. 1/1 documentation: remove empty doc filesHeba Waly via GitGitGadget, Oct 23, 2019
  9. Emily ShafferOct 23, 2019
  10. Heba WalyOct 24, 2019
  11. 0/1 [Outreachy] documentation: remove empty doc filesHeba Waly via GitGitGadget, Oct 24, 2019
  12. 1/1 documentation: remove empty doc filesHeba Waly via GitGitGadget, Oct 24, 2019
  13. Emily ShafferOct 24, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.