Commit af58740d authored by Matthew Wilcox (Oracle)'s avatar Matthew Wilcox (Oracle) Committed by Kees Cook

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: default avatar"Matthew Wilcox (Oracle)" <willy@infradead.org>
Link: https://lore.kernel.org/r/20230818201253.2729485-1-willy@infradead.orgSigned-off-by: default avatarKees Cook <keescook@chromium.org>
parent 104fd0b5
...@@ -25,12 +25,10 @@ ...@@ -25,12 +25,10 @@
/** /**
* struct persistent_ram_buffer - persistent circular RAM buffer * struct persistent_ram_buffer - persistent circular RAM buffer
* *
* @sig: * @sig: Signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value)
* signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value) * @start: First valid byte in the buffer.
* @start: * @size: Number of valid bytes in the buffer.
* offset into @data where the beginning of the stored bytes begin * @data: The contents of the buffer.
* @size:
* number of valid bytes stored in @data
*/ */
struct persistent_ram_buffer { struct persistent_ram_buffer {
uint32_t sig; uint32_t sig;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment