From dbba7e4029e2eb8157232e6b5ddd9ee0f68b51b5 Mon Sep 17 00:00:00 2001 From: Kay Sievers Date: Thu, 25 Mar 2010 16:45:15 +0100 Subject: [PATCH 1/1] libudev: update documentation --- libudev/docs/libudev-docs.xml | 2 +- libudev/libudev-device.c | 14 ++++++-------- libudev/libudev.c | 14 +++++++------- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/libudev/docs/libudev-docs.xml b/libudev/docs/libudev-docs.xml index b0372818c..f47091670 100644 --- a/libudev/docs/libudev-docs.xml +++ b/libudev/docs/libudev-docs.xml @@ -9,7 +9,7 @@ libudev Reference Manual for libudev version &version; - 2009 + 2009-2010 Kay Sievers <kay.sievers@vrfy.org> diff --git a/libudev/libudev-device.c b/libudev/libudev-device.c index fe4588015..410f75b30 100644 --- a/libudev/libudev-device.c +++ b/libudev/libudev-device.c @@ -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. diff --git a/libudev/libudev.c b/libudev/libudev.c index 411e9aec8..0ae5a9115 100644 --- a/libudev/libudev.c +++ b/libudev/libudev.c @@ -1,7 +1,7 @@ /* * libudev - interface to udev device information * - * Copyright (C) 2008-2009 Kay Sievers + * Copyright (C) 2008-2010 Kay Sievers * * 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) { -- 2.30.2