From c195956988799837b763ab1b9f078e5f0b7f26e6 Mon Sep 17 00:00:00 2001
From: Kay Sievers <kay@vrfy.org>
Date: Tue, 15 May 2012 23:44:28 +0200
Subject: [PATCH] udev: update docs, NEWS

---
 NEWS                            | 6 ++++++
 src/libudev/libudev-device.c    | 1 +
 src/libudev/libudev-enumerate.c | 2 ++
 src/libudev/libudev-monitor.c   | 1 +
 src/libudev/libudev-queue.c     | 2 ++
 src/libudev/libudev.c           | 1 +
 6 files changed, 13 insertions(+)

diff --git a/NEWS b/NEWS
index 6315b6be1..a75add140 100644
--- a/NEWS
+++ b/NEWS
@@ -28,6 +28,12 @@ CHANGES WITH 182:
           to adapt to that, create symlink, or rename the binary after building
           it.
 
+        * Libudev does no longer provide these symbols:
+            udev_monitor_from_socket()
+            udev_queue_get_failed_list_entry()
+            udev_get_{dev,sys,run}_path()
+          The verions number was bumped and symbol versioning introduced.
+
         * systemd-logingctl and systemd-journalctl have been renamed
           to logingctl and journalctl to match systemctl.
 
diff --git a/src/libudev/libudev-device.c b/src/libudev/libudev-device.c
index f0aab5d46..a8277d136 100644
--- a/src/libudev/libudev-device.c
+++ b/src/libudev/libudev-device.c
@@ -1022,6 +1022,7 @@ _public_ struct udev_device *udev_device_ref(struct udev_device *udev_device)
  * Drop a reference of a udev device. If the refcount reaches zero,
  * the resources of the device will be released.
  *
+ * Returns: the passed udev device if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_device *udev_device_unref(struct udev_device *udev_device)
 {
diff --git a/src/libudev/libudev-enumerate.c b/src/libudev/libudev-enumerate.c
index 671bfd7bc..a945758e3 100644
--- a/src/libudev/libudev-enumerate.c
+++ b/src/libudev/libudev-enumerate.c
@@ -111,6 +111,8 @@ _public_ struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_e
  *
  * Drop a reference of an enumeration context. If the refcount reaches zero,
  * all resources of the enumeration context will be released.
+ *
+ * Returns: the passed enumeration context if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_enumerate *udev_enumerate_unref(struct udev_enumerate *udev_enumerate)
 {
diff --git a/src/libudev/libudev-monitor.c b/src/libudev/libudev-monitor.c
index 96506fe58..566e9761a 100644
--- a/src/libudev/libudev-monitor.c
+++ b/src/libudev/libudev-monitor.c
@@ -400,6 +400,7 @@ _public_ struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor
  * the bound socket will be closed, and the resources of the monitor
  * will be released.
  *
+ * Returns: the passed udev monitor if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor)
 {
diff --git a/src/libudev/libudev-queue.c b/src/libudev/libudev-queue.c
index 15a7f558b..1b3da39f8 100644
--- a/src/libudev/libudev-queue.c
+++ b/src/libudev/libudev-queue.c
@@ -92,6 +92,8 @@ _public_ struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue)
  *
  * Drop a reference of a udev queue context. If the refcount reaches zero,
  * the resources of the queue context will be released.
+ *
+ * Returns: the passed queue context if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_queue *udev_queue_unref(struct udev_queue *udev_queue)
 {
diff --git a/src/libudev/libudev.c b/src/libudev/libudev.c
index 5b754a22a..07a24d5c3 100644
--- a/src/libudev/libudev.c
+++ b/src/libudev/libudev.c
@@ -221,6 +221,7 @@ _public_ struct udev *udev_ref(struct udev *udev)
  * Drop a reference of the udev library context. If the refcount
  * reaches zero, the resources of the context will be released.
  *
+ * Returns: the passed udev library context if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev *udev_unref(struct udev *udev)
 {
-- 
2.30.2