Skip to content

[irods/irods#8605] Document Consortium's stance on API and ABI stability (main) - #388

Merged
korydraughn merged 1 commit into
irods:mainfrom
korydraughn:8605.m
Aug 28, 2026
Merged

[irods/irods#8605] Document Consortium's stance on API and ABI stability (main)#388
korydraughn merged 1 commit into
irods:mainfrom
korydraughn:8605.m

Conversation

@korydraughn

Copy link
Copy Markdown
Collaborator

Here's a screenshot of the rendered documentation.

image

And here's what the navigation menu looks like. Tried to remove the button to the left of the section title, but failed. Also didn't spend a lot of time on that part.

image

@alanking alanking left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

My only hesitation is whether this needs its own dedicated page. I'm wondering whether there's a more general space we can use or create. Maybe a slightly more general "Version Compatibility" page or something like that? It feels like it's very limited in its scope for what could go in here in the future. All that being said, I'm fine with things as they are as well.

@korydraughn

Copy link
Copy Markdown
Collaborator Author

That crossed my mind as well. If you see an alternative place to put it, let me know.

Given your recent issue about char* and const char*, I'm now starting to reconsider whether ABI stability should be a thing we maintain. It can be hard to do which is why I've tried to avoid it.

@trel

trel commented Sep 10, 2025

Copy link
Copy Markdown
Member

agreed - let's hold on this for a little bit and think through what we DO want to say... as well as whether there is a more general place for it than its own page.

@korydraughn

Copy link
Copy Markdown
Collaborator Author

This PR needs to cover irods/irods#8310.

Moving forward, we need to limit changes to packing instructions to major releases. That helps in maintaining API stability.

@korydraughn

Copy link
Copy Markdown
Collaborator Author

Previous/Latest Notes:

  • Minor releases maintain API compabitlity
  • Patch releases strive for ABI compatibility

@korydraughn

Copy link
Copy Markdown
Collaborator Author

Updated wording and moved it to the contributing page of the developers section.

@korydraughn

Copy link
Copy Markdown
Collaborator Author

The rendered text.

image

@trel trel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like it.

Comment thread docs/developers/contributing.md Outdated
@trel

trel commented Aug 28, 2026

Copy link
Copy Markdown
Member

squash em

@korydraughn

Copy link
Copy Markdown
Collaborator Author

Squashed.

@trel trel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pound it

@korydraughn

Copy link
Copy Markdown
Collaborator Author

Added pound.

Merging.

@korydraughn
korydraughn merged commit 3dc2cb2 into irods:main Aug 28, 2026
2 checks passed
@korydraughn
korydraughn deleted the 8605.m branch August 28, 2026 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants