mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Usman Akinyemi <usmanakinyemi202@gmail.com>
To: Thinh.Nguyen@synopsys.com
Cc: gregkh@linuxfoundation.org, linux-usb@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH] usb: dwc3: Fix documentation warning for sg member
Date: Thu, 23 Jan 2025 13:31:02 +0530	[thread overview]
Message-ID: <20250123080102.1632517-1-usmanakinyemi202@gmail.com> (raw)

The 'sg' member in struct dwc3_request was undocumented, causing a
documentation warning when building the kernel docs.

This patch adds a description for the 'sg' field, resolving the warning.

Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com>
---
 drivers/usb/dwc3/core.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index ee73789326bc..0c417a12e6f4 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -941,6 +941,7 @@ struct dwc3_hwparams {
  * @request: struct usb_request to be transferred
  * @list: a list_head used for request queueing
  * @dep: struct dwc3_ep owning this request
+ * @sg: pointer to a scatterlist for DMA operations
  * @start_sg: pointer to the sg which should be queued next
  * @num_pending_sgs: counter to pending sgs
  * @remaining: amount of data remaining
-- 
2.48.0


             reply	other threads:[~2025-01-23  8:01 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-23  8:01 Usman Akinyemi [this message]
2025-01-23 14:07 ` Greg KH
2025-01-23 14:17   ` Usman Akinyemi
2025-01-23 14:22     ` Greg KH
2025-01-23 15:15       ` Usman Akinyemi
2025-01-23 15:13 ` [PATCH v2] " Usman Akinyemi
2025-01-23 15:38   ` Greg KH
2025-01-23 15:52     ` Usman Akinyemi
2025-01-23 15:57       ` Greg KH
2025-01-23 16:11         ` Usman Akinyemi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250123080102.1632517-1-usmanakinyemi202@gmail.com \
    --to=usmanakinyemi202@gmail.com \
    --cc=Thinh.Nguyen@synopsys.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®