From a19d8b205a3bc2afc9eb09e1a1fae49866d8ffcd Mon Sep 17 00:00:00 2001 From: Szymon Walter Date: Sun, 18 Mar 2018 19:06:50 +0100 Subject: [PATCH] add inode doc comment (copied from osdev) --- src/inode.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/inode.rs b/src/inode.rs index 072ad45..1ce8fc7 100644 --- a/src/inode.rs +++ b/src/inode.rs @@ -1,3 +1,10 @@ +/// An inode is a structure on the disk that represents a file, directory, +/// symbolic link, etc. Inodes do not contain the data of the file / directory / +/// etc. that they represent. Instead, they link to the blocks that actually +/// contain the data. This lets the inodes themselves have a well-defined size +/// which lets them be placed in easily indexed arrays. Each block group has an +/// array of inodes it is responsible for, and conversely every inode within a +/// file system belongs to one of such tables (and one of such block groups). #[repr(C, packed)] pub struct Inode { /// Type and Permissions (see below)