summaryrefslogtreecommitdiff
path: root/fs/pstore
diff options
context:
space:
mode:
authorMatthew Wilcox (Oracle) <willy@infradead.org>2023-08-18 21:12:53 +0100
committerKees Cook <keescook@chromium.org>2023-08-18 13:27:28 -0700
commitaf58740d8b06a6a97b7594235a1be11bd6aa37fa (patch)
tree2d320258cdbd0afc7ff1ee745ad8aec6da466461 /fs/pstore
parent104fd0b5e948157f8e8ac88a20b46ba8641d4e95 (diff)
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>
Diffstat (limited to 'fs/pstore')
-rw-r--r--fs/pstore/ram_core.c10
1 files changed, 4 insertions, 6 deletions
diff --git a/fs/pstore/ram_core.c b/fs/pstore/ram_core.c
index 0eb780b90281..650e437b55e6 100644
--- a/fs/pstore/ram_core.c
+++ b/fs/pstore/ram_core.c
@@ -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;