| Message ID | 20230818201253.2729485-1-willy@infradead.org (mailing list archive) |
|---|---|
| State | Mainlined |
| Commit | af58740d8b06a6a97b7594235a1be11bd6aa37fa |
| Headers | show |
| Series | pstore: Fix kernel-doc warning | expand |
On Fri, 18 Aug 2023 21:12:53 +0100, Matthew Wilcox (Oracle) wrote: > Fix the warning for the description of struct persistent_ram_buffer and > improve the descriptions of the other struct members while I'm here. > > Applied to for-next/pstore, thanks! [1/1] pstore: Fix kernel-doc warning https://git.kernel.org/kees/c/af58740d8b06 Take care,
diff --git a/fs/pstore/ram_core.c b/fs/pstore/ram_core.c index eb6df190d752..4fbad03e7c33 100644 --- a/fs/pstore/ram_core.c +++ b/fs/pstore/ram_core.c @@ -24,12 +24,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;
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> --- fs/pstore/ram_core.c | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-)