chiark / gitweb /
libudev: update documentation
authorKay Sievers <kay.sievers@vrfy.org>
Thu, 25 Mar 2010 15:45:15 +0000 (16:45 +0100)
committerKay Sievers <kay.sievers@vrfy.org>
Thu, 25 Mar 2010 15:45:48 +0000 (16:45 +0100)
libudev/docs/libudev-docs.xml
libudev/libudev-device.c
libudev/libudev.c

index b037281..f470916 100644 (file)
@@ -9,7 +9,7 @@
     <title>libudev Reference Manual</title>
     <releaseinfo>for libudev version &version;</releaseinfo>
     <copyright>
-      <year>2009</year>
+      <year>2009-2010</year>
       <holder>Kay Sievers &lt;kay.sievers@vrfy.org&gt;</holder>
     </copyright>
   </bookinfo>
index fe45880..410f75b 100644 (file)
@@ -463,10 +463,9 @@ struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *
  * @devnum: device major/minor number
  *
  * Create new udev device, and fill in information from the sys
- * device and the udev database entry. The device is looked up
- * by its major/minor number. Character and block device numbers
- * are not unique across the two types, they do not share the same
- * range of numbers.
+ * device and the udev database entry. The device is looked-up
+ * by its major/minor number and type. Character and block device
+ * numbers are not unique across the two types.
  *
  * The initial refcount is 1, and needs to be decremented to
  * release the resources of the udev device.
@@ -497,10 +496,9 @@ struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, de
  * @subsystem: the subsystem of the device
  * @sysname: the name of the device
  *
- * Create new udev device, and fill in information from the sys
- * device and the udev database entry. The device is looked up
- * by the subsystem and name string of the device, like "mem",
- * "zero", or "block", "sda".
+ * Create new udev device, and fill in information from the sys device
+ * and the udev database entry. The device is looked up by the subsystem
+ * and name string of the device, like "mem" / "zero", or "block" / "sda".
  *
  * The initial refcount is 1, and needs to be decremented to
  * release the resources of the udev device.
index 411e9ae..0ae5a91 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * libudev - interface to udev device information
  *
- * Copyright (C) 2008-2009 Kay Sievers <kay.sievers@vrfy.org>
+ * Copyright (C) 2008-2010 Kay Sievers <kay.sievers@vrfy.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -71,7 +71,7 @@ static void log_stderr(struct udev *udev,
  * @udev: udev library context
  *
  * Retrieve stored data pointer from library context. This might be useful
- * to access from callbacks.
+ * to access from callbacks like a custom logging function.
  *
  * Returns: stored userdata
  **/
@@ -321,10 +321,10 @@ void udev_set_log_fn(struct udev *udev,
  * udev_get_log_priority:
  * @udev: udev library context
  *
- * The initial syslog priority is read from the udev config file
+ * The initial logging priority is read from the udev config file
  * at startup.
  *
- * Returns: the current syslog priority
+ * Returns: the current logging priority
  **/
 int udev_get_log_priority(struct udev *udev)
 {
@@ -334,10 +334,10 @@ int udev_get_log_priority(struct udev *udev)
 /**
  * udev_set_log_priority:
  * @udev: udev library context
- * @priority: the new syslog priority
+ * @priority: the new logging priority
  *
- * Set the current syslog priority. The value controls which messages
- * are send to syslog.
+ * Set the current logging priority. The value controls which messages
+ * are logged.
  **/
 void udev_set_log_priority(struct udev *udev, int priority)
 {