-
Notifications
You must be signed in to change notification settings - Fork 13.6k
[Docs] Explicitly document libclang ABI and API stability #141657
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
Open
AaronBallman
wants to merge
4
commits into
llvm:main
Choose a base branch
from
AaronBallman:aballman-libclang-stability-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c7a4199
[Docs] Explicitly document libclang ABI and API stability
AaronBallman b183361
Update some typos found during code review
AaronBallman af20153
Minor grammar fix
AaronBallman 9e6c1d1
Make it more clear the list is not exhaustive, talk about bug fixes
AaronBallman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Thank you for reminding me of the discussion we had sometime last year. We can write this down, but I'm not sure how good we are at enforcing this, because stable libclang API is implemented on top of unstable C++ API.
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.
I think bug fixes to Clang internals are always fair game for us and something libclang folks will have to react to, which is why it's important to disallow multiple versions of the library from interacting. But fixes to libclang itself is something I think we can be more judicious about. e.g., adding a forgotten enumerator really shouldn't be a problem. Renaming one we don't like the name for is more disruptive and something we'd likely avoid doing.
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.
Should we say that while API and ABI are stable, domain-specific behavior of exposed functions is explicitly unstable? In other words, Clang 21 is not going to pretend that it's Clang 3.x, and users will see it via their cursors and whatnot.