define RADIUSD_DOC_VERSION

so that any messages in the code can point to the correct
(and specific) revision of the online Antora documentation

and define macros to point to the online docs

diff --git a/Make.inc.in b/Make.inc.in
index a85de88750a294d4d782dee81bc848e4e7623749..e00a9f8c9af2320df2fe7ce95ae3005d22a2a7cf 100644 (file)
--- a/Make.inc.in
+++ b/Make.inc.in
@@ -155,6 +155,7 @@ RADIUSD_VERSION_MAJOR = @RADIUSD_VERSION_MAJOR@
 RADIUSD_VERSION_MINOR = @RADIUSD_VERSION_MINOR@
 RADIUSD_VERSION_INCRM = @RADIUSD_VERSION_INCRM@
 RADIUSD_VERSION_COMMIT = @RADIUSD_VERSION_COMMIT@
+RADIUSD_DOC_VERSION = @RADIUSD_DOC_VERSION@
 
 #
 #  This allows dlopen to do runtime checks for version mismatches

diff --git a/configure b/configure
index 53afe4fff3e9d6b074e2016a0c3868002ddd9c94..9e63d05d10b2cd04e92f3bb96ece3c0f355f70ff 100755 (executable)
--- a/configure
+++ b/configure
@@ -727,6 +727,7 @@ PANDOC_ENGINE
 PANDOC
 ASCIIDOCTOR
 GIT
+RADIUSD_DOC_VERSION
 RADIUSD_VERSION_INCRM
 RADIUSD_VERSION_MINOR
 RADIUSD_VERSION_MAJOR
@@ -2849,6 +2850,7 @@ ac_config_headers="$ac_config_headers src/include/autoconf.h"
 RADIUSD_VERSION_MAJOR=`./version.sh major`
 RADIUSD_VERSION_MINOR=`./version.sh minor`
 RADIUSD_VERSION_INCRM=`./version.sh commit_depth`
+RADIUSD_DOC_VERSION=`grep version doc/antora/antora.yml | sed "s/version: '//;s/'//"`
 
 if test "x$RADIUSD_VERSION_INCRM" = "x"; then
        RADIUSD_VERSION_INCRM=`./version.sh incrm`
@@ -2876,6 +2878,11 @@ printf "%s\n" "#define RADIUSD_VERSION_MINOR ${RADIUSD_VERSION_MINOR}" >>confdef
 printf "%s\n" "#define RADIUSD_VERSION_INCRM ${RADIUSD_VERSION_INCRM}" >>confdefs.h
 
 
+printf "%s\n" "#define RADIUSD_DOC_VERSION ${RADIUSD_DOC_VERSION}" >>confdefs.h
+
+
+
+
 
 
 

diff --git a/configure.ac b/configure.ac
index 141c3c7151c11100577fb7a9de03afed3f4f7772..59cb20b72bb505cfb7aa5c565d305dcbee3a051a 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -39,6 +39,7 @@ dnl #############################################################
 RADIUSD_VERSION_MAJOR=`./version.sh major`
 RADIUSD_VERSION_MINOR=`./version.sh minor`
 RADIUSD_VERSION_INCRM=`./version.sh commit_depth`
+RADIUSD_DOC_VERSION=`grep version doc/antora/antora.yml | sed "s/version: '//;s/'//"`
 
 dnl #  To handle tarballs and GitHub downloads, we can also put the incremental
 dnl #  patch number in VERSION, or it gets set to FFFF.
@@ -61,11 +62,14 @@ AC_DEFINE_UNQUOTED([RADIUSD_VERSION], [${RADIUSD_VERSION}], [Version integer in
 AC_DEFINE_UNQUOTED([RADIUSD_VERSION_MAJOR], [${RADIUSD_VERSION_MAJOR}], [Version integer in format <ma>])
 AC_DEFINE_UNQUOTED([RADIUSD_VERSION_MINOR], [${RADIUSD_VERSION_MINOR}], [Version integer in format <mi>])
 AC_DEFINE_UNQUOTED([RADIUSD_VERSION_INCRM], [${RADIUSD_VERSION_INCRM}], [Version integer in format <in>])
+AC_DEFINE_UNQUOTED([RADIUSD_DOC_VERSION], [${RADIUSD_DOC_VERSION}], [Version string used in the online documentation])
 
 AC_SUBST(RADIUSD_VERSION)
 AC_SUBST(RADIUSD_VERSION_MAJOR)
 AC_SUBST(RADIUSD_VERSION_MINOR)
 AC_SUBST(RADIUSD_VERSION_INCRM)
+AC_SUBST(RADIUSD_DOC_VERSION)
+
 
 dnl #############################################################
 dnl #

diff --git a/src/lib/util/version.h b/src/lib/util/version.h
index 92de79b6f5a7889a903620685149d3886bef034e..0cfaf57cfffe232b38977bc84d3a044dec8ac087 100644 (file)
--- a/src/lib/util/version.h
+++ b/src/lib/util/version.h
@@ -84,6 +84,10 @@ extern "C" {
 #  define MAGIC_COMMIT(_x)     ((uint32_t)((0x00000000ffffffff & (_x))))
 #endif
 
+#define DOC_ROOT_URL "https://www.freeradius.org/documentation/freeradius-server/" STRINGIFY(RADIUSD_DOC_VERSION)
+#define DOC_KEYWORD_URL(_x) DOC_ROOT_URL "/" STRINGIFY(_x) ".html"
+#define DOC_KEYWORD_REF(_x) "For more information, please see " DOC_KEYWORD_URL(_x)
+
 /*
  *     Version check.
  */