Merge pull request #3048 from pks-t/insteadof

Implementation of url.*.insteadOf

1 files changed, 6 insertions, 0 deletions

diff --git a/include/git2/remote.h b/include/git2/remote.h
index 02d73a0e6..ccd0b43f4 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -120,6 +120,9 @@ GIT_EXTERN(const char *) git_remote_name(const git_remote *remote);
 /**
  * Get the remote's url
  *
+ * If url.*.insteadOf has been configured for this URL, it will
+ * return the modified URL.
+ *
  * @param remote the remote
  * @return a pointer to the url
  */
@@ -128,6 +131,9 @@ GIT_EXTERN(const char *) git_remote_url(const git_remote *remote);
 /**
  * Get the remote's url for pushing
  *
+ * If url.*.pushInsteadOf has been configured for this URL, it
+ * will return the modified URL.
+ *
  * @param remote the remote
  * @return a pointer to the url or NULL if no special url for pushing is set
  */