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>
This commit is contained in:
Matthew Wilcox (Oracle) 2023-08-18 21:12:53 +01:00 committed by Kees Cook
parent 104fd0b5e9
commit af58740d8b

View File

@ -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;