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

[PATCH] documentation: remove unfinished documentation

From
Stefan Beller <sbeller@google.com>
Date
Jan 17, 2017, 20:01 UTC
Message-ID
<20170117200147.25425-1-sbeller@google.com>

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.

Thanks, Stefan

 Documentation/technical/api-in-core-index.txt | 21 ---------------------
 1 file changed, 21 deletions(-)
 delete mode 100644 Documentation/technical/api-in-core-index.txt
diff --git a/Documentation/technical/api-in-core-index.txt b/Documentation/technical/api-in-core-index.txt
deleted file mode 100644
index adbdbf5d75..0000000000
--- a/Documentation/technical/api-in-core-index.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-in-core index API
-=================
-
-Talk about <read-cache.c> and <cache-tree.c>, things like:
-
-* cache -> the_index macros
-* read_index()
-* write_index()
-* ie_match_stat() and ie_modified(); how they are different and when to
-  use which.
-* index_name_pos()
-* remove_index_entry_at()
-* remove_file_from_index()
-* add_file_to_index()
-* add_index_entry()
-* refresh_index()
-* discard_index()
-* cache_tree_invalidate_path()
-* cache_tree_update()
-
-(JC, Linus)
-- 
2.11.0.297.g298debce27
Next: Junio C Hamano
Message 1 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.