Commit 53d13fb3e839a677da0a044bedb0c9d4002d7a4a
2019-01-23T09:42:55
deprecation: deprecated stream registration in if guard `git_stream_register_tls` is now deprecated; mark it in an if guard with the deprecation. This should not be included in `deprecated.h` since it is an uncommonly used `sys` header file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
diff --git a/include/git2/sys/stream.h b/include/git2/sys/stream.h
index 255c93e..6f93cc4 100644
--- a/include/git2/sys/stream.h
+++ b/include/git2/sys/stream.h
@@ -98,13 +98,16 @@ typedef enum {
GIT_EXTERN(int) git_stream_register(
git_stream_t type, git_stream_registration *registration);
+#ifndef GIT_DEPRECATE_HARD
+
/** @name Deprecated TLS Stream Registration Functions
*
- * These typedefs and functions are retained for backward compatibility.
- * The newer versions of these functions and structures should be preferred
- * in all new code.
+ * These functions are retained for backward compatibility. The newer
+ * versions of these values should be preferred in all new code.
+ *
+ * There is no plan to remove these backward compatibility values at
+ * this time.
*/
-
/**@{*/
/**
@@ -115,14 +118,20 @@ typedef int GIT_CALLBACK(git_stream_cb)(git_stream **out, const char *host, cons
/**
* Register a TLS stream constructor for the library to use. This stream
- * will not support HTTP CONNECT proxies.
+ * will not support HTTP CONNECT proxies. This internally calls
+ * `git_stream_register` and is preserved for backward compatibility.
+ *
+ * This function is deprecated, but there is no plan to remove this
+ * function at this time.
*
* @deprecated Provide a git_stream_registration to git_stream_register
* @see git_stream_register
*/
GIT_EXTERN(int) git_stream_register_tls(git_stream_cb ctor);
- /**@}*/
+/**@}*/
+
+#endif
GIT_END_DECL