Inline docs for bread()

Inline docs for bread()

[Pavel Machek]

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

Re: Inline docs for bread()

[John Levon]

On Tue, Sep 18, 2001 at 09:53:56PM +0200, Pavel Machek wrote:

> -/*
> - * 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

You missed describing dev param. The docs script complains at this.

regards
john

-- 
"If you're not part of the problem, you're part of the problem space."