Andrew Kesterson
95e5002512
project() now carries VERSION 0.1.0, and is the single place a version number is spelled. It flows into generated version macros, the shared library's VERSION/SOVERSION, the Version: field in akstdlib.pc, and a new akstdlibConfigVersion.cmake. Before this @PROJECT_VERSION@ expanded to nothing, so akstdlib.pc shipped an empty Version: and libakstdlib.so carried no soname at all. 0.x on purpose: TODO.md section 2.1 still records four confirmed defects whose fixes change documented behaviour, so the API is not being promised yet. While the major version is 0 the soname carries MAJOR.MINOR -- 0.1 and 0.2 are different ABIs -- and becomes MAJOR alone at 1.0. The if() in CMakeLists.txt and the #if in tests/test_version.c encode that rule and are tested against each other. include/akstdlib_version.h.in is configured into the build tree as akstdlib_version.h and installed beside akstdlib.h. It defines AKSL_VERSION_MAJOR/MINOR/PATCH/STRING/NUMBER and AKSL_VERSION_SONAME. AKSL_VERSION_NUMBER is computed rather than written as a literal, because a literal 000100 is octal in C and would make 0.1.0 compare as 64; test_version.c asserts it against the runtime components, so a rewrite to a literal fails. Those macros record what a caller was compiled against. aksl_version(), aksl_version_string() and aksl_version_soname() report what actually loaded, and AKSL_VERSION_CHECK() compares the two, raising AKERR_VALUE naming both. It is a macro so that it expands at the caller's site and captures the caller's numbers; the function compares them against the ones baked into the library. Compatibility is "same soname", so patch is ignored -- a caller built against 0.1.0 keeps working against 0.1.7. Normally the soname catches a mismatch at load time and the check never fires. It earns its keep when the soname is bypassed: a 0.2.0 build dropped in under the 0.1 filename loads happily, and only the check notices. write_basic_package_version_file() uses SameMinorVersion to mirror the soname, falling back to ExactVersion below CMake 3.11 where that mode does not exist. The fallback is stricter than the soname rule -- it pins the patch level too -- but never laxer, and wrongly refusing a good pairing beats wrongly accepting a bad one. Coverage of src/stdlib.c rose to 99.1% of lines (217/219), 45.1% of branches and 25/25 functions. That puts branch coverage back over the old 45 gate, but the gate stays at 40: 0.1 points of headroom is not a ratchet. ctest 14/14, ASan+UBSan 14/14, coverage 16/16 at 90/40. Also verified out of tree: SONAME libakstdlib.so.0.1 recorded in consumers, pkg-config --modversion reporting 0.1.0, find_package(akstdlib 0.1) accepted with 0.2 and 1.0 refused, a patch-bumped 0.1.1 loading and passing the check, a 0.2.0 dropped in under the 0.1 filename caught by it, and an embedded add_subdirectory build keeping its own version rather than the parent's. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
38 lines
1.6 KiB
C
38 lines
1.6 KiB
C
#ifndef _AKSTDLIB_VERSION_H_
|
|
#define _AKSTDLIB_VERSION_H_
|
|
|
|
/*
|
|
* GENERATED FILE -- do not edit.
|
|
*
|
|
* Configured from include/akstdlib_version.h.in by CMake. The version itself
|
|
* lives in exactly one place, the project() call in CMakeLists.txt, and flows
|
|
* from there into these macros, the shared library's SOVERSION, the Version:
|
|
* field in akstdlib.pc, and akstdlibConfigVersion.cmake. To bump the version,
|
|
* edit project(); to change what the macros look like, edit this template.
|
|
*/
|
|
|
|
#define AKSL_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
|
|
#define AKSL_VERSION_MINOR @PROJECT_VERSION_MINOR@
|
|
#define AKSL_VERSION_PATCH @PROJECT_VERSION_PATCH@
|
|
#define AKSL_VERSION_STRING "@PROJECT_VERSION@"
|
|
|
|
/*
|
|
* A single ordered integer, for `#if AKSL_VERSION_NUMBER >= ...` compares.
|
|
* Computed rather than written out as a literal on purpose: a literal like
|
|
* 000100 is octal in C, which would silently make version 0.1.0 compare as 64.
|
|
* Each component gets two decimal digits, so this is correct up to x.99.99.
|
|
*/
|
|
#define AKSL_VERSION_NUMBER \
|
|
((AKSL_VERSION_MAJOR * 10000) + (AKSL_VERSION_MINOR * 100) + AKSL_VERSION_PATCH)
|
|
|
|
/*
|
|
* The soname of the library these headers describe -- "0.1" for libakstdlib.so.0.1.
|
|
* This is the granularity at which the ABI is allowed to break, and it is what
|
|
* aksl_version_check() compares: pre-1.0 a minor bump is a break, so the soname
|
|
* carries MAJOR.MINOR. From 1.0 it becomes MAJOR alone, and the SOVERSION
|
|
* expression in CMakeLists.txt and this macro change together.
|
|
*/
|
|
#define AKSL_VERSION_SONAME "@AKSL_SOVERSION@"
|
|
|
|
#endif // _AKSTDLIB_VERSION_H_
|