kernel-doc: fix fs/pipe.c notation
PATCH 1/4 kernel-doc: fix fs/pipe.c notation
From: Randy Dunlap <[email protected]>
Fix several kernel-doc notation errors in fs/pipe.c.
Signed-off-by Randy Dunlap <[email protected]>
--- fs/pipe.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
fs/pipe.c +5 -5
@@ -171,7 +171,7 @@ static void anon_pipe_buf_release(struct* * Description: * This function returns a kernel virtual address mapping for the -* passed in @pipe_buffer. If @atomic is set, an atomic map is provided +* pipe_buffer passed in @buf. If @atomic is set, an atomic map is provided * and the caller has to be careful not to fault before calling * the unmap function. *
@@ -208,15 +208,15 @@ void generic_pipe_buf_unmap(struct pipe_ }/** -* generic_pipe_buf_steal - attempt to take ownership of a @pipe_buffer +* generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer * @pipe: the pipe that the buffer belongs to * @buf: the buffer to attempt to steal * * Description: -* This function attempts to steal the @struct page attached to +* This function attempts to steal the &struct page attached to * @buf. If successful, this function returns 0 and returns with * the page locked. The caller may then reuse the page for whatever -* he wishes, the typical use is insertion into a different file +* he wishes; the typical use is insertion into a different file * page cache. */ int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
@@ -238,7 +238,7 @@ int generic_pipe_buf_steal(struct pipe_i }/** -* generic_pipe_buf_get - get a reference to a @struct pipe_buffer +* generic_pipe_buf_get - get a reference to a &struct pipe_buffer * @pipe: the pipe that the buffer belongs to * @buf: the buffer to get a reference to *
Quoted 4 lines · On Mon, 11 Feb 2008 17:27:53 -0800 Randy Dunlap <[email protected]> wrote:
From: Randy Dunlap <[email protected]>
Fix several kernel-doc notation errors in
fs/pipe.c.
Thanks, Randy. I think I'll slip these four patches into mainline while they don't conflict with anyone else's stuff. (Well, apart from git-x86, but that's usual :))