diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-08-03 14:35:52 +0000 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-08-03 14:35:52 +0000 |
commit | f11e6e56f79b63e0f3c45e8e5f579024ce91f617 (patch) | |
tree | c3468fdb76785bf11a6d51ced137343a535aea99 /doc | |
parent | e9a6906ae6fdd463a41feceacc33d88723b9c07a (diff) | |
download | gdbm-f11e6e56f79b63e0f3c45e8e5f579024ce91f617.tar.gz gdbm-f11e6e56f79b63e0f3c45e8e5f579024ce91f617.tar.bz2 |
Document gdbm_version_number and GDBM_VERSION_* macros.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gdbm.texinfo | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/doc/gdbm.texinfo b/doc/gdbm.texinfo index 6211f67..bfb967e 100644 --- a/doc/gdbm.texinfo +++ b/doc/gdbm.texinfo @@ -1083,7 +1083,7 @@ Display program version and licensing information, and exit. @node Variables @chapter Useful global variables. -The following two variables are variables that may need to be used: +The following global variables and constants are available: @deftypevar gdbm_error gdbm_errno This variable contains error code from the last failed @code{gdbm} @@ -1098,6 +1098,36 @@ descriptive text. A string containing the version information. @end deftypevar +@deftypevar int const gdbm_version_number[3] +This variable contains the @code{gdbm} version numbers: + +@multitable @columnfractions 0.4 0.5 +@headitem Index @tab Meaning +@item 0 @tab Major number +@item 1 @tab Minor number +@item 2 @tab Patchlevel number +@end multitable + +Additionally, the following constants are defined in the @file{gdbm.h} +file: + +@table @asis +@kwindex GDBM_VERSION_MAJOR +@item GDBM_VERSION_MAJOR +Major number. + +@kwindex GDBM_VERSION_MINOR +@item GDBM_VERSION_MINOR +Minor number. + +@kwindex GDBM_VERSION_PATCH +@item GDBM_VERSION_PATCH +Patchlevel number. +@end table + +These can be used to verify whether the header file matches the library. +@end deftypevar + @deftypevar const char * const gdbm_errlist[] This variable is an array of error descriptions, which is used by @code{gdbm_strerror} to convert error codes to human-readable text |