-
Notifications
You must be signed in to change notification settings - Fork 291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add deprecation notices to functions that will go away in v0.3.0. #798
Conversation
what if you miss any events? why are all these going to be removed? |
How do you miss events? |
a bug (100% bugfree c-toxcore? wow), also what positive things are achieved by removing these functions? |
If toxcore fails to emit the callback, then most likely the value is also not stored inside the tox instance, so the getter doesn't give you anything more. The positive thing is that toxcore no longer needs to keep track of this information that is most likely stored in the client anyway. I'd like to make toxcore itself more "core"-ish, smaller interface, and provide additional functionality through extra libraries. Separation of concerns and all that :). |
Reviewed 2 of 2 files at r1. Comments from Reviewable |
16c8367
to
28c7a36
Compare
Added client maintainers to see if they can accept this change. |
LGTM. |
I agree, it makes the client code of very simple clients a bit more complex. I don't think it'll do much for already complex clients, because they will have found no use in getting e.g. the byte representation of the status message from scratch each time. They will have stored it in their own data structure in a form they can handle nicely (e.g. as UTF-16 string). I'm vaguely planning to pull out a bit of functionality from toxcore and put it in a client helper library for C clients (probably not very useful for other languages). That could store things like that and also be allowed file I/O, which toxcore isn't allowed. |
Reviewed 2 of 2 files at r2. Comments from Reviewable |
toxcore/tox.api.h
Outdated
@@ -443,7 +455,9 @@ static class options { | |||
* @deprecated The memory layout of this struct (size, alignment, and field | |||
* order) is not part of the ABI. To remain compatible, prefer to use $new to | |||
* allocate the object and accessor functions to set the members. The struct | |||
* will become opaque (i.e. the definition will become private) in v0.2.0. | |||
* will become opaque (i.e. the definition will become private) in v0.2.x. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
API/ABI breaking change in v0.2.x
? I thought that our versioning was that of Semantic Versioning but with the leading zero removed. Making such change in a v0.2.x
instead of 0.2.0
or 0.3.0
violates that.
88cbdd4
to
a3dd8e4
Compare
Review status: 0 of 2 files reviewed at latest revision, 1 unresolved discussion. Comments from Reviewable |
Reviewed 2 of 2 files at r3. Comments from Reviewable |
@JFreegman please take a look. I've removed the deprecation notices from all the string valued getters, i.e. things that can be useful to store in the tox state for now. |
Reviewed 2 of 2 files at r4. Comments from Reviewable |
This change is