Abi versioning #91
Abi versioning #91
Conversation
| # Increment ABI version for any ABI-breaking change. | ||
| # | ||
| # Also, whenever the ABI is between versions and in development | ||
| # suffix the ABI version number with "_unstable". |
There was a problem hiding this comment.
Might be worth adding this comment to some sort of release documentation. Jaeger repos usually have a RELEASE.md for this type of thing.
There was a problem hiding this comment.
Sounds good. I'll add a RELEASE.md.
test/multiple_tracer_link_test.cpp
Outdated
| @@ -0,0 +1,3 @@ | |||
| // Contains nothing, but links in tracer_a.o and tracer_b.o to verify that | |||
| // there's no multiple definition error from OpenTracingMakeTracerFactory. | |||
There was a problem hiding this comment.
I wonder if this is guaranteed to cause a compilation error. Might be worth using the function pointer for some trivial operation to ensure the symbol isn't discarded during linking.
|
|
||
| return 0; | ||
| } catch (const std::bad_alloc&) { |
There was a problem hiding this comment.
Out of curiosity, why'd you change to try/catch? If you expect other types of exception, make sure to catch std::exception or catch (...).
There was a problem hiding this comment.
I added the try/catch because it assigns to the string error_message, which can allocate memory. std::bad_alloc should be the only exception that could be thrown.
Sets up conventions for versioning the ABI to allow for less strict checking when dynamically loading tracers.
OpenTracingMakeTracerFactoryfunction prototype to take an ABI version in addition to an API version.OpenTracingMakeTracerFactoryshould fail only if the ABI version is different. (The API version is still passed in case there's ever some sort of change that breaks semantic compatibility).I also plan to put in an additional PR with some CI coverage that will help to detect ABI breakage.
Fixes #81