summaryrefslogtreecommitdiff
path: root/connected.h
diff options
context:
space:
mode:
authorJonathan Tan <jonathantanmy@google.com>2018-09-21 18:22:37 (GMT)
committerJunio C Hamano <gitster@pobox.com>2018-09-21 20:20:47 (GMT)
commit4937291b45800372c2c34855a6a36d5d2a77af2c (patch)
treed12fb8c4546a0ec0e40a33210f88df3b0ab3da1f /connected.h
parent150f307afc13961b0322ad0e7205a7b193368586 (diff)
downloadgit-4937291b45800372c2c34855a6a36d5d2a77af2c.zip
git-4937291b45800372c2c34855a6a36d5d2a77af2c.tar.gz
git-4937291b45800372c2c34855a6a36d5d2a77af2c.tar.bz2
connected: document connectivity in partial clones
In acb0c57260 ("fetch: support filters", 2017-12-08), check_connected() was extended to allow objects to either be promised to be available (if the repository is a partial clone) or to be present; previously, this function required the latter. However, this change was not reflected in the documentation of that function. Update the documentation accordingly. Signed-off-by: Jonathan Tan <jonathantanmy@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'connected.h')
-rw-r--r--connected.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/connected.h b/connected.h
index e4c9618..8d5a6b3 100644
--- a/connected.h
+++ b/connected.h
@@ -51,9 +51,9 @@ struct check_connected_options {
#define CHECK_CONNECTED_INIT { 0 }
/*
- * Make sure that our object store has all the commits necessary to
- * connect the ancestry chain to some of our existing refs, and all
- * the trees and blobs that these commits use.
+ * Make sure that all given objects and all objects reachable from them
+ * either exist in our object store or (if the repository is a partial
+ * clone) are promised to be available.
*
* Return 0 if Ok, non zero otherwise (i.e. some missing objects)
*