diff mbox series

[v2,2/3] fetch-pack: document only_packfile in get_pack()

Message ID eae9024f73e67d1d5fc60c589ebb2106faefcb56.1597693540.git.jonathantanmy@google.com (mailing list archive)
State New, archived
Headers show
Series fetch-pack: make packfile URIs work with transfer.fsckobjects | expand

Commit Message

Jonathan Tan Aug. 17, 2020, 7:48 p.m. UTC
dd4b732df7 ("upload-pack: send part of packfile response as uri",
2020-06-10) added the "only_packfile" parameter to get_pack() but did
not document it. Add documentation.

Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
---
 fetch-pack.c | 4 ++++
 1 file changed, 4 insertions(+)
diff mbox series

Patch

diff --git a/fetch-pack.c b/fetch-pack.c
index 7f20eca4f8..289121038e 100644
--- a/fetch-pack.c
+++ b/fetch-pack.c
@@ -794,6 +794,10 @@  static void write_promisor_file(const char *keep_name,
 	strbuf_release(&promisor_name);
 }
 
+/*
+ * Pass 1 as "only_packfile" if the pack received is the only pack in this
+ * fetch request (that is, if there were no packfile URIs provided).
+ */
 static int get_pack(struct fetch_pack_args *args,
 		    int xd[2], struct string_list *pack_lockfiles,
 		    int only_packfile,