Skip to content

Commit af58740

Browse files
Matthew Wilcox (Oracle)kees
authored andcommitted
pstore: Fix kernel-doc warning
Fix the warning for the description of struct persistent_ram_buffer and improve the descriptions of the other struct members while I'm here. Signed-off-by: "Matthew Wilcox (Oracle)" <willy@infradead.org> Link: https://lore.kernel.org/r/20230818201253.2729485-1-willy@infradead.org Signed-off-by: Kees Cook <keescook@chromium.org>
1 parent 104fd0b commit af58740

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

fs/pstore/ram_core.c

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,10 @@
2525
/**
2626
* struct persistent_ram_buffer - persistent circular RAM buffer
2727
*
28-
* @sig:
29-
* signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value)
30-
* @start:
31-
* offset into @data where the beginning of the stored bytes begin
32-
* @size:
33-
* number of valid bytes stored in @data
28+
* @sig: Signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value)
29+
* @start: First valid byte in the buffer.
30+
* @size: Number of valid bytes in the buffer.
31+
* @data: The contents of the buffer.
3432
*/
3533
struct persistent_ram_buffer {
3634
uint32_t sig;

0 commit comments

Comments
 (0)