public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Yang Li <yang.lee@linux.alibaba.com>
To: axboe@kernel.dk
Cc: linux-block@vger.kernel.org, linux-kernel@vger.kernel.org,
	Yang Li <yang.lee@linux.alibaba.com>
Subject: [PATCH -next] block: Fix some kernel-doc comments
Date: Fri,  8 Mar 2024 16:19:46 +0800	[thread overview]
Message-ID: <20240308081946.118718-1-yang.lee@linux.alibaba.com> (raw)

This commit adds kernel-doc style comments with complete parameter
descriptions for the functions read_lba, alloc_pvd, and alloc_lvn.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.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 85f4b967565e..83e73bcda86c 100644
--- a/block/partitions/aix.c
+++ b/block/partitions/aix.c
@@ -68,10 +68,10 @@ struct pvd {
 
 /**
  * read_lba(): Read bytes from disk, starting at given LBA
- * @state
- * @lba
- * @buffer
- * @count
+ * @state: disk parsed partitions
+ * @lba: the Logical Block Address of the partition table
+ * @buffer: destination buffer
+ * @count: bytes to read
  *
  * Description:  Reads @count bytes from @state->disk into @buffer.
  * Returns number of bytes read on success, 0 on error.
@@ -103,8 +103,8 @@ static size_t read_lba(struct parsed_partitions *state, u64 lba, u8 *buffer,
 
 /**
  * alloc_pvd(): reads physical volume descriptor
- * @state
- * @lba
+ * @state: disk parsed partitions
+ * @lba: the Logical Block Address of the partition table
  *
  * Description: Returns pvd on success,  NULL on error.
  * Allocates space for pvd and fill it with disk blocks at @lba
@@ -128,8 +128,8 @@ static struct pvd *alloc_pvd(struct parsed_partitions *state, u32 lba)
 
 /**
  * alloc_lvn(): reads logical volume names
- * @state
- * @lba
+ * @state: disk parsed partitions
+ * @lba: the Logical Block Address of the partition table
  *
  * Description: Returns lvn on success,  NULL on error.
  * Allocates space for lvn and fill it with disk blocks at @lba
-- 
2.20.1.7.g153144c


             reply	other threads:[~2024-03-08  8:19 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-08  8:19 Yang Li [this message]
  -- strict thread matches above, loose matches on Subject: below --
2022-11-07  6:22 [PATCH -next] block: Fix some kernel-doc comments Yang Li
2022-11-07 14:22 ` Jens Axboe
2022-11-04  6:20 Yang Li
2022-11-05 15:20 ` Jens Axboe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240308081946.118718-1-yang.lee@linux.alibaba.com \
    --to=yang.lee@linux.alibaba.com \
    --cc=axboe@kernel.dk \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox