Add warning about known issues to documentation of cvsimport

diff --git a/remote.h b/remote.h
index 9605da9e1680880218f7939eac50030bb8d252bc..de3d21b6626f64ffc54904eec6f26a614feab30a 100644 (file)
--- a/remote.h
+++ b/remote.h
@@ -140,12 +140,13 @@ int format_tracking_info(struct branch *branch, struct strbuf *sb);
 
 struct ref *get_local_heads(void);
 /*
- * Look in refs for HEAD. Then look for a matching SHA1 in mapped_refs,
- * first checking if refs/heads/master matches. Return NULL if nothing matches
- * or if there is no HEAD in refs. remote_head_p is assigned HEAD if not NULL.
+ * Find refs from a list which are likely to be pointed to by the given HEAD
+ * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
+ * list of all candidate refs. If no match is found (or 'head' is NULL),
+ * returns NULL. All returns are newly allocated and should be freed.
  */
-const struct ref *guess_remote_head(const struct ref *refs,
-                                   const struct ref *mapped_refs,
-                                   const struct ref **remote_head_p);
+struct ref *guess_remote_head(const struct ref *head,
+                             const struct ref *refs,
+                             int all);
 
 #endif