linux-kernel - [PATCH 2/8] kernel-doc: fix block params and docbook

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:	Sun, 3 Feb 2008 15:05:59 -0800 (PST)
From:	"Randy.Dunlap" <rdunlap@...otime.net>
To:	linux-kernel@...r.kernel.org
cc:	axboe@...nel.dk, akpm@...ux-foundation.org
Subject: [PATCH 2/8] kernel-doc: fix block params and docbook

From: Randy Dunlap <randy.dunlap@...cle.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@...cle.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">
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/