]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
libkmod/docs: remove misleading "After use, free"
authorEmil Velikov <emil.l.velikov@gmail.com>
Mon, 2 Sep 2024 22:20:19 +0000 (23:20 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Fri, 6 Sep 2024 16:56:01 +0000 (11:56 -0500)
In a couple of instances, the doc suggests freeing the (whole) list
after operating on a (single) list entry.

This is somewhat misleading - drop the instances, since the getters doc
(the ones allocating the lists) are pretty clear about freeing.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/94
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
libkmod/libkmod.h

index cf440c979e9c5f49674fb6d47389b81a8ba114d7..06423382ea0882f167a64b6dc6dd7170bff322b2 100644 (file)
@@ -1071,8 +1071,6 @@ struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
  *
  * Get the address of a kmod module section.
  *
- * After use, free the @list by calling kmod_module_section_free_list().
- *
  * Returns: the address of this kmod module section on success or ULONG_MAX
  * on failure.
  */
@@ -1084,8 +1082,6 @@ unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
  *
  * Get the name of a kmod module section.
  *
- * After use, free the @list by calling kmod_module_section_free_list().
- *
  * Returns: the name of this kmod module section on success or NULL on
  * failure. The string is owned by the section, do not free it.
  */