From: Alan T. DeKok <aland@freeradius.org>
Date: Thu, 24 Apr 2025 11:22:04 +0000 (-0400)
Subject: define RADIUSD_DOC_VERSION
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d0e5374328769d6bcb4374594e804f48bc37b4af;p=thirdparty%2Ffreeradius-server.git

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 a85de88750..e00a9f8c9a 100644
--- 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 53afe4fff3..9e63d05d10 100755
--- 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 141c3c7151..59cb20b72b 100644
--- 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 92de79b6f5..0cfaf57cff 100644
--- 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.
  */