remote: deprecate git_remote_is_valid_name

2 files changed, 21 insertions, 8 deletions

diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h
index e24d057f4..4e43c4536 100644
--- a/include/git2/deprecated.h
+++ b/include/git2/deprecated.h
@@ -340,6 +340,27 @@ GIT_EXTERN(size_t) git_object__size(git_object_t type);
 
 /**@}*/
 
+/** @name Deprecated Remote Functions
+ *
+ * These functions are retained for backward compatibility.  The newer
+ * versions of these functions should be preferred in all new code.
+ *
+ * There is no plan to remove these backward compatibility functions at
+ * this time.
+ */
+/**@{*/
+
+/**
+ * Ensure the remote name is well-formed.
+ *
+ * @deprecated Use git_remote_name_is_valid
+ * @param remote_name name to be checked.
+ * @return 1 if the reference name is acceptable; 0 if it isn't
+ */
+GIT_EXTERN(int) git_remote_is_valid_name(const char *remote_name);
+
+/**@}*/
+
 /** @name Deprecated Reference Functions and Constants
  *
  * These functions and enumeration values are retained for backward
diff --git a/include/git2/remote.h b/include/git2/remote.h
index fa0345eb5..b82bd250b 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -922,14 +922,6 @@ GIT_EXTERN(int) git_remote_rename(
 int git_remote_name_is_valid(int *valid, const char *remote_name);
 
 /**
- * Ensure the remote name is well-formed.
- *
- * @param remote_name name to be checked.
- * @return 1 if the reference name is acceptable; 0 if it isn't
- */
-GIT_EXTERN(int) git_remote_is_valid_name(const char *remote_name);
-
-/**
 * Delete an existing persisted remote.
 *
 * All remote-tracking branches and configuration settings