kernel-doc: fix fs/pipe.c notation

Fix several kernel-doc notation errors in fs/pipe.c. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: Jens Axboe <jens.axboe@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

kernel-doc: fix fs/pipe.c notation
Fix several kernel-doc notation errors in fs/pipe.c. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: Jens Axboe <jens.axboe@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Randy Dunlap · Linus Torvalds
1 parent 55265b00ad
Showing 1 changed file with 5 additions and 5 deletions Side-by-side Diff
fs/pipe.c
@@ -171,7 +171,7 @@
  *
  * 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 @@
 }
  
 /**
- * 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 @@
 }
  
 /**
- * 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
  *
...	...	@@ -171,7 +171,7 @@
171	171	*
172	172	* Description:
173	173	* This function returns a kernel virtual address mapping for the
174		- * passed in @pipe_buffer. If @atomic is set, an atomic map is provided
	174	+ * pipe_buffer passed in @buf. If @atomic is set, an atomic map is provided
175	175	* and the caller has to be careful not to fault before calling
176	176	* the unmap function.
177	177	*
178	178
179	179
...	...	@@ -208,15 +208,15 @@
208	208	}
209	209
210	210	/**
211		- * generic_pipe_buf_steal - attempt to take ownership of a @pipe_buffer
	211	+ * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
212	212	* @pipe: the pipe that the buffer belongs to
213	213	* @buf: the buffer to attempt to steal
214	214	*
215	215	* Description:
216		- * This function attempts to steal the @struct page attached to
	216	+ * This function attempts to steal the &struct page attached to
217	217	* @buf. If successful, this function returns 0 and returns with
218	218	* the page locked. The caller may then reuse the page for whatever
219		- * he wishes, the typical use is insertion into a different file
	219	+ * he wishes; the typical use is insertion into a different file
220	220	* page cache.
221	221	*/
222	222	int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
...	...	@@ -238,7 +238,7 @@
238	238	}
239	239
240	240	/**
241		- * generic_pipe_buf_get - get a reference to a @struct pipe_buffer
	241	+ * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
242	242	* @pipe: the pipe that the buffer belongs to
243	243	* @buf: the buffer to get a reference to
244	244	*