-
Notifications
You must be signed in to change notification settings - Fork 440
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
Versioning doc update #811
Conversation
Codecov Report
@@ Coverage Diff @@
## main #811 +/- ##
=======================================
Coverage 96.19% 96.19%
=======================================
Files 153 153
Lines 6444 6444
=======================================
Hits 6198 6198
Misses 246 246 |
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.
LGTM.
* The API is header only, and uses ABI compliant interfaces. However, ABI stability | ||
is not guaranteed for SDK. | ||
* In case of ABI breaking changes, a new `inline namespace` version will | ||
be introduced, and the existing linked applications can continue using the older version |
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.
Could we give an example here on inline namespace
?
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.
Sorry seems i missed this comment. ABI versioning using inline namespace is handled here in the code:
opentelemetry-cpp/api/include/opentelemetry/version.h
Lines 13 to 14 in 5767f8e
#define OPENTELEMETRY_BEGIN_NAMESPACE \ | |
namespace opentelemetry { inline namespace OPENTELEMETRY_CONCAT(v, OPENTELEMETRY_ABI_VERSION_NO) { |
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.
Yes, I think we could add a reference in the next doc update.
Changes
Please provide a brief description of the changes here.
Update Versioning.md for:
For significant contributions please make sure you have completed the following items:
CHANGELOG.md
updated for non-trivial changes