cache.h: document remove_index_entry_at

stefanbeller · gitster · commit 3bd72adff1f4 · 2017-01-19T12:17:57.000-08:00
Do this by moving the existing documentation from
read-cache.c to cache.h.

Signed-off-by: Stefan Beller &lt;sbeller@google.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/cache.h b/cache.h
@@ -603,7 +603,10 @@ extern int index_name_pos(const struct index_state *, const char *name, int name
 #define ADD_CACHE_KEEP_CACHE_TREE 32	/* Do not invalidate cache-tree */
 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
+
+/* Remove entry, return true if there are more entries to go. */
 extern int remove_index_entry_at(struct index_state *, int pos);
+
 extern void remove_marked_cache_entries(struct index_state *istate);
 extern int remove_file_from_index(struct index_state *, const char *path);
 #define ADD_CACHE_VERBOSE 1
diff --git a/read-cache.c b/read-cache.c
@@ -510,7 +510,6 @@ int index_name_pos(const struct index_state *istate, const char *name, int namel
 	return index_name_stage_pos(istate, name, namelen, 0);
 }
 
-/* Remove entry, return true if there are more entries to go.. */
 int remove_index_entry_at(struct index_state *istate, int pos)
 {
 	struct cache_entry *ce = istate->cache[pos];

Original file line number	Diff line number	Diff line change
`@@ -510,7 +510,6 @@ int index_name_pos(const struct index_state istate, const char name, int namel`
`510`	`510`	`return index_name_stage_pos(istate, name, namelen, 0);`
`511`	`511`	`}`
`512`	`512`
`513`		`-/* Remove entry, return true if there are more entries to go.. */`
`514`	`513`	`int remove_index_entry_at(struct index_state *istate, int pos)`
`515`	`514`	`{`
`516`	`515`	`struct cache_entry *ce = istate->cache[pos];`