block: fix kernel-docbook parameters and files

kernel-doc for block/: - add missing parameters - fix one function's parameter list (remove blank line) - add 2 source files to docbook for non-exported kernel-doc functions Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Jens Axboe <jens.axboe@oracle.com>

block: fix kernel-docbook parameters and files
kernel-doc for block/: - add missing parameters - fix one function's parameter list (remove blank line) - add 2 source files to docbook for non-exported kernel-doc functions Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
Randy Dunlap · Jens Axboe
1 parent 976dde010e
Showing 3 changed files with 4 additions and 1 deletions Side-by-side Diff
Documentation/DocBook/kernel-api.tmpl
block/blk-core.c
block/blk-settings.c
@@ -361,12 +361,14 @@
   <chapter id="blkdev">
      <title>Block Devices</title>
 !Eblock/blk-core.c
+!Iblock/blk-core.c
 !Eblock/blk-map.c
 !Iblock/blk-sysfs.c
 !Eblock/blk-settings.c
 !Eblock/blk-exec.c
 !Eblock/blk-barrier.c
 !Eblock/blk-tag.c
+!Iblock/blk-tag.c
   </chapter>
  
   <chapter id="chrdev">
@@ -1768,6 +1768,7 @@
  
 /**
  * blk_rq_bytes - Returns bytes left to complete in the entire request
+ * @rq: the request being processed
  **/
 unsigned int blk_rq_bytes(struct request *rq)
 {
@@ -1780,6 +1781,7 @@
  
 /**
  * blk_rq_cur_bytes - Returns bytes left to complete in the current segment
+ * @rq: the request being processed
  **/
 unsigned int blk_rq_cur_bytes(struct request *rq)
 {
@@ -294,7 +294,6 @@
  
 /**
  * blk_queue_dma_drain - Set up a drain buffer for excess dma.
- *
  * @q:  the request queue for the device
  * @dma_drain_needed: fn which returns non-zero if drain is necessary
  * @buf:	physically contiguous buffer
...	...	@@ -361,12 +361,14 @@
361	361	<chapter id="blkdev">
362	362	<title>Block Devices</title>
363	363	!Eblock/blk-core.c
	364	+!Iblock/blk-core.c
364	365	!Eblock/blk-map.c
365	366	!Iblock/blk-sysfs.c
366	367	!Eblock/blk-settings.c
367	368	!Eblock/blk-exec.c
368	369	!Eblock/blk-barrier.c
369	370	!Eblock/blk-tag.c
	371	+!Iblock/blk-tag.c
370	372	</chapter>
371	373
372	374	<chapter id="chrdev">
...	...	@@ -1768,6 +1768,7 @@
1768	1768
1769	1769	/**
1770	1770	* blk_rq_bytes - Returns bytes left to complete in the entire request
	1771	+ * @rq: the request being processed
1771	1772	**/
1772	1773	unsigned int blk_rq_bytes(struct request *rq)
1773	1774	{
...	...	@@ -1780,6 +1781,7 @@
1780	1781
1781	1782	/**
1782	1783	* blk_rq_cur_bytes - Returns bytes left to complete in the current segment
	1784	+ * @rq: the request being processed
1783	1785	**/
1784	1786	unsigned int blk_rq_cur_bytes(struct request *rq)
1785	1787	{
...	...	@@ -294,7 +294,6 @@
294	294
295	295	/**
296	296	* blk_queue_dma_drain - Set up a drain buffer for excess dma.
297		- *
298	297	* @q: the request queue for the device
299	298	* @dma_drain_needed: fn which returns non-zero if drain is necessary
300	299	* @buf: physically contiguous buffer