cache.h: document add_[file_]to_index
Helped-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Beller committed
Jan 18, 2017 at 19:18 UTC
20cf41d02158cbb838faec70ad1d989172fc592f
1 file changed
+10
cache.h
+10
@@ -614,8 +614,18 @@ extern int remove_file_from_index(struct index_state *, const char *path);
614
#define ADD_CACHE_IGNORE_ERRORS 4
615
#define ADD_CACHE_IGNORE_REMOVAL 8
616
#define ADD_CACHE_INTENT 16
617
+/*
618
+ * These two are used to add the contents of the file at path
619
+ * to the index, marking the working tree up-to-date by storing
620
+ * the cached stat info in the resulting cache entry. A caller
621
+ * that has already run lstat(2) on the path can call
622
+ * add_to_index(), and all others can call add_file_to_index();
623
+ * the latter will do necessary lstat(2) internally before
624
+ * calling the former.
625
+ */
626
extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
627
extern int add_file_to_index(struct index_state *, const char *path, int flags);
628
+
629
extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
630
extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
631
extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);