Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_api_version.3

raw
1 .TH "hwlocality_api_version" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_api_version \- API version
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Macros"
10
11 .in +1c
12 .ti -1c
13 .RI "#define \fBHWLOC_API_VERSION\fP 0x00020c00"
14 .br
15 .ti -1c
16 .RI "#define \fBHWLOC_COMPONENT_ABI\fP 7"
17 .br
18 .in -1c
19 .SS "Functions"
20
21 .in +1c
22 .ti -1c
23 .RI "unsigned \fBhwloc_get_api_version\fP (void)"
24 .br
25 .in -1c
26 .SH "Detailed Description"
27 .PP
28
29 .SH "Macro Definition Documentation"
30 .PP
31 .SS "#define HWLOC_API_VERSION 0x00020c00"
32
33 .PP
34 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\&.
35
36 .PP
37 Users may check for available features at build time using this number (see \fBHow do I handle API changes?\fP)\&.
38
39 .PP
40 \fBNote\fP
41 .RS 4
42 This should not be confused with HWLOC_VERSION, the library version\&. Two stable releases of the same series usually have the same \fBHWLOC_API_VERSION\fP even if their HWLOC_VERSION are different\&.
43 .RE
44 .PP
45
46 .SS "#define HWLOC_COMPONENT_ABI 7"
47
48 .PP
49 Current component and plugin ABI version (see \fBhwloc/plugins\&.h\fP)\&.
50 .SH "Function Documentation"
51 .PP
52 .SS "unsigned hwloc_get_api_version (void )"
53
54 .PP
55 Indicate at runtime which hwloc API version was used at build time\&. Should be \fBHWLOC_API_VERSION\fP if running on the same version\&.
56
57 .PP
58 \fBReturns\fP
59 .RS 4
60 the build-time version number\&.
61 .RE
62 .PP
63
64 .SH "Author"
65 .PP
66 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.