summaryrefslogtreecommitdiff
path: root/include/git2/remote.h
diff options
context:
space:
mode:
authorVicent Marti <vicent@github.com>2014-05-16 11:56:37 +0200
committerVicent Marti <vicent@github.com>2014-05-16 11:56:37 +0200
commit228272ef5828e1e6d42f48acad3a557b340ddc90 (patch)
treef47299f1f56364f77063a33b70d5549dc9a14bb2 /include/git2/remote.h
parent8e1b5a8dc650c25e818ab7337833bd4d0d45a46e (diff)
parentec8a949a58864272860a4838c6b3d862beda7076 (diff)
downloadlibgit2-228272ef5828e1e6d42f48acad3a557b340ddc90.tar.gz
Merge pull request #2313 from libgit2/cmn/remote-delete
Remote deletion
Diffstat (limited to 'include/git2/remote.h')
-rw-r--r--include/git2/remote.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h
index 3633501e2..07cd2e7c6 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -610,6 +610,19 @@ GIT_EXTERN(void) git_remote_set_update_fetchhead(git_remote *remote, int value);
*/
GIT_EXTERN(int) git_remote_is_valid_name(const char *remote_name);
+/**
+* Delete an existing persisted remote.
+*
+* All remote-tracking branches and configuration settings
+* for the remote will be removed.
+*
+* once deleted, the passed remote object will be freed and invalidated.
+*
+* @param remote A valid remote
+* @return 0 on success, or an error code.
+*/
+GIT_EXTERN(int) git_remote_delete(git_remote *remote);
+
/** @} */
GIT_END_DECL
#endif