Skip to contentSkip to conversation

Inline docs for bread()

PATCH Pavel Machek 2 participants 2 messages Sep 18, 2001 – Sep 19, 2001 VFS

lore
Share & tools
lore
#0 lore raw

Hi!

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

fs/buffer.c +7 -3
@@ -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)
 {
Signature · 2 lines
I'm [email protected]. "In my country we have almost anarchy and I don't care."
Panos Katsaloulis describing me w.r.t. patents at [email protected]
#1 lore raw

fs/buffer.c line 1234

Quoted 7 lines · Pavel Machek
fs/buffer.c +4 -3
-/*
- * 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

Signature · 1 line
"If you're not part of the problem, you're part of the problem space."