summaryrefslogtreecommitdiff
path: root/include/git2/remote.h
diff options
context:
space:
mode:
authorBen Straub <bs@github.com>2012-12-20 15:50:33 -0800
committerBen Straub <bs@github.com>2012-12-20 15:50:33 -0800
commit87bc689fbf571aa3cbc77e510f14304cc3502ca5 (patch)
treef529ed410f72a1ccc8205e0fd473ca75ee3ce0af /include/git2/remote.h
parent874dcb25eba8637ed6d2a070741dd0363e30d83d (diff)
downloadlibgit2-87bc689fbf571aa3cbc77e510f14304cc3502ca5.tar.gz
git_remote_create calls git_remote_save
Diffstat (limited to 'include/git2/remote.h')
-rw-r--r--include/git2/remote.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h
index e77deaf93..aa3f93c7b 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -34,7 +34,8 @@ typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, voi
*/
/**
- * Add a remote with the default fetch refspec to the repository's configuration
+ * Add a remote with the default fetch refspec to the repository's configuration. This
+ * calls git_remote_save before returning.
*
* @param out the resulting remote
* @param repo the repository in which to create the remote
@@ -52,7 +53,8 @@ GIT_EXTERN(int) git_remote_create(
* Create a remote in memory
*
* Create a remote with the given refspec in memory. You can use
- * this when you have a URL instead of a remote's name.
+ * this when you have a URL instead of a remote's name. Note that in-memory
+ * remotes cannot be converted to persisted remotes.
*
* The name, when provided, will be checked for validity.
* See `git_tag_create()` for rules about valid names.