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 <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/200
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>

diff --git a/libkmod/docs/libkmod-docs.xml b/libkmod/docs/libkmod-docs.xml
index fada602f1581f2466bc66ac452c6447fedba6068..674fe3a520c2a549396a9cc29dd8bd25b926b4ba 100644 (file)
--- a/libkmod/docs/libkmod-docs.xml
+++ b/libkmod/docs/libkmod-docs.xml
@@ -24,6 +24,10 @@
     <title>API Index</title>
     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
+  <chapter id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated symbols</title>
+    <xi:include href="xml/api-index-deprecated.xml"></xi:include>
+  </chapter>
   <chapter id="api-index-v1" role="1">
     <title>Index of new symbols in 1</title>
     <xi:include href="xml/api-index-1.xml"></xi:include>

diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index b9a93a52f40008fb904988621328282a322edd00..28c8432a54125d18aa482566b7d0e94062fa9b80 100644 (file)
--- 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,