From 1c59625a065fe8fd16e86fcc31a3465498c6e249 Mon Sep 17 00:00:00 2001 From: Victor Berger Date: Fri, 2 Jul 2021 15:37:20 +0200 Subject: [PATCH] backend.udev: review docs --- src/backend/udev.rs | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/src/backend/udev.rs b/src/backend/udev.rs index 3d0214f..6666048 100644 --- a/src/backend/udev.rs +++ b/src/backend/udev.rs @@ -1,13 +1,11 @@ +//! `udev` related functionality for automated device scanning //! -//! Provides `udev` related functionality for automated device scanning. +//! This module mainly provides the [`UdevBackend`], which monitors available DRM devices and acts as +//! an event source to be inserted in [`calloop`], generating events whenever these devices change. //! -//! This module mainly provides the [`UdevBackend`], which -//! monitors available DRM devices and acts as an event source, generating events whenever these -//! devices change. -//! -//! *Note:* Once inserted into the event loop, the [`UdevBackend`] will -//! only notify you about *changes* in the device list. To get an initial snapshot of the state during -//! your initialization, you need to call its `device_list` method. +//! *Note:* Once inserted into the event loop, the [`UdevBackend`] will only notify you about *changes* +//! in the device list. To get an initial snapshot of the state during your initialization, you need to +//! call its `device_list` method. //! //! ```no_run //! use smithay::backend::udev::{UdevBackend, UdevEvent};