oneTBB icon indicating copy to clipboard operation
oneTBB copied to clipboard

Added abi table to VERSIONING.md

Open vossmjp opened this issue 3 months ago • 3 comments

Description

Added a table to VERSIONING.md to track abi changes by release.

Fixes # - issue number(s) if exists

Type of change

Choose one or multiple, leave empty if none of the other choices apply

Add a respective label(s) to PR if you have permissions

  • [ ] bug fix - change that fixes an issue
  • [ ] new feature - change that adds functionality
  • [ ] tests - change in tests
  • [ ] infrastructure - change in infrastructure and CI
  • [ ] documentation - documentation update

Tests

  • [ ] added - required for new features and some bug fixes
  • [ ] not needed

Documentation

  • [ ] updated in # - add PR number
  • [ ] needs to be updated
  • [ ] not needed

Breaks backward compatibility

  • [ ] Yes
  • [ ] No
  • [ ] Unknown

Notify the following users

List users with @ to send notifications

Other information

vossmjp avatar Oct 03 '25 16:10 vossmjp

It would be cool if you guys added some sort of ABI check like we do in oneDAL such that the VERSIONING.md must be modified upon ABI changes.

icfaust avatar Oct 04 '25 21:10 icfaust

@icfaust That's a good idea, we'll look into that.

vossmjp avatar Oct 06 '25 19:10 vossmjp

I suggest rewriting it using different format. How about the list of lists?

Markdown is knowingly bad for tables, except simplest ones. But the list of lists would be almost like the regular changelog, just for a subset of changes.

I would suggest moving the table out of Versioning.md into a separate file, perhaps in RST. Another option is to make an "embedded" HTML table.

akukanov avatar Oct 08 '25 10:10 akukanov