[PATCH v2] pstore: fixup struct member comments

[PATCH v2] pstore: fixup struct member comments

[Randy Dunlap]

Documenting the callback function parameters is great, but kernel-doc
doesn't support that. Drop the leading '@' sign from these comments to
avoid kernel-doc warnings:

Warning: ../include/linux/pstore.h:201 Excess struct member 'psi' description in 'pstore_info'
Warning: ../include/linux/pstore.h:201 Excess struct member 'record' description in 'pstore_info'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: rebase & resend

Cc: Kees Cook <kees@kernel.org>
Cc: Tony Luck <tony.luck@intel.com>
Cc: Guilherme G. Piccoli <gpiccoli@igalia.com>

 include/linux/pstore.h |   14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

--- linux-next-20261102.orig/include/linux/pstore.h
+++ linux-next-20261102/include/linux/pstore.h
@@ -114,7 +114,7 @@ struct pstore_record {
  *	Notify backend that pstore is starting a full read of backend
  *	records. Followed by one or more @read calls, and a final @close.
  *
- *	@psi:	in: pointer to the struct pstore_info for the backend
+ *	psi:	in: pointer to the struct pstore_info for the backend
  *
  *	Returns 0 on success, and non-zero on error.
  *
@@ -123,7 +123,7 @@ struct pstore_record {
  *	records. Always preceded by an @open call and one or more @read
  *	calls.
  *
- *	@psi:	in: pointer to the struct pstore_info for the backend
+ *	psi:	in: pointer to the struct pstore_info for the backend
  *
  *	Returns 0 on success, and non-zero on error. (Though pstore will
  *	ignore the error.)
@@ -132,7 +132,7 @@ struct pstore_record {
  *	Read next available backend record. Called after a successful
  *	@open.
  *
- *	@record:
+ *	record:
  *		pointer to record to populate. @buf should be allocated
  *		by the backend and filled. At least @type and @id should
  *		be populated, since these are used when creating pstorefs
@@ -144,7 +144,7 @@ struct pstore_record {
  * @write:
  *	A newly generated record needs to be written to backend storage.
  *
- *	@record:
+ *	record:
  *		pointer to record metadata. When @type is PSTORE_TYPE_DMESG,
  *		@buf will be pointing to the preallocated @psi.buf, since
  *		memory allocation may be broken during an Oops. Regardless,
@@ -162,8 +162,8 @@ struct pstore_record {
  *	buffer that is coming directly from userspace, instead of the
  *	@record @buf.
  *
- *	@record:	pointer to record metadata.
- *	@buf:		pointer to userspace contents to write to backend
+ *	record:	pointer to record metadata.
+ *	buf:		pointer to userspace contents to write to backend
  *
  *	Returns 0 on success, and non-zero on error.
  *
@@ -173,7 +173,7 @@ struct pstore_record {
  *	passed back to assist in identification of what the backend
  *	should remove from storage.
  *
- *	@record:	pointer to record metadata.
+ *	record:	pointer to record metadata.
  *
  *	Returns 0 on success, and non-zero on error.
  *