LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH 2/8] kernel-doc: fix block params and docbook
@ 2008-02-03 23:05 Randy.Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy.Dunlap @ 2008-02-03 23:05 UTC (permalink / raw)
  To: linux-kernel; +Cc: axboe, akpm

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.24-git12.orig/block/blk-core.c
+++ linux-2.6.24-git12/block/blk-core.c
@@ -1734,6 +1734,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)
  {
@@ -1746,6 +1747,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.24-git12.orig/block/blk-settings.c
+++ linux-2.6.24-git12/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.24-git12.orig/Documentation/DocBook/kernel-api.tmpl
+++ linux-2.6.24-git12/Documentation/DocBook/kernel-api.tmpl
@@ -420,12 +420,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">

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2008-02-03 23:06 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-02-03 23:05 [PATCH 2/8] kernel-doc: fix block params and docbook Randy.Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).