promisor-remote: accept 0 as oid_nr in function

[thirdparty/git.git] / promisor-remote.h

diff --git a/promisor-remote.h b/promisor-remote.h
index 737bac3a330e22fe11058d5667cdb3f199c0484a..6343c47d1830f947aae456ed48e305faef26b6c0 100644 (file)
--- a/promisor-remote.h
+++ b/promisor-remote.h
@@ -20,6 +20,14 @@ struct promisor_remote {
 void promisor_remote_reinit(void);
 struct promisor_remote *promisor_remote_find(const char *remote_name);
 int has_promisor_remote(void);
+
+/*
+ * Fetches all requested objects from all promisor remotes, trying them one at
+ * a time until all objects are fetched. Returns 0 upon success, and non-zero
+ * otherwise.
+ *
+ * If oid_nr is 0, this function returns 0 (success) immediately.
+ */
 int promisor_remote_get_direct(struct repository *repo,
                               const struct object_id *oids,
                               int oid_nr);