From d3ff2666d699fd839e8ef530ad8d5bcea568dcff Mon Sep 17 00:00:00 2001
From: Ryan Zoeller <rtzoeller@rtzoeller.com>
Date: Mon, 31 Jan 2022 22:36:03 -0600
Subject: Document reboot.rs

---
 src/sys/mod.rs    | 1 -
 src/sys/reboot.rs | 9 ++++++++-
 2 files changed, 8 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/sys/mod.rs b/src/sys/mod.rs
index 63d1a181..7ad819d2 100644
--- a/src/sys/mod.rs
+++ b/src/sys/mod.rs
@@ -91,7 +91,6 @@ feature! {
 #[cfg(target_os = "linux")]
 feature! {
     #![feature = "reboot"]
-    #[allow(missing_docs)]
     pub mod reboot;
 }
 
diff --git a/src/sys/reboot.rs b/src/sys/reboot.rs
index 46ab68b6..2a8009e4 100644
--- a/src/sys/reboot.rs
+++ b/src/sys/reboot.rs
@@ -13,15 +13,22 @@ libc_enum! {
     #[repr(i32)]
     #[non_exhaustive]
     pub enum RebootMode {
+        /// Halt the system.
         RB_HALT_SYSTEM,
+        /// Execute a kernel that has been loaded earlier with
+        /// [`kexec_load(2)`](https://man7.org/linux/man-pages/man2/kexec_load.2.html).
         RB_KEXEC,
+        /// Stop the system and switch off power, if possible.
         RB_POWER_OFF,
+        /// Restart the system.
         RB_AUTOBOOT,
-        // we do not support Restart2,
+        // we do not support Restart2.
+        /// Suspend the system using software suspend.
         RB_SW_SUSPEND,
     }
 }
 
+/// Reboots or shuts down the system.
 pub fn reboot(how: RebootMode) -> Result<Infallible> {
     unsafe {
         libc::reboot(how as libc::c_int)
-- 
cgit v1.2.3