documentation

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

diff --git a/src/lxcseccomp.rs b/src/lxcseccomp.rs
index b99b3078e48ced06b609144c2cff3c158eb3570b..31fa1587f56c419ff3e412eede26d4dcbe4fe53b 100644 (file)
--- a/src/lxcseccomp.rs
+++ b/src/lxcseccomp.rs
@@ -1,4 +1,4 @@
-//! Module for LXC specific related seccomp handling.
+//! Module for LXC specific seccomp handling.
 
 use std::convert::TryFrom;
 use std::ffi::CString;
@@ -115,8 +115,9 @@ impl ProxyMessageBuffer {
         self.pid_fd = None;
     }
 
-    /// Returns None on EOF.
+    /// Returns false on EOF.
     pub async fn recv(&mut self, socket: &SeqPacketSocket) -> Result<bool, Error> {
+        // prepare buffers:
         self.reset();
 
         unsafe {
@@ -134,6 +135,7 @@ impl ProxyMessageBuffer {
             self.cookie_buf.set_len(0);
         }
 
+        // receive:
         let mut fd_cmsg_buf = cmsg::buffer::<[RawFd; 2]>();
         let (datalen, cmsglen) = socket
             .recvmsg_vectored(&mut iovec, &mut fd_cmsg_buf)
@@ -145,6 +147,8 @@ impl ProxyMessageBuffer {
 
         self.set_len(datalen)?;
 
+        // iterate through control messages:
+
         let cmsg = cmsg::iter(&fd_cmsg_buf[..cmsglen])
             .next()
             .ok_or_else(|| format_err!("missing file descriptors in message"))?;

diff --git a/src/nsfd.rs b/src/nsfd.rs
index 4a3c7dc83f28244c82b97112107ae3831e2f77d1..9a98ed09a3db9b58bc0b942cc67551a7c0078e12 100644 (file)
--- a/src/nsfd.rs
+++ b/src/nsfd.rs
@@ -1,3 +1,5 @@
+//! Namespace file descriptor helpers.
+
 use std::ffi::CStr;
 use std::io;
 use std::marker::PhantomData;