diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2019-01-23 09:42:55 +0000 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2019-01-25 09:06:50 +0000 |
| commit | 53d13fb3e839a677da0a044bedb0c9d4002d7a4a (patch) | |
| tree | 466472a9490a2c9ee21e66462b7ad0c23f228178 | |
| parent | 769e92749be45ee4a7bf82ef56266680a881027c (diff) | |
| download | libgit2-53d13fb3e839a677da0a044bedb0c9d4002d7a4a.tar.gz | |
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.
| -rw-r--r-- | include/git2/sys/stream.h | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/include/git2/sys/stream.h b/include/git2/sys/stream.h index 255c93e2b..6f93cc48c 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 |