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

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

From
Emily Shaffer <emilyshaffer@google.com>
Date
Oct 23, 2019, 21:44 UTC
Message-ID
<20191023214404.GB124161@google.com>
In-Reply-To
<5cd79e24fe6bde7c5d10e1c2cae660858e3c4051.1571815556.git.gitgitgadget@gmail.com>
On Wed, Oct 23, 2019 at 07:25:56AM +0000, Heba Waly via GitGitGadget wrote:
Show 14 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.
> 
> here's a list of the files removed and if the info can be found in the
> corresponding header file:

I think you can remove the above; in lots of composition contexts it tends to be bad form to say "Here is <something>: <something>" - don't warn us that you're going to present it, just present it. :) (Or, at least, this has been drilled into my head by many high school English teachers...)

Maybe you could say something like, "Some of the content which could have gone here already exists elsewhere:" If you take that suggestion, you can probably move grep.h to the bottom, as it's the exception which doesn't have content that exists elsewhere.

Show 7 quoted lines
> 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.

For this list, I think you can remove the numbered bullet, and the leading "Documentation/technical/" - we can see the files deleted from the diff.

 - Emily
Previous: Heba Waly via GitGitGadgetNext: Heba Waly
Message 9 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.