udev: update docs, NEWS

diff --git a/NEWS b/NEWS
index 6315b6be1eaa6204e9e6b7caccfd0323404a70e0..a75add14024395096a200a4bb8e114ed91f520c9 100644 (file)
--- 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 f0aab5d4649d4de926ba1f8f52f2bd2163a7cc10..a8277d1363dc4b039d20dd6a01bd4c1edee5f337 100644 (file)
--- 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 671bfd7bcf2dc4a3d8215c26e9a1a1414edc42a8..a945758e3820088d4f2441e44acb9874805c55b4 100644 (file)
--- 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 96506fe580c73a8d74a2fafd844a9c2950456d1d..566e9761aa0eb55beef90384f7faa3e33f36f09a 100644 (file)
--- 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 15a7f558b1dff40f74eaf66cfd90a52cae6fc0f8..1b3da39f83c150769c30e253ee900a7990787755 100644 (file)
--- 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 5b754a22a4de44faa3c35fb24d1f36c0e76d0eef..07a24d5c3c61bdfc93a98801d50ff097f966f81c 100644 (file)
--- 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)
 {