summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSergey Bugaev <bugaevc@gmail.com>2016-07-14 00:51:52 +0300
committerSergey Bugaev <bugaevc@gmail.com>2016-07-14 00:51:52 +0300
commitf682458c829e6d715cabd9e8ef6730ff05567966 (patch)
treeeda04fe138c2f188120bec23f991910e2eef589f /src
parentcce6bce7fc85d8c44a101ae164a4604ab5adf6d4 (diff)
downloadnix-f682458c829e6d715cabd9e8ef6730ff05567966.zip
Add some documentation
Diffstat (limited to 'src')
-rw-r--r--src/sys/reboot.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/sys/reboot.rs b/src/sys/reboot.rs
index 0f9d5e88..81502d01 100644
--- a/src/sys/reboot.rs
+++ b/src/sys/reboot.rs
@@ -1,8 +1,14 @@
+//! Reboot/shutdown or enable/disable Ctrl-Alt-Delete.
+
use {Errno, Error, Result};
use libc;
use void::Void;
use std::mem::drop;
+/// How exactly should the system be rebooted.
+///
+/// See [`set_cad_enabled()`](fn.set_cad_enabled.html) for
+/// enabling/disabling Ctrl-Alt-Delete.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum RebootMode {
Halt,