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>

Jonathan Tan committed Sep 21, 2018 at 11:22 UTC 4937291b45800372c2c34855a6a36d5d2a77af2c
1 file changed +3 -3
connected.h
+3 -3
@@ -51,9 +51,9 @@ struct check_connected_options {
51 #define CHECK_CONNECTED_INIT { 0 }
52
53 /*
54 - * Make sure that our object store has all the commits necessary to
55 - * connect the ancestry chain to some of our existing refs, and all
56 - * the trees and blobs that these commits use.
54 + * Make sure that all given objects and all objects reachable from them
55 + * either exist in our object store or (if the repository is a partial
56 + * clone) are promised to be available.
57 *
58 * Return 0 if Ok, non zero otherwise (i.e. some missing objects)
59 *