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

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

From
Emily Shaffer <emilyshaffer@google.com>
Date
Oct 24, 2019, 20:48 UTC
Message-ID
<20191024204840.GH9323@google.com>
In-Reply-To
<ee64a075d3074718a47da4ed369cee6923d0b460.1571916551.git.gitgitgadget@gmail.com>
On Thu, Oct 24, 2019 at 11:29:11AM +0000, Heba Waly via GitGitGadget wrote:
Show 19 quoted lines
> From: Heba Waly <heba.waly@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>
Reviewed-by: Emily Shaffer <emilyshaffer@google.com>
Thanks, Heba.
 - Emily
Previous: Heba Waly via GitGitGadget
Message 13 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.