dma-debug: fix kernel-doc warnings

7c65aa3c · Randy Dunlap <[email protected]> · 2024-01-13 20:46:42 -08:00

Update the kernel-doc comments to catch up with the code changes and
fix the kernel-doc warnings:

debug.c:83: warning: Excess struct member 'stacktrace' description in 'dma_debug_entry'
debug.c:83: warning: Function parameter or struct member 'stack_len' not described in 'dma_debug_entry'
debug.c:83: warning: Function parameter or struct member 'stack_entries' not described in 'dma_debug_entry'

Fixes: 746017ed8d4d ("dma/debug: Simplify stracktrace retrieval")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Christoph Hellwig <[email protected]>
Cc: Marek Szyprowski <[email protected]>
Cc: Robin Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Christoph Hellwig <[email protected]>

Commit: 7c65aa3cc072cee76f577262fbe381a111a98774
Parents: 3dc2f209

Changes

1 files changed · +2 −1

File	Status	Add	Del	Content
kernel/dma/debug.c	modified	+2	−1	View file

kernel/dma/debug.c

View file

diff --git a/kernel/dma/debug.c b/kernel/dma/debug.c
index 3de4943..08b7f84 100644
--- a/kernel/dma/debug.c
+++ b/kernel/dma/debug.c
@@ -62,7 +62,8 @@ enum map_err_types {
  * @pfn: page frame of the start address
  * @offset: offset of mapping relative to pfn
  * @map_err_type: track whether dma_mapping_error() was checked
- * @stacktrace: support backtraces when a violation is detected
+ * @stack_len: number of backtrace entries in @stack_entries
+ * @stack_entries: stack of backtrace history
  */
 struct dma_debug_entry {
 	struct list_head list;