Skip to contentSkip to conversation

printk: rectify kernel-doc for prb_rec_init_wr()

PATCH In review Lukas Bulwahn 3 participants 3 messages Jan 25, 2021 – Jan 26, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 printk: rectify kernel-doc for prb_rec_init_wr()

The command 'find ./kernel/printk/ | xargs ./scripts/kernel-doc -none' reported a mismatch with the kernel-doc of prb_rec_init_wr().

Rectify the kernel-doc, such that no issues remain for ./kernel/printk/.

---
applies cleanly on v5.11-rc5 and next-20210122

John, please ack.
Petr, please pick this minor typo fixup.

 kernel/printk/printk_ringbuffer.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/printk/printk_ringbuffer.h +1 -1
index 5dc9d022db07..73cc80e01cef 100644
@@ -287,7 +287,7 @@ _DEFINE_PRINTKRB(name, descbits, avgtextbits, &_##name##_text[0])
 /* Writer Interface */
 
 /**
- * prb_rec_init_wd() - Initialize a buffer for writing records.
+ * prb_rec_init_wr() - Initialize a buffer for writing records.
  *
  * @r:             The record to initialize.
  * @text_buf_size: The needed text buffer size.
Signature · 1 line
2.17.1
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Lukas Bulwahn

The command 'find ./kernel/printk/ | xargs ./scripts/kernel-doc -none' reported a mismatch with the kernel-doc of prb_rec_init_wr().

Rectify the kernel-doc, such that no issues remain for ./kernel/printk/.

Quoted 24 lines

---
applies cleanly on v5.11-rc5 and next-20210122

John, please ack.
Petr, please pick this minor typo fixup.

 kernel/printk/printk_ringbuffer.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/printk/printk_ringbuffer.h +1 -1
index 5dc9d022db07..73cc80e01cef 100644
@@ -287,7 +287,7 @@ _DEFINE_PRINTKRB(name, descbits, avgtextbits, &_##name##_text[0])
 /* Writer Interface */
 
 /**
- * prb_rec_init_wd() - Initialize a buffer for writing records.
+ * prb_rec_init_wr() - Initialize a buffer for writing records.
  *
  * @r:             The record to initialize.
  * @text_buf_size: The needed text buffer size.
Signature · 1 line
2.17.1
maintainer
#2 lore raw
In reply to Lukas Bulwahn
Quoted 6 lines · Lukas Bulwahn

The command 'find ./kernel/printk/ | xargs ./scripts/kernel-doc -none' reported a mismatch with the kernel-doc of prb_rec_init_wr().

Rectify the kernel-doc, such that no issues remain for ./kernel/printk/.

The patch has been committed into printk/linux.git, branch printk-rework.

Best Regards,
Petr