aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gawk.texi
diff options
context:
space:
mode:
authorAndrew J. Schorr <aschorr@telemetry-investments.com>2016-05-03 09:46:35 -0400
committerAndrew J. Schorr <aschorr@telemetry-investments.com>2016-05-03 09:46:35 -0400
commitffb353c999bd3d5785b92a3aad78a96ff03a4ced (patch)
treea83b8a673d1529debe46bfb098355505b5595b32 /doc/gawk.texi
parent78169694440b5258ddb20c4d1fe0eb445a479e1f (diff)
downloadegawk-ffb353c999bd3d5785b92a3aad78a96ff03a4ced.tar.gz
egawk-ffb353c999bd3d5785b92a3aad78a96ff03a4ced.tar.bz2
egawk-ffb353c999bd3d5785b92a3aad78a96ff03a4ced.zip
Add CPP #defines for gawk_api_major_version and gawk_api_minor_version.
Diffstat (limited to 'doc/gawk.texi')
-rw-r--r--doc/gawk.texi21
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/gawk.texi b/doc/gawk.texi
index d1b085f0..5864346c 100644
--- a/doc/gawk.texi
+++ b/doc/gawk.texi
@@ -33526,15 +33526,18 @@ information about how @command{gawk} was invoked.
@cindex extension API version
The API provides both a ``major'' and a ``minor'' version number.
-The API versions are available at compile time as constants:
-
-@table @code
-@item GAWK_API_MAJOR_VERSION
-The major version of the API
-
-@item GAWK_API_MINOR_VERSION
-The minor version of the API
-@end table
+The API versions are available at compile time as C preprocessor defines
+to support conditional compilation, and as enum constants to facilitate
+debugging:
+
+@float Table,gawk-api-version
+@caption{gawk API version constants}
+@multitable @columnfractions .33 .33 .33
+@headitem API Version @tab C preprocessor define @tab enum constant
+@item Major @tab gawk_api_major_version @tab GAWK_API_MAJOR_VERSION
+@item Minor @tab gawk_api_minor_version @tab GAWK_API_MINOR_VERSION
+@end multitable
+@end float
The minor version increases when new functions are added to the API. Such
new functions are always added to the end of the API @code{struct}.