[OS-BUILD PATCH 2/18] kabi: fix the note about terminating semicolon

From: Čestmír Kalina <ckalina(a)redhat.com&gt; kabi: fix the note about terminating semicolon Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=2024595 Upstream Status: RHEL only commit 4291fec226e36100b080a4834c7d641974435d75 Author: Jiri Benc <jbenc(a)redhat.com&gt; Date: Wed, 19 Feb 2020 12:04:20 -0500 Move the note about terminating semicolon to the beginning of the file. The number of macros grew over time and the note got easy to miss. While moving it, fix the wording. Not all macros add the semicolon, RH_KABI_RENAME does not (in order to be applicable to a wider range of use cases). RH-Signed-off-by: Jiri Benc <jbenc(a)redhat.com&gt; Signed-off-by: Čestmír Kalina <ckalina(a)redhat.com&gt; Signed-off-by: Prarit Bhargava <prarit(a)redhat.com&gt; diff --git a/include/linux/rh_kabi.h b/include/linux/rh_kabi.h index blahblah..blahblah 100644 --- a/include/linux/rh_kabi.h +++ b/include/linux/rh_kabi.h @@ -30,6 +30,14 @@ #include <linux/stringify.h> /* + * NOTE + * Unless indicated otherwise, don't use ';' after these macros as it + * messes up the kABI checker by changing what the resulting token string + * looks like. Instead let the macros add the ';' so it can be properly + * hidden from the kABI checker (mainly for RH_KABI_EXTEND, but applied to + * most macros for uniformity). + * + * * RH_KABI_CONST * Adds a new const modifier to a function parameter preserving the old * checksum. @@ -67,7 +75,7 @@ * Simple macro for renaming an element without changing its type. This * macro can be used in bitfields, for example. * - * NOTE: does not include the final ';' + * NOTE: this macro does not add the final ';' * * RH_KABI_REPLACE * Simple replacement of _orig with a union of _orig and _new. @@ -132,12 +140,6 @@ * of the size is not allowed and would constitute a silent kABI breakage. * Beware that the RH_KABI_EXCLUDE macro does not do any size checks. * - * NOTE - * Don't use ';' after these macros as it messes up the kABI checker by - * changing what the resulting token string looks like. Instead let this - * macro add the ';' so it can be properly hidden from the kABI checker - * (mainly for RH_KABI_EXTEND, but applied to all macros for uniformity). - * */ #undef linux -- https://gitlab.com/cki-project/kernel-ark/-/merge_requests/1530