path: root/fetch-pack.h
diff options
authorJonathan Tan <>2020-08-17 19:48:18 (GMT)
committerJunio C Hamano <>2020-08-25 00:30:08 (GMT)
commit42d418df909e8628412ee16167c63dad005cc875 (patch)
tree7289dff5ba15ea4e83a9fccfff1a62fb089acf1f /fetch-pack.h
parent878e727637ec5815ccb3301eb994a54df95b21b8 (diff)
(various): document from_promisor parameter
88e2f9ed8e ("introduce fetch-object: fetch one promisor object", 2017-12-05) plumbed through the from_promisor parameter but did not document it everywhere it appeared. Add the documentation. (It also plumbed through the no_dependents parameter, but I have left that alone because it is being removed in a commit under review [1].) [1] Signed-off-by: Jonathan Tan <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'fetch-pack.h')
1 files changed, 8 insertions, 0 deletions
diff --git a/fetch-pack.h b/fetch-pack.h
index 85d1e39..5e747da 100644
--- a/fetch-pack.h
+++ b/fetch-pack.h
@@ -40,6 +40,14 @@ struct fetch_pack_args {
unsigned cloning:1;
unsigned update_shallow:1;
unsigned deepen:1;
+ /*
+ * Indicate that the remote of this request is a promisor remote. The
+ * pack received does not need all referred-to objects to be present in
+ * the local object store, and fetch-pack will store the pack received
+ * together with a ".promisor" file indicating that the aforementioned
+ * pack is a promisor pack.
+ */
unsigned from_promisor:1;