diff mbox series

[kmod,1/3] libkmod: document KMOD_INDEX_MODULES_BUILTIN_ALIAS in kmod_dump_index()

Message ID 20240719-abi-fixes-v1-1-1e6d99a2846b@gmail.com (mailing list archive)
State Handled Elsewhere
Headers show
Series libkmod: misc ABI changes | expand

Commit Message

Emil Velikov via B4 Relay July 19, 2024, 4:12 p.m. UTC
From: Emil Velikov <emil.l.velikov@gmail.com>

The extra enum was introduced a few years ago, although the (only)
function using it did not have it's documentation updated.

The commit itself has caused an ABI break with kmod v27, since the
KMOD_INDEX_MODULES_BUILTIN value has changed.

A search through Google, Github and Arch packages have shown one user of
kmod_dump_index() - the only API that uses the enum.

In that case and all others, no projects referencing the changed enum
were found. Although since recent and/or supported distros use kmod v27
or later we've decided to only update the documentation.

Cc: Alexey Gladkov <gladkov.alexey@gmail.com>
Fixes: b866b21 ("Lookup aliases in the modules.builtin.modinfo")
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
The project itself being https://github.com/falconindy/modtree which
hasn't been updated in 12 years.

The following distros/versions ship kmod v26 or older, where bunch of
them are no longer supported.

 - RHEL 8 + community variants Alma/Amazon/CentOS/Rocky/Scientific
 - Alpine Linux 3.11
 - Debian 10 + derivatives
 - Ubuntu 18.04
---
 libkmod/libkmod.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Lucas De Marchi July 19, 2024, 4:47 p.m. UTC | #1
On Fri, Jul 19, 2024 at 05:12:41PM GMT, Emil Velikov via B4 Relay wrote:
>From: Emil Velikov <emil.l.velikov@gmail.com>
>
>The extra enum was introduced a few years ago, although the (only)
>function using it did not have it's documentation updated.
>
>The commit itself has caused an ABI break with kmod v27, since the
>KMOD_INDEX_MODULES_BUILTIN value has changed.
>
>A search through Google, Github and Arch packages have shown one user of
>kmod_dump_index() - the only API that uses the enum.
>
>In that case and all others, no projects referencing the changed enum
>were found. Although since recent and/or supported distros use kmod v27
>or later we've decided to only update the documentation.
>
>Cc: Alexey Gladkov <gladkov.alexey@gmail.com>
>Fixes: b866b21 ("Lookup aliases in the modules.builtin.modinfo")
>Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>


Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>


thanks
Lucas De Marchi

>---
>The project itself being https://github.com/falconindy/modtree which
>hasn't been updated in 12 years.
>
>The following distros/versions ship kmod v26 or older, where bunch of
>them are no longer supported.
>
> - RHEL 8 + community variants Alma/Amazon/CentOS/Rocky/Scientific
> - Alpine Linux 3.11
> - Debian 10 + derivatives
> - Ubuntu 18.04
>---
> libkmod/libkmod.c | 1 +
> 1 file changed, 1 insertion(+)
>
>diff --git a/libkmod/libkmod.c b/libkmod/libkmod.c
>index 213b424..fecb8e7 100644
>--- a/libkmod/libkmod.c
>+++ b/libkmod/libkmod.c
>@@ -971,6 +971,7 @@ KMOD_EXPORT void kmod_unload_resources(struct kmod_ctx *ctx)
>  * KMOD_INDEX_MODULES_DEP: index of module dependencies;
>  * KMOD_INDEX_MODULES_ALIAS: index of module aliases;
>  * KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases;
>+ * KMOD_INDEX_MODULES_BUILTIN_ALIAS: index of builtin module aliases.
>  * KMOD_INDEX_MODULES_BUILTIN: index of builtin module.
>  * @fd: file descriptor to dump index to
>  *
>
>-- 
>2.45.2
>
>
diff mbox series

Patch

diff --git a/libkmod/libkmod.c b/libkmod/libkmod.c
index 213b424..fecb8e7 100644
--- a/libkmod/libkmod.c
+++ b/libkmod/libkmod.c
@@ -971,6 +971,7 @@  KMOD_EXPORT void kmod_unload_resources(struct kmod_ctx *ctx)
  * KMOD_INDEX_MODULES_DEP: index of module dependencies;
  * KMOD_INDEX_MODULES_ALIAS: index of module aliases;
  * KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases;
+ * KMOD_INDEX_MODULES_BUILTIN_ALIAS: index of builtin module aliases.
  * KMOD_INDEX_MODULES_BUILTIN: index of builtin module.
  * @fd: file descriptor to dump index to
  *