submodule: explain first attempt failure clearly

diff --git a/submodule.c b/submodule.c
index 934ecfa2943bcb5ee87e7ac431b5332a5f3adcde..b6f6fa72d739c068819dfa18ea97f64761f46733 100644 (file)
--- a/submodule.c
+++ b/submodule.c
@@ -1544,6 +1544,13 @@ static int fetch_finish(int retvalue, struct strbuf *err,
        struct oid_array *commits;
 
        if (retvalue)
+               /*
+                * NEEDSWORK: This indicates that the overall fetch
+                * failed, even though there may be a subsequent fetch
+                * by commit hash that might work. It may be a good
+                * idea to not indicate failure in this case, and only
+                * indicate failure if the subsequent fetch fails.
+                */
                spf->result = 1;
 
        if (!task || !task->sub)