From: Tom Gundersen <teg@jklm.no>
Date: Thu, 18 Jun 2015 17:15:59 +0000 (+0200)
Subject: man: udev_device - finish new_* man page
X-Git-Tag: v221~7^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2ef24a16ac054bc06c3a2520e0d8e862eeea65f8;p=thirdparty%2Fsystemd.git

man: udev_device - finish new_* man page

A description of device_id lacked. We still need to do the other
udev_device_* man pages.
---

diff --git a/man/udev_device_new_from_syspath.xml b/man/udev_device_new_from_syspath.xml
index fc147a879ae..9c4ab7a1bf3 100644
--- a/man/udev_device_new_from_syspath.xml
+++ b/man/udev_device_new_from_syspath.xml
@@ -136,10 +136,37 @@
     <constant>c</constant> for character devices, as well as a devnum (see
     <citerefentry><refentrytitle>makedev</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
     <function>udev_device_new_from_subsystem_sysname</function> looks up devices based
-    on the provided subsystem and sysname and
-    <function>udev_device_new_from_device_id</function> looks up devices based on the provided
-    device id (see
-    <citerefentry><refentrytitle>udev_device_get_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
+    on the provided subsystem and sysname
+    (see <citerefentry><refentrytitle>udev_device_get_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>udev_device_get_sysname</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
+    and <function>udev_device_new_from_device_id</function> looks up devices based on the provided
+    device id which is a special string in one of the following four forms:
+    <table>
+      <title>Device ID strings</title>
+
+      <tgroup cols='2'>
+        <colspec colname='example' />
+        <colspec colname='explanation' />
+        <thead><row>
+          <entry>Example</entry>
+          <entry>Explanation</entry>
+        </row></thead>
+        <tbody>
+          <row><entry><varname>b8:2</varname></entry>
+          <entry>block device major:minor</entry></row>
+
+          <row><entry><varname>c128:1</varname></entry>
+          <entry>char device major:minor</entry></row>
+
+          <row><entry><varname>n3</varname></entry>
+          <entry>network device ifindex</entry></row>
+
+          <row><entry><varname>+sound:card29</varname></entry>
+          <entry>kernel driver core subsystem:device name</entry></row>
+        </tbody>
+      </tgroup>
+    </table>
     </para>
 
     <para><function>udev_device_new_from_environment</function>