[PATCH -next] block: Fix some kernel-doc comments

[PATCH -next] block: Fix some kernel-doc comments

[Yang Li]

Remove the description of @required_features in elevator_match()
to clear the below warning:

block/elevator.c:103: warning: Excess function parameter 'required_features' description in 'elevator_match'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2734
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 block/elevator.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/block/elevator.c b/block/elevator.c
index 800e0038be0d..a5bdc3b1e7e5 100644
--- a/block/elevator.c
+++ b/block/elevator.c
@@ -94,7 +94,6 @@ static inline bool elv_support_features(struct request_queue *q,
  * elevator_match - Test an elevator name and features
  * @e: Scheduler to test
  * @name: Elevator name to test
- * @required_features: Features that the elevator must provide
  *
  * Return true if the elevator @e name matches @name and if @e provides all
  * the features specified by @required_features.
-- 
2.20.1.7.g153144c

Re: [PATCH -next] block: Fix some kernel-doc comments

[Jens Axboe]

On 11/4/22 12:20 AM, Yang Li wrote:
> Remove the description of @required_features in elevator_match()
> to clear the below warning:
> 
> block/elevator.c:103: warning: Excess function parameter 'required_features' description in 'elevator_match'

I'm guessing this was introduced by the recent series from
Christoph? Can you add a Fixes tag?

-- 
Jens Axboe

[PATCH -next] block: Fix some kernel-doc comments

[Yang Li]

Remove the description of @required_features in elevator_match()
to clear the below warning:

block/elevator.c:103: warning: Excess function parameter 'required_features' description in 'elevator_match'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2734
Fixes: ffb86425ee2c ("block: don't check for required features in elevator_match")
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 block/elevator.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/block/elevator.c b/block/elevator.c
index 800e0038be0d..a5bdc3b1e7e5 100644
--- a/block/elevator.c
+++ b/block/elevator.c
@@ -94,7 +94,6 @@ static inline bool elv_support_features(struct request_queue *q,
  * elevator_match - Test an elevator name and features
  * @e: Scheduler to test
  * @name: Elevator name to test
- * @required_features: Features that the elevator must provide
  *
  * Return true if the elevator @e name matches @name and if @e provides all
  * the features specified by @required_features.
-- 
2.20.1.7.g153144c

Re: [PATCH -next] block: Fix some kernel-doc comments

[Jens Axboe]

On Mon, 7 Nov 2022 14:22:55 +0800, Yang Li wrote:
> Remove the description of @required_features in elevator_match()
> to clear the below warning:
> 
> block/elevator.c:103: warning: Excess function parameter 'required_features' description in 'elevator_match'
> 
> 

Applied, thanks!

[1/1] block: Fix some kernel-doc comments
      commit: 5b2560c4c20e6d6933625b4b56f6843d6c7faf0f

Best regards,
-- 
Jens Axboe

[PATCH -next] block: Fix some kernel-doc comments

[Yang Li]

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