Changeset 90022 in vbox for trunk/include

Timestamp:

Jul 5, 2021 11:25:25 AM (4 years ago)

Author:

vboxsync

Message:

iprt/linux/version.h: Doxygen fixes for ubuntu abi macros, fixed incorrect RTLNX_UBUNTU_ABI_RANGE parameter list for non-ubuntu kernels. bugref:10007

File:

• trunk/include/iprt/linux/version.h (modified) (4 diffs)

trunk/include/iprt/linux/version.h

@@ -125 +125 @@
 
 
-#if defined(UTS_UBUNTU_RELEASE_ABI)
-/* Ubuntu kernel ABI version is represented as a constant which can be interpreted
- * by compiler as an octal constant (e.g. 050818). We add '0x' prefix to it in
- * order to be able to treat it as a hexadecimal number. */
+#if defined(UTS_UBUNTU_RELEASE_ABI) || defined(DOXYGEN_RUNNING)
+
+/** Hack to make the UTS_UBUNTU_RELEASE_ABI palatable by the C preprocesor.
+ *
+ * While the Ubuntu kernel ABI version looks like a decimal number, some
+ * kernels has a leading zero (e.g. 050818) that makes the preprocessor think
+ * it's an octal number.  To work around that, we turn it into an hexadecimal
+ * number by prefixing it with '0x'. */
 # define RTLNX_UBUNTU_ABI(a_iAbi)   (RT_CONCAT(0x,a_iAbi))
 
 /** @def RTLNX_UBUNTU_ABI_MIN
- * Require Ubuntu release to be equal or newer than specified version.
- * Kernel version should exactly match to specified @a_iMajor, @a_iMinor
- * and @a_iPatch. Number @a_iAbi should be equal or greater than current
- * ABI version.
+ * Require Ubuntu release ABI to be equal or newer than specified version.
+ *
+ * The kernel version should exactly match the specified @a a_iMajor, @a
+ * a_iMinor and @a a_iPatch.  The @a a_iAbi number should be equal to or greater
+ * than the current ABI version.
  *
  * @param a_iMajor      The major kernel version number.
  * @param a_iMinor      The minor kernel version number.
- * @param a_iPatch      The micro kernel version number.
- * @param a_iAbi        Ubuntu kernel ABI version number.
+ * @param a_iPatch      The kernel patch level.
+ * @param a_iAbi        Ubuntu kernel ABI version number (inclusive).
  */
 # define RTLNX_UBUNTU_ABI_MIN(a_iMajor, a_iMinor, a_iPatch, a_iAbi) \
@@ -147 +152 @@
 
 /** @def RTLNX_UBUNTU_ABI_MAX
- * Require Ubuntu release to be older than specified version.
- * Kernel version should exactly match to specified @a_iMajor, @a_iMinor
- * and @a_iPatch. Number @a_iAbi should be less than current ABI version.
+ * Require Ubuntu release ABI to be older than specified version.
+ *
+ * The kernel version should exactly match the specified @a_iMajor, @a_iMinor
+ * and @a a_iPatch. Number @a a_iAbi should be less than the current ABI
+ * version.
  *
  * @param a_iMajor      The major kernel version number.
  * @param a_iMinor      The minor kernel version number.
- * @param a_iPatch      The micro kernel version number.
- * @param a_iAbi        Ubuntu kernel ABI version number.
+ * @param a_iPatch      The kernel patch level.
+ * @param a_iAbi        Ubuntu kernel ABI version number (exclusive).
  */
 # define RTLNX_UBUNTU_ABI_MAX(a_iMajor, a_iMinor, a_iPatch, a_iAbi) \
@@ -160 +167 @@
      && RTLNX_UBUNTU_ABI(UTS_UBUNTU_RELEASE_ABI) < RTLNX_UBUNTU_ABI(a_iAbi))
 
-/** @def RTLNX_UBUNTU_RANGE
- * Require Ubuntu release to be in specified ABI versions range.
- * Kernel version should exactly match to specified @a_iMajor, @a_iMinor
- * and @a_iPatch. Numbers @a_iAbiMin and @a_iAbiMax specify ABI versions range.
- * The max version is exclusive, the minimum inclusive.
+/** @def RTLNX_UBUNTU_ABI_RANGE
+ * Require Ubuntu release ABI to be in specified range.
+ *
+ * The kernel version should exactly match the specified @a a_iMajor, @a
+ * a_iMinor and @a a_iPatch.  The numbers @a a_iAbiMin and @a a_iAbiMax specify
+ * ABI versions range.  The max ABI version is exclusive, the minimum inclusive.
  *
  * @param a_iMajor      The major kernel version number.
  * @param a_iMinor      The minor kernel version number.
- * @param a_iPatch      The micro kernel version number.
- * @param a_iAbiMin     Ubuntu kernel ABI version number (minimum).
- * @param a_iAbiMax     Ubuntu kernel ABI version number (maximum).
+ * @param a_iPatch      The kernel patch level.
+ * @param a_iAbiMin     The minimum Ubuntu kernel ABI version number (inclusive).
+ * @param a_iAbiMax     The maximum Ubuntu kernel ABI version number (exclusive).
  */
 # define RTLNX_UBUNTU_ABI_RANGE(a_iMajor, a_iMinor, a_iPatch, a_iAbiMin, a_iAbiMax) \
@@ -180 +188 @@
 # define RTLNX_UBUNTU_ABI_MIN(a_iMajor, a_iMinor, a_iPatch, a_iAbi) (0)
 # define RTLNX_UBUNTU_ABI_MAX(a_iMajor, a_iMinor, a_iPatch, a_iAbi) (0)
-# define RTLNX_UBUNTU_ABI_RANGE(a_iMajorMin, a_iMinorMin, a_iPatchMin, a_iAbiMin, \
-    a_iMajorMax, a_iMinorMax, a_iPatchMax, a_iAbiMax) (0)
+# define RTLNX_UBUNTU_ABI_RANGE(a_iMajorMin, a_iMinorMin, a_iPatchMin, a_iAbiMin, a_iAbiMax) (0)
 
 #endif /* !UTS_UBUNTU_RELEASE_ABI */