From: Emil Velikov Date: Mon, 21 Oct 2024 13:08:59 +0000 (+0100) Subject: docs: annotate the deprecated API X-Git-Tag: v34~178 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e4cd85c0ba62f0a3baaa17145378aee514f0c4d;p=thirdparty%2Fkmod.git docs: annotate the deprecated API The kmod_module_get_filtered_blacklist() was deprecated since kmod v6 in favour of kmod_module_apply_filter(). Add the decoration so gtk-doc includes it in the generated html and also add a designated index. It seem that gtk-doc insists on having deprecation guards, so not it prints an extra warning like: warning: XXX is deprecated in the inline comments, but no deprecation guards were found around the declaration. (See the --deprecated-guards option for gtkdoc-scan.) Signed-off-by: Emil Velikov Link: https://github.com/kmod-project/kmod/pull/200 Signed-off-by: Lucas De Marchi --- diff --git a/libkmod/docs/libkmod-docs.xml b/libkmod/docs/libkmod-docs.xml index fada602f..674fe3a5 100644 --- a/libkmod/docs/libkmod-docs.xml +++ b/libkmod/docs/libkmod-docs.xml @@ -24,6 +24,10 @@ API Index + + Index of deprecated symbols + + Index of new symbols in 1 diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h index b9a93a52..28c8432a 100644 --- a/libkmod/libkmod.h +++ b/libkmod/libkmod.h @@ -946,6 +946,7 @@ int kmod_module_apply_filter(const struct kmod_ctx *ctx, enum kmod_filter filter * list. * * Since: 1 + * Deprecated: 6: Use #kmod_module_apply_filter instead. */ int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input,