Versions

Version number querying functions, definitions, and macros. More...

Functions
int	sr_package_version_major_get (void)
	Get the major libsigrok package version number. More...
int	sr_package_version_minor_get (void)
	Get the minor libsigrok package version number. More...
int	sr_package_version_micro_get (void)
	Get the micro libsigrok package version number. More...
const char *	sr_package_version_string_get (void)
	Get the libsigrok package version number as a string. More...
int	sr_lib_version_current_get (void)
	Get the "current" part of the libsigrok library version number. More...
int	sr_lib_version_revision_get (void)
	Get the "revision" part of the libsigrok library version number. More...
int	sr_lib_version_age_get (void)
	Get the "age" part of the libsigrok library version number. More...
const char *	sr_lib_version_string_get (void)
	Get the libsigrok library version number as a string. More...
#define	SR_PACKAGE_VERSION_MAJOR   0
	The libsigrok package 'major' version number. More...
#define	SR_PACKAGE_VERSION_MINOR   6
	The libsigrok package 'minor' version number. More...
#define	SR_PACKAGE_VERSION_MICRO   0
	The libsigrok package 'micro' version number. More...
#define	SR_PACKAGE_VERSION_STRING_PREFIX   "0.6.0-git"
	The libsigrok package version ("major.minor.micro") as string. More...
#define	SR_PACKAGE_VERSION_STRING   (SR_PACKAGE_VERSION_STRING_PREFIX SR_PACKAGE_VERSION_STRING_SUFFIX)
	The libsigrok package version with git commit suffix. More...
#define	SR_LIB_VERSION_CURRENT   4
	The libsigrok libtool 'current' version number. More...
#define	SR_LIB_VERSION_REVISION   0
	The libsigrok libtool 'revision' version number. More...
#define	SR_LIB_VERSION_AGE   0
	The libsigrok libtool 'age' version number. More...
#define	SR_LIB_VERSION_STRING   "4:0:0"
	The libsigrok libtool version ("current:revision:age") as string. More...

Detailed Description

Version number querying functions, definitions, and macros.

This set of API calls returns two different version numbers related to libsigrok. The "package version" is the release version number of the libsigrok tarball in the usual "major.minor.micro" format, e.g. "0.1.0".

The "library version" is independent of that; it is the libtool version number in the "current:revision:age" format, e.g. "2:0:0". See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.

Both version numbers (and/or individual components of them) can be retrieved via the API calls at runtime, and/or they can be checked at compile/preprocessor time using the respective macros.

Macro Definition Documentation

#define SR_LIB_VERSION_AGE   0

The libsigrok libtool 'age' version number.

Definition at line 81 of file version.h.

Referenced by sr_lib_version_age_get().

#define SR_LIB_VERSION_CURRENT   4

The libsigrok libtool 'current' version number.

Definition at line 75 of file version.h.

Referenced by sr_lib_version_current_get().

#define SR_LIB_VERSION_REVISION   0

The libsigrok libtool 'revision' version number.

Definition at line 78 of file version.h.

Referenced by sr_lib_version_revision_get().

#define SR_LIB_VERSION_STRING   "4:0:0"

The libsigrok libtool version ("current:revision:age") as string.

Definition at line 84 of file version.h.

Referenced by sr_lib_version_string_get().

#define SR_PACKAGE_VERSION_MAJOR   0

The libsigrok package 'major' version number.

Definition at line 56 of file version.h.

Referenced by sr_package_version_major_get().

#define SR_PACKAGE_VERSION_MICRO   0

The libsigrok package 'micro' version number.

Definition at line 62 of file version.h.

Referenced by sr_package_version_micro_get().

#define SR_PACKAGE_VERSION_MINOR   6

The libsigrok package 'minor' version number.

Definition at line 59 of file version.h.

Referenced by sr_package_version_minor_get().

#define SR_PACKAGE_VERSION_STRING   (SR_PACKAGE_VERSION_STRING_PREFIX SR_PACKAGE_VERSION_STRING_SUFFIX)

The libsigrok package version with git commit suffix.

Definition at line 68 of file version.h.

Referenced by sr_package_version_string_get().

#define SR_PACKAGE_VERSION_STRING_PREFIX   "0.6.0-git"

The libsigrok package version ("major.minor.micro") as string.

Definition at line 65 of file version.h.

Function Documentation

int sr_lib_version_age_get

(

void

)

Get the "age" part of the libsigrok library version number.

Returns

The "age" library version number.

Since

0.1.0

Definition at line 132 of file version.c.

References SR_LIB_VERSION_AGE.

int sr_lib_version_current_get

(

void

)

Get the "current" part of the libsigrok library version number.

Returns

The "current" library version number.

Since

0.1.0

Definition at line 108 of file version.c.

References SR_LIB_VERSION_CURRENT.

int sr_lib_version_revision_get

(

void

)

Get the "revision" part of the libsigrok library version number.

Returns

The "revision" library version number.

Since

0.1.0

Definition at line 120 of file version.c.

References SR_LIB_VERSION_REVISION.

const char* sr_lib_version_string_get

(

void

)

Get the libsigrok library version number as a string.

Returns

The library version number string. The returned string is static and thus should NOT be free'd by the caller.

Since

0.1.0

Definition at line 145 of file version.c.

References SR_LIB_VERSION_STRING.

Referenced by sr_buildinfo_scpi_backends_get().

Here is the caller graph for this function:

int sr_package_version_major_get

(

void

)

Get the major libsigrok package version number.

Returns

The major package version number.

Since

0.1.0

Definition at line 59 of file version.c.

References SR_PACKAGE_VERSION_MAJOR.

int sr_package_version_micro_get

(

void

)

Get the micro libsigrok package version number.

Returns

The micro package version number.

Since

0.1.0

Definition at line 83 of file version.c.

References SR_PACKAGE_VERSION_MICRO.

int sr_package_version_minor_get

(

void

)

Get the minor libsigrok package version number.

Returns

The minor package version number.

Since

0.1.0

Definition at line 71 of file version.c.

References SR_PACKAGE_VERSION_MINOR.

const char* sr_package_version_string_get

(

void

)

Get the libsigrok package version number as a string.

Returns

The package version number string. The returned string is static and thus should NOT be free'd by the caller.

Since

0.1.0

Definition at line 96 of file version.c.

References SR_PACKAGE_VERSION_STRING.

Referenced by sr_buildinfo_scpi_backends_get().

Here is the caller graph for this function: