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

Re: [PATCH] documentation: remove unfinished documentation

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 17, 2017, 20:36 UTC
Message-ID
<xmqqpojle85c.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20170117200147.25425-1-sbeller@google.com>
Stefan Beller <sbeller@google.com> writes:
Show 14 quoted lines
> When looking for documentation for a specific function, you may be tempted
> to run
>
>   git -C Documentation grep index_name_pos
>
> only to find the file technical/api-in-core-index.txt, which doesn't
> help for understanding the given function. It would be better to not find
> these functions in the documentation, such that people directly dive into
> the code instead.
>
> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>
> I run into this a couple of times now, so I put this out tentatively.

These placeholders are meant to encourage those people who dove into the code to update it, so from that point of view, I think removing it is backwards.

Previous: Stefan BellerNext: Stefan Beller
Message 2 of 5 in “documentation: remove unfinished documentation”
  1. documentation: remove unfinished documentationStefan Beller, Jan 17, 2017
  2. Junio C HamanoJan 17, 2017
  3. document index_name_posStefan Beller, Jan 17, 2017
  4. Junio C HamanoJan 17, 2017
  5. Stefan BellerJan 17, 2017

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.