Skip to content

Commit

Permalink
pstore: Fix kernel-doc warning
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Matthew Wilcox (Oracle) authored and kees committed Aug 18, 2023
1 parent 104fd0b commit af58740
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions fs/pstore/ram_core.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@
/**
* struct persistent_ram_buffer - persistent circular RAM buffer
*
* @sig:
* signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value)
* @start:
* offset into @data where the beginning of the stored bytes begin
* @size:
* number of valid bytes stored in @data
* @sig: Signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value)
* @start: First valid byte in the buffer.
* @size: Number of valid bytes in the buffer.
* @data: The contents of the buffer.
*/
struct persistent_ram_buffer {
uint32_t sig;
Expand Down

0 comments on commit af58740

Please sign in to comment.