(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] https://lore.kernel.org/git/e8f16d69089a5011c355d5939c56fa53b7a1eb2d.1597184949.git.jonathantanmy@google.com/ Signed-off-by: Jonathan Tan <jonathantanmy@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Tan committed
Aug 17, 2020 at 12:48 UTC
42d418df909e8628412ee16167c63dad005cc875
3 files changed
+14
fetch-pack.h
+8
@@ -40,6 +40,14 @@ struct fetch_pack_args {
40
unsigned cloning:1;
41
unsigned update_shallow:1;
42
unsigned deepen:1;
43
+
44
+ /*
45
+ * Indicate that the remote of this request is a promisor remote. The
46
+ * pack received does not need all referred-to objects to be present in
47
+ * the local object store, and fetch-pack will store the pack received
48
+ * together with a ".promisor" file indicating that the aforementioned
49
+ * pack is a promisor pack.
50
+ */
51
unsigned from_promisor:1;
52
53
/*
remote-curl.c
+3
@@ -39,7 +39,10 @@ struct options {
39
/* One of the SEND_PACK_PUSH_CERT_* constants. */
40
push_cert : 2,
41
deepen_relative : 1,
42
+
43
+ /* see documentation of corresponding flag in fetch-pack.h */
44
from_promisor : 1,
45
+
46
no_dependents : 1,
47
atomic : 1,
48
object_format : 1;
transport.h
+3
@@ -15,7 +15,10 @@ struct git_transport_options {
15
unsigned self_contained_and_connected : 1;
16
unsigned update_shallow : 1;
17
unsigned deepen_relative : 1;
18
+
19
+ /* see documentation of corresponding flag in fetch-pack.h */
20
unsigned from_promisor : 1;
21
+
22
unsigned no_dependents : 1;
23
24
/*