hwlocality_api_version(3)

hey bestie, welcome to hwlocality_api_version(3) from the Library Functions Manual — the page all about API version, and yes it's short but it's still serving iconic version-check realness. 🦋

🌸 NAME 🌸

hwlocality_api_version — API version. That's the whole name, and we're already slaying. ✨

🌟 SYNOPSIS 🌟

Okay so there are two little groups here: macros and a function. No cap.

🎀 Macros

#define HWLOC_API_VERSION   0x00020c00
#define HWLOC_COMPONENT_ABI   7

🎀 Functions

unsigned hwloc_get_api_version (void)

💖 Detailed Description 💖

This section is literally just a heading in the original — there's no extra prose under it. The actual deets live in the macro and function docs right below, lowkey efficient, highkey iconic. 💅

👑 Macro Definition Documentation 👑

✨ #define HWLOC_API_VERSION 0x00020c00 ✨

Indicate at build time which hwloc API version is being used. This number is updated to (X<<16)+(Y<<8)+Z when a new release X.Y.Z actually modifies the API. 💖

Users may check for available features at build time using this number (see How do I handle API changes?).

Note, bestie: This should not be confused with HWLOC_VERSION, the library version. Two stable releases of the same series usually have the same HWLOC_API_VERSION even if their HWLOC_VERSION are different. Do not mix them up, or the vibe check will fail. 😭

✨ #define HWLOC_COMPONENT_ABI 7 ✨

Current component and plugin ABI version (see hwloc/plugins.h). That's the whole tea. 🍓

🔥 Function Documentation 🔥

🌈 unsigned hwloc_get_api_version (void ) 🌈

Indicate at runtime which hwloc API version was used at build time. Should be HWLOC_API_VERSION if running on the same version.

Returns: the build-time version number. 🫶

🌸 Author 🌸

Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code. So no human author to tag here, bestie — the robots did this one. 🤖

---

Footer sign-off, because we finish what we start: Hardware Locality (hwloc) — Version 2.15.0 — hwlocality_api_version(3). Date: the footer did not include one, so I'm not inventing a date, periodt. 🎀💜