diff mbox series

block/partitions/efi.c: Fix the efi_partition() kernel-doc header

Message ID 20210512201700.9788-1-bvanassche@acm.org (mailing list archive)
State New, archived
Headers show
Series block/partitions/efi.c: Fix the efi_partition() kernel-doc header | expand

Commit Message

Bart Van Assche May 12, 2021, 8:17 p.m. UTC
Fix the following kernel-doc warning:

block/partitions/efi.c:685: warning: wrong kernel-doc identifier on line:
 * efi_partition(struct parsed_partitions *state)

Cc: Alexander Viro <viro@math.psu.edu>
Fixes: a22f8253014b ("[PATCH] partition parsing cleanup")
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 block/partitions/efi.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jens Axboe May 12, 2021, 9:18 p.m. UTC | #1
On 5/12/21 2:17 PM, Bart Van Assche wrote:
> Fix the following kernel-doc warning:
> 
> block/partitions/efi.c:685: warning: wrong kernel-doc identifier on line:
>  * efi_partition(struct parsed_partitions *state)
> 
> Cc: Alexander Viro <viro@math.psu.edu>
> Fixes: a22f8253014b ("[PATCH] partition parsing cleanup")

Heh, I think using a sha from the history tree might cause more
harm than good. If you want it applied to any stable, probably
better to just use:

Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
Bart Van Assche May 12, 2021, 10:23 p.m. UTC | #2
On 5/12/21 2:18 PM, Jens Axboe wrote:
> On 5/12/21 2:17 PM, Bart Van Assche wrote:
>> Fix the following kernel-doc warning:
>>
>> block/partitions/efi.c:685: warning: wrong kernel-doc identifier on line:
>>   * efi_partition(struct parsed_partitions *state)
>>
>> Cc: Alexander Viro <viro@math.psu.edu>
>> Fixes: a22f8253014b ("[PATCH] partition parsing cleanup")
> 
> Heh, I think using a sha from the history tree might cause more
> harm than good. If you want it applied to any stable, probably
> better to just use:
> 
> Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")

You are right, but it is not my intention to send this patch to any 
stable tree. I'm fine with leaving out the Fixes: tag. If it would be 
inconvenient for you to do this then I will repost this patch.

Thanks,

Bart.
diff mbox series

Patch

diff --git a/block/partitions/efi.c b/block/partitions/efi.c
index b64bfdd4326c..e2716792ecc1 100644
--- a/block/partitions/efi.c
+++ b/block/partitions/efi.c
@@ -682,7 +682,7 @@  static void utf16_le_to_7bit(const __le16 *in, unsigned int size, u8 *out)
 }
 
 /**
- * efi_partition(struct parsed_partitions *state)
+ * efi_partition - scan for GPT partitions
  * @state: disk parsed partitions
  *
  * Description: called from check.c, if the disk contains GPT