linux-kernel - [PATCH -next] partitions/aix: fix doc warnings

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]

Message-ID: <20210610074845.58503-1-chenxiaosong2@huawei.com>
Date:   Thu, 10 Jun 2021 15:48:45 +0800
From:   ChenXiaoSong <chenxiaosong2@...wei.com>
To:     <axboe@...nel.dk>
CC:     <linux-block@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <yukuai3@...wei.com>, <yi.zhang@...wei.com>,
        <chenxiaosong2@...wei.com>
Subject: [PATCH -next] partitions/aix: fix doc warnings

Fix gcc W=1 warnings:

block/partitions/aix.c:130: warning: Function parameter or member 'lba' not described in 'alloc_pvd'
block/partitions/aix.c:130: warning: Function parameter or member 'state' not described in 'alloc_pvd'
block/partitions/aix.c:155: warning: Function parameter or member 'lba' not described in 'alloc_lvn'
block/partitions/aix.c:155: warning: Function parameter or member 'state' not described in 'alloc_lvn'
block/partitions/aix.c:97: warning: Function parameter or member 'buffer' not described in 'read_lba'
block/partitions/aix.c:97: warning: Function parameter or member 'count' not described in 'read_lba'
block/partitions/aix.c:97: warning: Function parameter or member 'lba' not described in 'read_lba'
block/partitions/aix.c:97: warning: Function parameter or member 'state' not described in 'read_lba'

Signed-off-by: ChenXiaoSong <chenxiaosong2@...wei.com>
---
 block/partitions/aix.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/block/partitions/aix.c b/block/partitions/aix.c
index c7b4fd1a4a97..44397139cae0 100644
--- a/block/partitions/aix.c
+++ b/block/partitions/aix.c
@@ -84,10 +84,10 @@ static u64 last_lba(struct block_device *bdev)
 
 /**
  * read_lba(): Read bytes from disk, starting at given LBA
- * @state
- * @lba
- * @buffer
- * @count
+ * @state: Pointer to "struct parsed_partitions"
+ * @lba: Logical block address
+ * @buffer: Pointer to "u8"
+ * @count: Bytes reads from @state->bdev into @buffer
  *
  * Description:  Reads @count bytes from @state->bdev into @buffer.
  * Returns number of bytes read on success, 0 on error.
@@ -119,8 +119,8 @@ static size_t read_lba(struct parsed_partitions *state, u64 lba, u8 *buffer,
 
 /**
  * alloc_pvd(): reads physical volume descriptor
- * @state
- * @lba
+ * @state: Pointer to "struct parsed_partitions"
+ * @lba: Logical block address
  *
  * Description: Returns pvd on success,  NULL on error.
  * Allocates space for pvd and fill it with disk blocks at @lba
@@ -144,8 +144,8 @@ static struct pvd *alloc_pvd(struct parsed_partitions *state, u32 lba)
 
 /**
  * alloc_lvn(): reads logical volume names
- * @state
- * @lba
+ * @state: Pointer to "struct parsed_partitions"
+ * @lba: Logical block address
  *
  * Description: Returns lvn on success,  NULL on error.
  * Allocates space for lvn and fill it with disk blocks at @lba
-- 
2.25.4