public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] dma-debug: fix kernel-doc warnings
@ 2024-01-14  4:46 Randy Dunlap
  2024-01-15  7:21 ` Christoph Hellwig
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2024-01-14  4:46 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Christoph Hellwig, Marek Szyprowski, Robin Murphy,
	iommu

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 <rdunlap@infradead.org>
Cc: Christoph Hellwig <hch@lst.de>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
Cc: Robin Murphy <robin.murphy@arm.com>
Cc: iommu@lists.linux.dev 
---
 kernel/dma/debug.c |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff -- a/kernel/dma/debug.c b/kernel/dma/debug.c
--- 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;

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] dma-debug: fix kernel-doc warnings
  2024-01-14  4:46 [PATCH] dma-debug: fix kernel-doc warnings Randy Dunlap
@ 2024-01-15  7:21 ` Christoph Hellwig
  0 siblings, 0 replies; 2+ messages in thread
From: Christoph Hellwig @ 2024-01-15  7:21 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Christoph Hellwig, Marek Szyprowski, Robin Murphy,
	iommu

Thanks, applied.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-01-15  7:21 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-01-14  4:46 [PATCH] dma-debug: fix kernel-doc warnings Randy Dunlap
2024-01-15  7:21 ` Christoph Hellwig

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox