for_each_*_object: give more comprehensive docstrings
[gitweb.git] / cache.h
diff --git a/cache.h b/cache.h
index 9e02fc494ea1a0b4c1c9f3ad4e55ceb500d2086e..f438540f9b5e57dd5fe6e316f5174e377ed037e3 100644 (file)
--- a/cache.h
+++ b/cache.h
@@ -1636,9 +1636,11 @@ enum for_each_object_flags {
 };
 
 /*
- * Iterate over loose objects in both the local
- * repository and any alternates repositories (unless the
- * LOCAL_ONLY flag is set).
+ * Iterate over all accessible loose objects without respect to
+ * reachability. By default, this includes both local and alternate objects.
+ * The order in which objects are visited is unspecified.
+ *
+ * Any flags specific to packs are ignored.
  */
 int for_each_loose_object(each_loose_object_fn, void *,
                          enum for_each_object_flags flags);