Skip to content

Add LIBGIT2_VER_CHECK Macro for Version Comparison #6882

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Sep 30, 2024
Merged

Add LIBGIT2_VER_CHECK Macro for Version Comparison #6882

merged 3 commits into from
Sep 30, 2024

Conversation

HamedMasafi
Copy link
Contributor

This merge introduces a LIBGIT2_VERSION_CHECK macro in git2/version.h, similar to Qt's QT_VERSION_CHECK. The macro allows developers to compare the current version of libgit2 at compile time, making it easier to ensure compatibility with specific versions of the library.

Key Changes:

  • Added LIBGIT2_VER_CHECK macro for version comparison.
  • Defined LIBGIT2_VER_NUMBER as a single integer representing the current version.
  • Updated comments to explain the usage of the new macro.

This enhancement will improve the ability to manage version-dependent code more efficiently. Please review the changes and provide feedback!

@ethomson
Copy link
Member

I think that this is generally useful. I'd rather see our version number be human-parseable in a way that reflects the version number. For example:

#define LIBGIT2_VERSION_NUMBER ( \
    (LIBGIT2_VER_MAJOR * 1000000) +
    (LIBGIT2_VER_MINOR * 10000) +
    (LIBGIT2_VER_REVISION * 100) +
     LIBGIT2_VER_PATCH )

so that v1.8.2 is 1080200.

This also lets callers just say

#if LIBGIT2_VERSION_NUMBER >= 1060300

which seems pretty readable to me. But I think that it's worth offering up a macro in case that's not very readable. But I think that I would put it as something that evaluates to truthy given a version number. For example:

#define LIBGIT2_VERSION_CHECK(a,b,c) (LIBGIT2_VERSION_NUMBER >= ((a)*1000000)+((b)*10000)+((c)*100))

Then you'd use it as

#if LIBGIT2_VERSION_CHECK(1,6,3)...

@ethomson
Rename version constants to LIBGIT2_VERSION
50d4920 
For consistency, use LIBGIT2_VERSION_... as the constant name; deprecate
LIBGIT2_VER_... names.
@ethomson
Copy link
Member

Thanks! I updated based on my suggestions.

@ethomson ethomson merged commit 2ba1730 into libgit2:main Sep 30, 2024
19 checks passed
@BrewTestBot BrewTestBot mentioned this pull request Dec 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@HamedMasafi @ethomson