[PATCH] block: fix kernel-docbook parameters and files

[PATCH] block: fix kernel-docbook parameters and files

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

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>
---
 Documentation/DocBook/kernel-api.tmpl |    2 ++
 block/blk-core.c                      |    2 ++
 block/blk-settings.c                  |    1 -
 3 files changed, 4 insertions(+), 1 deletion(-)

--- linux-2.6.25-rc1-git4.orig/block/blk-core.c
+++ linux-2.6.25-rc1-git4/block/blk-core.c
@@ -1767,6 +1767,7 @@ static inline void __end_request(struct 
 
 /**
  * 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)
 {
@@ -1779,6 +1780,7 @@ EXPORT_SYMBOL_GPL(blk_rq_bytes);
 
 /**
  * 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)
 {
--- linux-2.6.25-rc1-git4.orig/block/blk-settings.c
+++ linux-2.6.25-rc1-git4/block/blk-settings.c
@@ -294,7 +294,6 @@ EXPORT_SYMBOL(blk_queue_stack_limits);
 
 /**
  * blk_queue_dma_drain - Set up a drain buffer for excess dma.
- *
  * @q:  the request queue for the device
  * @buf:	physically contiguous buffer
  * @size:	size of the buffer in bytes
--- linux-2.6.25-rc1-git4.orig/Documentation/DocBook/kernel-api.tmpl
+++ linux-2.6.25-rc1-git4/Documentation/DocBook/kernel-api.tmpl
@@ -361,12 +361,14 @@ X!Edrivers/pnp/system.c
   <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">

Re: [PATCH] block: fix kernel-docbook parameters and files

[Jens Axboe]

On Mon, Feb 18 2008, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> 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

Care to rediff and resend, it doesn't apply cleanly anymore?

-- 
Jens Axboe

[PATCH] block: fix kernel-docbook parameters and files

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

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>
---
 Documentation/DocBook/kernel-api.tmpl |    2 ++
 block/blk-core.c                      |    2 ++
 block/blk-settings.c                  |    1 -
 3 files changed, 4 insertions(+), 1 deletion(-)

--- linux-2.6.25-rc2-git3.orig/block/blk-core.c
+++ linux-2.6.25-rc2-git3/block/blk-core.c
@@ -1768,6 +1768,7 @@ static inline void __end_request(struct 
 
 /**
  * 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 @@ EXPORT_SYMBOL_GPL(blk_rq_bytes);
 
 /**
  * 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)
 {
--- linux-2.6.25-rc2-git3.orig/block/blk-settings.c
+++ linux-2.6.25-rc2-git3/block/blk-settings.c
@@ -294,7 +294,6 @@ EXPORT_SYMBOL(blk_queue_stack_limits);
 
 /**
  * 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
--- linux-2.6.25-rc2-git3.orig/Documentation/DocBook/kernel-api.tmpl
+++ linux-2.6.25-rc2-git3/Documentation/DocBook/kernel-api.tmpl
@@ -361,12 +361,14 @@ X!Edrivers/pnp/system.c
   <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">

Re: [PATCH] block: fix kernel-docbook parameters and files

[Jens Axboe]

On Tue, Feb 19 2008, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> 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

Thanks Randy, applied.

-- 
Jens Axboe