]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: add missing description for udev_enumerate_new functions
authorOsama Abdelkader <osama.abdelkader@gmail.com>
Fri, 26 Sep 2025 18:34:53 +0000 (21:34 +0300)
committerYu Watanabe <watanabe.yu+github@gmail.com>
Fri, 26 Sep 2025 19:06:26 +0000 (04:06 +0900)
Add proper description section for udev_enumerate_new(), udev_enumerate_ref(),
and udev_enumerate_unref() functions. The description matches the source code
comments for consistency.

Signed-off-by: Osama Abdelkader <osama.abdelkader@gmail.com>
man/udev_enumerate_new.xml

index ba5fec9557e0d76848270308113509468ebf1708..8c34e12bee82f4a1b0f476469e4ebb4b8aa8cf73 100644 (file)
     </funcsynopsis>
   </refsynopsisdiv>
 
-  <!--<refsect1>
+  <refsect1>
     <title>Description</title>
 
-    <para>XXX: Add short description.</para>
-  </refsect1>-->
+    <para><function>udev_enumerate_new()</function> creates an enumeration context to scan /sys.</para>
+
+    <para><function>udev_enumerate_ref()</function> takes a reference of an enumeration context.</para>
+
+    <para><function>udev_enumerate_unref()</function> drops a reference of an enumeration context. If the refcount reaches zero,
+    all resources of the enumeration context will be released.</para>
+  </refsect1>
 
   <refsect1>
     <title>Return Value</title>