Inline docs for bread()

From: Pavel Machek (pavel@suse.cz)
Date: Tue Sep 18 2001 - 14:53:56 EST


Hi!

It took me quite a while to decide how to call bread correctly -- so I
added docs for it. Please apply,
                                                                Pavel

--- clean/fs/buffer.c Thu Aug 30 10:42:31 2001
+++ linux/fs/buffer.c Tue Sep 18 21:52:47 2001
@@ -1226,9 +1228,13 @@
         spin_unlock(&lru_list_lock);
 }
 
-/*
- * bread() reads a specified block and returns the buffer that contains
- * it. It returns NULL if the block was unreadable.
+/**
+ * bread() - reads a specified block and returns the bh
+ * @block: number of block
+ * @size: size (in bytes) to read
+ *
+ * Reads a specified block, and returns buffer head that
+ * contains it. It returns NULL if the block was unreadable.
  */
 struct buffer_head * bread(kdev_t dev, int block, int size)
 {

-- 
I'm pavel@ucw.cz. "In my country we have almost anarchy and I don't care."
Panos Katsaloulis describing me w.r.t. patents at discuss@linmodems.org
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/



This archive was generated by hypermail 2b29 : Sun Sep 23 2001 - 21:00:27 EST